MIDIRootComplex Class Reference

#include <midi_root_complex.h>

Inheritance diagram for MIDIRootComplex:

Classes
class	CableIterator
class	CableSet

Public Member Functions
	MIDIRootComplex (const MIDIRootComplex &)=delete
	MIDIRootComplex (MIDIRootComplex &&)=delete
MIDIRootComplex &	operator= (const MIDIRootComplex &)=delete
MIDIRootComplex &	operator= (MIDIRootComplex &&)=delete
virtual RootComplexType	getType () const =0
virtual size_t	getNumCables () const =0
virtual MIDICable *	getCable (size_t cableIdx)=0
CableSet	getCables ()
virtual void	flush ()=0
	Flush as much data as possible from any internal buffers to hardware queues.
virtual Error	poll ()=0
	Poll the root complex, calling back in to the MIDI engine for any new messages.

Detailed Description

Represents a group of cables we can do I/O on.

The name is meant to be analogous to a "root complex" in a PCIe device hierarchy, which represents the physical bridge to the PCIe bus by the bus controller. Similarly, this class represents the interface from the Deluge software to a MIDI device connection.

Member Function Documentation

flush()

virtual void MIDIRootComplex::flush ( )

pure virtual

Flush as much data as possible from any internal buffers to hardware queues.

Implemented in DINRootComplex, MIDIRootComplexUSBHosted, and MIDIRootComplexUSBPeripheral.

poll()

virtual Error MIDIRootComplex::poll ( )

nodiscardpure virtual

Poll the root complex, calling back in to the MIDI engine for any new messages.

Implemented in DINRootComplex, MIDIRootComplexUSBHosted, and MIDIRootComplexUSBPeripheral.

---

The documentation for this class was generated from the following file:

• src/deluge/io/midi/midi_root_complex.h