![]() |
Open Lighting Architecture 0.10.9
|
A base class that send DMX data asynchronously to a libusb_device.
This encapsulates much of the asynchronous libusb logic. Subclasses should implement the SetupHandle() and PerformTransfer() methods.
Public Member Functions | |
| AsyncUsbSender (ola::usb::LibUsbAdaptor *const adaptor, libusb_device *usb_device) | |
| Create a new AsyncUsbSender. | |
| virtual | ~AsyncUsbSender () |
| Destructor. | |
| bool | SendDMX (const DmxBuffer &buffer) |
| Send one frame of DMX data. | |
| void | TransferComplete (struct libusb_transfer *transfer) |
| Called from the libusb callback when the asynchronous transfer completes. | |
Public Member Functions inherited from ola::plugin::usbdmx::AsyncUsbTransceiverBase | |
| AsyncUsbTransceiverBase (ola::usb::LibUsbAdaptor *const adaptor, libusb_device *usb_device) | |
| Create a new AsyncUsbTransceiverBase. | |
| virtual | ~AsyncUsbTransceiverBase () |
| Destructor. | |
| bool | Init () |
| Initialize the transceiver. | |
| libusb_device_handle * | GetHandle () |
| Get the libusb_device_handle of an already opened widget. | |
Protected Member Functions | |
| virtual bool | PerformTransfer (const DmxBuffer &buffer)=0 |
| Perform the DMX transfer. | |
| virtual void | PostTransferHook () |
| Called when the transfer completes. | |
| bool | TransferPending () const |
| Check if there is a pending transfer. | |
Protected Member Functions inherited from ola::plugin::usbdmx::AsyncUsbTransceiverBase | |
| virtual libusb_device_handle * | SetupHandle ()=0 |
| Open the device handle. | |
| void | CancelTransfer () |
| Cancel any pending transfers. | |
| void | FillControlTransfer (unsigned char *buffer, unsigned int timeout) |
| Fill a control transfer. | |
| void | FillBulkTransfer (unsigned char endpoint, unsigned char *buffer, int length, unsigned int timeout) |
| Fill a bulk transfer. | |
| void | FillInterruptTransfer (unsigned char endpoint, unsigned char *buffer, int length, unsigned int timeout) |
| Fill an interrupt transfer. | |
| int | SubmitTransfer () |
| Submit the transfer for tx. | |
Additional Inherited Members | |
Protected Types inherited from ola::plugin::usbdmx::AsyncUsbTransceiverBase | |
| enum | TransferState { IDLE , IN_PROGRESS , DISCONNECTED } |
Protected Attributes inherited from ola::plugin::usbdmx::AsyncUsbTransceiverBase | |
| ola::usb::LibUsbAdaptor *const | m_adaptor |
| The LibUsbAdaptor passed in the constructor. | |
| libusb_device *const | m_usb_device |
| The libusb_device passed in the constructor. | |
| libusb_device_handle * | m_usb_handle |
| bool | m_suppress_continuation |
| struct libusb_transfer * | m_transfer |
| TransferState | m_transfer_state |
| ola::thread::Mutex | m_mutex |
| ola::plugin::usbdmx::AsyncUsbSender::AsyncUsbSender | ( | ola::usb::LibUsbAdaptor *const | adaptor, |
| libusb_device * | usb_device ) |
Create a new AsyncUsbSender.
| adaptor | the LibUsbAdaptor to use. |
| usb_device | the libusb_device to use for the widget. |
|
protectedpure virtual |
Perform the DMX transfer.
| buffer | the DMX buffer to send. |
This method is implemented by the subclass. The subclass should call FillControlTransfer() / FillBulkTransfer() as appropriate and then call SubmitTransfer().
Implemented in ola::plugin::usbdmx::AnymaAsyncUsbSender, ola::plugin::usbdmx::DMXCProjectsNodleU1AsyncUsbSender, ola::plugin::usbdmx::EuroliteProAsyncUsbSender, ola::plugin::usbdmx::FadecandyAsyncUsbSender, ola::plugin::usbdmx::SunliteAsyncUsbSender, and ola::plugin::usbdmx::VellemanAsyncUsbSender.
|
inlineprotectedvirtual |
Called when the transfer completes.
Some devices require multiple transfers per DMX frame. This provides a hook for continuation.
Reimplemented from ola::plugin::usbdmx::AsyncUsbTransceiverBase.
Reimplemented in ola::plugin::usbdmx::DMXCProjectsNodleU1AsyncUsbSender, and ola::plugin::usbdmx::VellemanAsyncUsbSender.
| bool ola::plugin::usbdmx::AsyncUsbSender::SendDMX | ( | const DmxBuffer & | buffer | ) |
Send one frame of DMX data.
| buffer | the DMX data to send. |
|
virtual |
Called from the libusb callback when the asynchronous transfer completes.
| transfer | the completed transfer. |
Implements ola::plugin::usbdmx::AsyncUsbTransceiverBase.
|
inlineprotected |
Check if there is a pending transfer.