System.USB.IO.Transfers

WARNING: This module is experimental and untested. The API will likely change in future releases.

WARNING: This module is only available on systems which support the GHC EventManager.

WARNING: You need to enable the threaded runtime (-threaded) when using this module. The functions throw a runtime error otherwise!

This modules provides alternative I/O operations than the ones in System.USB.IO. The difference is that this module separates the construction from the execution of a USB transfer. This has the advantage that a transfer can be constructed once and executed multiple times thereby saving repeated allocation costs.

Control transfers

No data transfer

data ControlTransfer

A control transfer which doesn't transfer data.

newControlTransfer :: DeviceHandle -> ControlSetup -> Timeout -> IO ControlTransfer

Create a new control transfer which doesn't transfer data.

performControlTransfer :: ControlTransfer -> IO ()

Execute a control transfer which doesn't transfer data.

Setting

setControlTransferDeviceHandle :: ControlTransfer -> DeviceHandle -> IO ()

Update the device handle of a control transfer.

setControlTransferTimeout :: ControlTransfer -> Timeout -> IO ()

Update the timeout of a control transfer.

setControlSetup :: ControlTransfer -> ControlSetup -> IO ()

Update the setup parameters of a control transfer.

Getting

getControlTransferDeviceHandle :: ControlTransfer -> IO DeviceHandle

Retrieve the device handle of a control transfer.

getControlTransferTimeout :: ControlTransfer -> IO Timeout

Retrieve the timeout of a control transfer.

Reading

data ControlReadTransfer

A control transfer which reads data from a device.

newControlReadTransfer :: DeviceHandle -> ControlSetup -> Size -> Timeout -> IO ControlReadTransfer

Create a new control transfer which can read data from a device.

performControlReadTransfer :: ControlReadTransfer -> IO (ByteString, Status)

Execute a control transfer to read data from the device.

Setting

setControlReadTransferDeviceHandle :: ControlReadTransfer -> DeviceHandle -> IO ()

Update the device handle of a control transfer that reads data from a device.

setControlReadTransferTimeout :: ControlReadTransfer -> Timeout -> IO ()

Update the timeout of a control transfer that reads data from a device.

setControlReadSetup :: ControlReadTransfer -> ControlSetup -> Size -> IO ()

Update the setup parameters of a control transfer that reads data from a device..

Getting

getControlReadTransferDeviceHandle :: ControlReadTransfer -> IO DeviceHandle

Retrieve the device handle of a control transfer that reads data from a device.

getControlReadTransferTimeout :: ControlReadTransfer -> IO Timeout

Retrieve the timeout of a control transfer that reads data from a device.

Writing

data ControlWriteTransfer

A control transfer which writes data to a device.

newControlWriteTransfer :: DeviceHandle -> ControlSetup -> ByteString -> Timeout -> IO ControlWriteTransfer

Create a new control transfer which can write data to a device.

performControlWriteTransfer :: ControlWriteTransfer -> IO (Size, Status)

Execute a control transfer to write the data to the device.

Setting

setControlWriteTransferDeviceHandle :: ControlWriteTransfer -> DeviceHandle -> IO ()

Update the device handle of a control transfer that writes data to a device.

setControlWriteTransferTimeout :: ControlWriteTransfer -> Timeout -> IO ()

Update the timeout of a control transfer that writes data to a device.

setControlWriteSetup :: ControlWriteTransfer -> ControlSetup -> ByteString -> IO ()

Update the setup parameters of a control transfer that writes data to a device.

Getting

getControlWriteTransferDeviceHandle :: ControlWriteTransfer -> IO DeviceHandle

Retrieve the device handle of a control transfer that writes data to a device.

getControlWriteTransferTimeout :: ControlWriteTransfer -> IO Timeout

Retrieve the timeout of a control transfer that writes data to a device.

Bulk / Interrupt transfers

data RepeatableTransferType

Type of ReadTransfer or WriteTransfer which can either be bulk or interrupt.

Note that isochronous transfers are handled differently using the IsochronousReadTransfer or IsochronousWriteTransfer types.

Constructors

BulkTransfer

InterruptTransfer

Reading

data ReadTransfer

A bulk or interrupt read transfer.

newReadTransfer

Arguments

:: RepeatableTransferType

-> DeviceHandle

-> EndpointAddress

-> Size

Number of bytes to read.

-> Timeout

-> IO ReadTransfer

Create a new bulk or interrupt transfer that can read data from a device.

performReadTransfer :: ReadTransfer -> IO (ByteString, Status)

Execute a bulk or interrupt transfer to read data from a device.

Setting

setReadTransferType :: ReadTransfer -> RepeatableTransferType -> IO ()

Specify whether the transfer should perform bulk or interrupt reads.

setReadTransferDeviceHandle :: ReadTransfer -> DeviceHandle -> IO ()

Update the device handle of a bulk or interrupt read transfer.

setReadTransferEndpointAddress :: ReadTransfer -> EndpointAddress -> IO ()

Update the endpoint address of a bulk or interrupt read transfer.

setReadTransferTimeout :: ReadTransfer -> Timeout -> IO ()

Update the timeout of a bulk or interrupt read transfer.

setReadTransferSize :: ReadTransfer -> Size -> IO ()

Update the number of bytes to read for a bulk or interrupt transfer.

Getting

getReadTransferType :: ReadTransfer -> IO RepeatableTransferType

Check if this transfer does bulk or interrupt reads.

getReadTransferDeviceHandle :: ReadTransfer -> IO DeviceHandle

Retrieve the device handle of a bulk or interrupt read transfer.

getReadTransferEndpointAddress :: ReadTransfer -> IO EndpointAddress

Retrieve the endpoint address of a bulk or interrupt read transfer.

getReadTransferTimeout :: ReadTransfer -> IO Timeout

Retrieve the timeout of a bulk or interrupt read transfer.

getReadTransferSize :: ReadTransfer -> IO Size

Retreive the number of bytes to read for a bulk or interrupt transfer.

Writing

data WriteTransfer

A bulk or interrupt write transfer.

newWriteTransfer

Arguments

:: RepeatableTransferType

-> DeviceHandle

-> EndpointAddress

-> ByteString

Bytes to write.

-> Timeout

-> IO WriteTransfer

Create a new bulk or interrupt transfer that can write data to a device.

performWriteTransfer :: WriteTransfer -> IO (Size, Status)

Execute a bulk or interrupt transfer to write data to a device.

Setting

setWriteTransferType :: WriteTransfer -> RepeatableTransferType -> IO ()

Specify whether the transfer should perform bulk or interrupt writes.

setWriteTransferDeviceHandle :: WriteTransfer -> DeviceHandle -> IO ()

Update the device handle of a bulk or interrupt write transfer.

setWriteTransferEndpointAddress :: WriteTransfer -> EndpointAddress -> IO ()

Update the endpoint address of a bulk or interrupt write transfer.

setWriteTransferTimeout :: WriteTransfer -> Timeout -> IO ()

Update the timeout of a bulk or interrupt write transfer.

setWriteTransferInput :: WriteTransfer -> ByteString -> IO ()

Update the bytes to write for a bulk or interrupt transfer.

Getting

getWriteTransferType :: WriteTransfer -> IO RepeatableTransferType

Check if this transfer does bulk or interrupt writes.

getWriteTransferDeviceHandle :: WriteTransfer -> IO DeviceHandle

Retrieve the device handle of a bulk or interrupt write transfer.

getWriteTransferEndpointAddress :: WriteTransfer -> IO EndpointAddress

Retrieve the endpoint address of a bulk or interrupt write transfer.

getWriteTransferTimeout :: WriteTransfer -> IO Timeout

Retrieve the timeout of a bulk or interrupt write transfer.

getWriteTransferInput :: WriteTransfer -> IO ByteString

Retreive the bytes to write from a bulk or interrupt transfer.

Isochronous transfers

Reading

data IsochronousReadTransfer

An isochronous read transfer.

newIsochronousReadTransfer

Arguments

:: DeviceHandle

-> EndpointAddress

-> Vector Size

Sizes of isochronous packets to read.

-> Timeout

-> IO IsochronousReadTransfer

Create a new isochronous transfer that can read isochronous packets from a device.

performIsochronousReadTransfer :: IsochronousReadTransfer -> IO (Vector ByteString)

Execute a transfer to read isochronous packets from a device.

Setting

setIsochronousReadTransferDeviceHandle :: IsochronousReadTransfer -> DeviceHandle -> IO ()

Update the device handle of an isochronous read transfer.

setIsochronousReadTransferEndpointAddress :: IsochronousReadTransfer -> EndpointAddress -> IO ()

Update the endpoint address of an isochronous read transfer.

setIsochronousReadTransferSizes :: IsochronousReadTransfer -> Vector Size -> IO ()

Update the size of packets to read for an isochronous transfer.

Getting

getIsochronousReadTransferDeviceHandle :: IsochronousReadTransfer -> IO DeviceHandle

Retrieve the device handle of an isochronous read transfer.

getIsochronousReadTransferEndpointAddress :: IsochronousReadTransfer -> IO EndpointAddress

Retrieve the endpoint address of an isochronous read transfer.

getIsochronousReadTransferSizes :: IsochronousReadTransfer -> IO (Vector Size)

Retrieve the packets sizes to read for an isochronous transfer.

Writing

data IsochronousWriteTransfer

An isochronous write transfer.

newIsochronousWriteTransfer

Arguments

:: DeviceHandle

-> EndpointAddress

-> Vector ByteString

Isochronous packets to write.

-> Timeout

-> IO IsochronousWriteTransfer

Create a new isochronous transfer that can write isochronous packets to a device.

performIsochronousWriteTransfer :: IsochronousWriteTransfer -> IO (Vector Size)

Execute a transfer to write isochronous packets to a device.

Setting

setIsochronousWriteTransferDeviceHandle :: IsochronousWriteTransfer -> DeviceHandle -> IO ()

Update the device handle of an isochronous write transfer.

setIsochronousWriteTransferEndpointAddress :: IsochronousWriteTransfer -> EndpointAddress -> IO ()

Update the endpoint address of an isochronous write transfer.

setIsochronousWriteTransferPackets :: IsochronousWriteTransfer -> Vector ByteString -> IO ()

Update the packets to write for an isochronous transfer.

Getting

getIsochronousWriteTransferDeviceHandle :: IsochronousWriteTransfer -> IO DeviceHandle

Retrieve the device handle of an isochronous write transfer.

getIsochronousWriteTransferEndpointAddress :: IsochronousWriteTransfer -> IO EndpointAddress

Retrieve the endpoint address of an isochronous write transfer.

getIsochronousWriteTransferPackets :: IsochronousWriteTransfer -> IO (Vector ByteString)

Retrieve the packets to write for an isochronous transfer.