Open Lighting Architecture  0.9.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
ola::plugin::usbdmx::VellemanAsyncUsbSender Class Reference
Inheritance diagram for ola::plugin::usbdmx::VellemanAsyncUsbSender:
Inheritance graph
[legend]
Collaboration diagram for ola::plugin::usbdmx::VellemanAsyncUsbSender:
Collaboration graph
[legend]

Public Member Functions

 VellemanAsyncUsbSender (LibUsbAdaptor *adaptor, libusb_device *usb_device)
libusb_device_handle * SetupHandle ()
 Open the device handle.
bool PerformTransfer (const DmxBuffer &buffer)
 Perform the DMX transfer.
void PostTransferHook ()
 Called when the transfer completes.
- Public Member Functions inherited from ola::plugin::usbdmx::AsyncUsbSender
 AsyncUsbSender (class LibUsbAdaptor *const adaptor, libusb_device *usb_device)
 Create a new AsyncUsbSender.
virtual ~AsyncUsbSender ()
 Destructor.
bool Init ()
 Initialize the sender.
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.

Additional Inherited Members

- Protected Member Functions inherited from ola::plugin::usbdmx::AsyncUsbSender
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.
bool TransferPending () const
 Check if there is a pending transfer.
- Protected Attributes inherited from ola::plugin::usbdmx::AsyncUsbSender
class LibUsbAdaptor *const m_adaptor
 The LibUsbAdaptor passed in the constructor.
libusb_device *const m_usb_device
 The libusb_device passed in the constructor.

Member Function Documentation

bool ola::plugin::usbdmx::VellemanAsyncUsbSender::PerformTransfer ( const DmxBuffer buffer)
virtual

Perform the DMX transfer.

Parameters
bufferthe DMX buffer to send.
Returns
true if the transfer was scheduled, false otherwise.

This method is implemented by the subclass. The subclass should call FillControlTransfer() / FillBulkTransfer() as appropriate and then call SubmitTransfer().

Implements ola::plugin::usbdmx::AsyncUsbSender.

void ola::plugin::usbdmx::VellemanAsyncUsbSender::PostTransferHook ( )
virtual

Called when the transfer completes.

Some devices require multiple transfers per DMX frame. This provides a hook for continuation.

Reimplemented from ola::plugin::usbdmx::AsyncUsbSender.

libusb_device_handle* ola::plugin::usbdmx::VellemanAsyncUsbSender::SetupHandle ( )
inlinevirtual

Open the device handle.

Returns
A valid libusb_device_handle or NULL if the device could not be opened.

Implements ola::plugin::usbdmx::AsyncUsbSender.


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