dxd - dynax driver framework  2775
cross platform open source driver development framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
dx::usb::pipe< exception_t, device_t > Class Template Reference

#include <dx_usb_device.h>

+ Inheritance diagram for dx::usb::pipe< exception_t, device_t >:
+ Collaboration diagram for dx::usb::pipe< exception_t, device_t >:

Public Types

enum  type : unsigned char { control =::kUSBControl, isoc =::kUSBIsoc, bulk =::kUSBBulk, irq =::kUSBInterrupt }
 

Public Member Functions

pipeabort () throw (exception_t)
 
pipeclear () throw (exception_t)
 
uint64_t frame () throw (exception_t)
 
pipemax_frame_size (unsigned int frame_size) throw (exception_t)
 
template<typename data_t >
pipeoperator<< (const data_t &data) throw (exception_t)
 
template<typename data_t >
pipeoperator>> (data_t &data) throw (exception_t)
 
 pipe (device_t &device, const dx::usb::endpoint &endpoint) throw (exception_t)
 
piperead (void *data, size_t size) throw (exception_t)
 synchronous USB read request More...
 
pipereceive (void *data, size_t size) throw (exception_t)
 asynchronous USB read request More...
 
pipereceive (void *data, uint64_t &sequence,::IOUSBIsocFrame *frame, int frames=1) throw (exception_t)
 asynchronous USB isoc read request More...
 
os_result status () noexcept
 
pipetransmit (const void *data, size_t size) throw (exception_t)
 asynchronous USB write request More...
 
pipetransmit (const void *data, uint64_t &sequence,::IOUSBIsocFrame *frame, int frames=1) throw (exception_t)
 asynchronous USB isoc write request More...
 
pipewrite (const void *data, size_t size) throw (exception_t)
 synchronous USB write request More...
 

Public Attributes

enum dx::usb::pipe::type type
 

Member Enumeration Documentation

template<typename exception_t = os_result, typename device_t = device<exception_t>>
enum dx::usb::pipe::type : unsigned char
Enumerator
control 
isoc 
bulk 
irq 

Constructor & Destructor Documentation

template<typename exception_t = os_result, typename device_t = device<exception_t>>
dx::usb::pipe< exception_t, device_t >::pipe ( device_t &  device,
const dx::usb::endpoint endpoint 
)
throw (exception_t
)
inline

Member Function Documentation

template<typename exception_t = os_result, typename device_t = device<exception_t>>
pipe& dx::usb::pipe< exception_t, device_t >::abort ( )
throw (exception_t
)
inline
template<typename exception_t = os_result, typename device_t = device<exception_t>>
pipe& dx::usb::pipe< exception_t, device_t >::clear ( )
throw (exception_t
)
inline
template<typename exception_t = os_result, typename device_t = device<exception_t>>
uint64_t dx::usb::pipe< exception_t, device_t >::frame ( )
throw (exception_t
)
inline

+ Here is the call graph for this function:

template<typename exception_t = os_result, typename device_t = device<exception_t>>
pipe& dx::usb::pipe< exception_t, device_t >::max_frame_size ( unsigned int  frame_size)
throw (exception_t
)
inline
template<typename exception_t = os_result, typename device_t = device<exception_t>>
template<typename data_t >
pipe& dx::usb::pipe< exception_t, device_t >::operator<< ( const data_t &  data)
throw (exception_t
)
inline
template<typename exception_t = os_result, typename device_t = device<exception_t>>
template<typename data_t >
pipe& dx::usb::pipe< exception_t, device_t >::operator>> ( data_t &  data)
throw (exception_t
)
inline
template<typename exception_t = os_result, typename device_t = device<exception_t>>
pipe& dx::usb::pipe< exception_t, device_t >::read ( void *  data,
size_t  size 
)
throw (exception_t
)
inline

synchronous USB read request

template<typename exception_t = os_result, typename device_t = device<exception_t>>
pipe& dx::usb::pipe< exception_t, device_t >::receive ( void *  data,
size_t  size 
)
throw (exception_t
)
inline

asynchronous USB read request

template<typename exception_t = os_result, typename device_t = device<exception_t>>
pipe& dx::usb::pipe< exception_t, device_t >::receive ( void *  data,
uint64_t sequence,
::IOUSBIsocFrame *  frame,
int  frames = 1 
)
throw (exception_t
)
inline

asynchronous USB isoc read request

template<typename exception_t = os_result, typename device_t = device<exception_t>>
os_result dx::usb::pipe< exception_t, device_t >::status ( )
inlinenoexcept
template<typename exception_t = os_result, typename device_t = device<exception_t>>
pipe& dx::usb::pipe< exception_t, device_t >::transmit ( const void *  data,
size_t  size 
)
throw (exception_t
)
inline

asynchronous USB write request

template<typename exception_t = os_result, typename device_t = device<exception_t>>
pipe& dx::usb::pipe< exception_t, device_t >::transmit ( const void *  data,
uint64_t sequence,
::IOUSBIsocFrame *  frame,
int  frames = 1 
)
throw (exception_t
)
inline

asynchronous USB isoc write request

template<typename exception_t = os_result, typename device_t = device<exception_t>>
pipe& dx::usb::pipe< exception_t, device_t >::write ( const void *  data,
size_t  size 
)
throw (exception_t
)
inline

synchronous USB write request

Member Data Documentation

template<typename exception_t = os_result, typename device_t = device<exception_t>>
enum dx::usb::pipe::type dx::usb::pipe< exception_t, device_t >::type

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

(c) copyright 2009 dynamic acoustics e.U. generated on Sat Aug 17 2019

a closed source license may be obtained by requesting a written permission from dynamic acoustics e.U.
however - governmental use generally and military use especially is strictly prohibited though.