dx::usb::pipe< device_t > Class Template Reference

#include <dx_usb_device.h>

Inheritance diagram for dx::usb::pipe< device_t >:

Collaboration diagram for dx::usb::pipe< device_t >:

Public Types
typedef device_t	device_t
typedef device_t	device_t
enum class	type : uint8_t {   control =::kUSBControl , isoc = ::kUSBIsoc , bulk = ::kUSBBulk , irq = ::kUSBInterrupt ,   control =::UsbdPipeTypeControl , isoc = ::UsbdPipeTypeIsochronous , bulk = ::UsbdPipeTypeBulk , irq = ::UsbdPipeTypeInterrupt }
enum class	type : unsigned char {   control =::kUSBControl , isoc = ::kUSBIsoc , bulk = ::kUSBBulk , irq = ::kUSBInterrupt ,   control =::UsbdPipeTypeControl , isoc = ::UsbdPipeTypeIsochronous , bulk = ::UsbdPipeTypeBulk , irq = ::UsbdPipeTypeInterrupt }

Public Member Functions
pipe &	abort () try
virtual void	callback ()
	catch (...)
	catch (...)
	catch (...)
	catch (...)
	catch (const dx::exception &__dx_exception)
	catch (const dx::exception &__dx_exception)
	catch (const dx::exception &__dx_exception)
	catch (const dx::exception &__dx_exception)
	catch (const std::exception &__std_exception)
	catch (const std::exception &__std_exception)
	catch (const std::exception &__std_exception)
	catch (const std::exception &__std_exception)
void	conclude () noexcept override
	conclude notification: object will be removed. If you overwrite conclude() you also need to overwrite destructor and check if its needed to be called from there.
	dx_catchall_handler (this,) void conclude() noexcept override
	dx_catchall_handler (this,) void conclude() noexcept override
	dx_catchall_rethrow () os_result status() const noexcept
	dx_catchall_rethrow (;,"endpoint:%x interface:%d setting:%d", endpoint.address, endpoint.interface, endpoint.setting) bool in() const noexcept
	dx_catchall_rethrow (try {const_cast< pipe * >(this) ->clear();} dx_catchall_handler(this,), "idx:%d size:%lld", idx, sizeof request) template< typename data_t > data_t submit(const control &control) const
	control request to pipe
virtual void	exception (const exception &exception, bool filtered=false) const noexcept=0
	notification exception handler
bool	in () const noexcept
	bus initializer (isoc, bulk, pci, etc.) compatibility
void	info (std::ostream &os) noexcept override
	log object class information
virtual void	launch ()
	launch notification: object mounted and ready to use
pipe &	max_frame_size (uint32_t frame_size)
	operator os_event () noexcept
template<typename data_t >
pipe &	operator<< (const data_t &data)
	synchronous USB write request
template<typename data_t >
pipe &	operator>> (data_t &data)
	synchronous USB read request
	pipe (device_t &device, const usb::endpoint &endpoint)
event &	reset (uint64_t count=0) try
event &	reset (uint64_t count=0) try
event &	signal (uint64_t count=1) try
event &	signal (uint64_t count=1) try
uint64_t	signalled () const
uint64_t	signalled () const
bool	start (uint64_t frame, unsigned int started=1) override try
	async IO thread control
virtual unsigned int	stop (bool force=false) noexcept
virtual unsigned int	stop (bool force=false) noexcept
template<typename data_t >
pipe &	submit (const request< data_t > &request) const try
	standard request to pipe
event &	wait (bool reset=false) try
event &	wait (bool reset=false) try
template<typename rep_t , typename period_t >
bool	wait (const std::chrono::duration< rep_t, period_t > &timeout, bool reset=false) try
template<typename rep_t , typename period_t >
bool	wait (const std::chrono::duration< rep_t, period_t > &timeout, bool reset=false) try
	~pipe () noexcept override

Public Attributes
const usb::endpoint::attributes &	attributes = reinterpret_cast<const struct usb::endpoint::attributes&>(bmAttributes)
std::deque< union audio::descriptor::endpoint >	audio
interface_t &	interface
bool	launched {}
bool	launched {}
std::deque< std::function< void(control &)>	notify )
std::deque< std::function< void(control &)>	notify )
std::atomic< unsigned int >	started
std::atomic< unsigned int >	started
enum dx::usb::platform::pipe::type	type

Static Public Attributes
static constexpr auto	scope = kernel

Protected Types
typedef dx::event< dx::kernel >	event

Protected Member Functions
virtual void	flush ()
virtual void	flush ()
void	halt () noexcept override
	async IO thread control (required for Windows compatibility)
virtual void	received (os_result, size_t)
	virtual async callbacks
virtual void	received (os_result, size_t)
	virtual async callbacks
virtual void	received (os_result, size_t, int64_t, usb::isoc::frame *)
virtual void	received (os_result, size_t, int64_t, usb::isoc::frame *)
virtual void	transmitted (os_result, size_t)
virtual void	transmitted (os_result, size_t)
virtual void	transmitted (os_result, size_t, int64_t, usb::isoc::frame *)
virtual void	transmitted (os_result, size_t, int64_t, usb::isoc::frame *)

Protected Attributes
struct {
}	address
uint8_t	address = 0
device_t &	device
device_t &	device
uint8_t	idx = 0
struct {
class buffer {
}   buffer
unsigned int   micro_frames = 0
}	isoc
struct dx::usb::platform::pipe::isoc	isoc
std::recursive_mutex	start_stop_in_progress
	start/stop operation in progress
std::recursive_mutex	start_stop_in_progress
	start/stop operation in progress
struct {
::WINUSB_INTERFACE_HANDLE   handle
}	winusb

Member Typedef Documentation

device_t [1/2]

typedef device_t dx::stream::object< device_t >::device_t

inherited

device_t [2/2]

typedef device_t dx::stream::object< device_t >::device_t

inherited

event

template<typename device_t , typename interface_t >

typedef dx::event<dx::kernel> dx::usb::platform::pipe< device_t, interface_t >::event

protectedinherited

Member Enumeration Documentation

type [1/2]

template<typename device_t , typename interface_t >

enum class enum dx::usb::platform::pipe::type dx::usb::platform::pipe< device_t, interface_t >::type

stronginherited

Enumerator
control
isoc
bulk
irq
control
isoc
bulk
irq

type [2/2]

template<typename device_t , typename interface_t >

enum class dx::usb::platform::pipe::type : unsigned char

stronginherited

Enumerator
control
isoc
bulk
irq
control
isoc
bulk
irq

Constructor & Destructor Documentation

pipe()

template<typename device_t = device>

dx::usb::pipe< device_t >::pipe ( device_t & device, const usb::endpoint & endpoint )

inline

~pipe()

template<typename device_t = device>

dx::usb::pipe< device_t >::~pipe ( )

inlineoverridenoexcept

Member Function Documentation

abort()

template<typename device_t , typename interface_t >

pipe & dx::usb::platform::pipe< device_t, interface_t >::abort ( )

inlineinherited

callback()

virtual void dx::event< kernel >::callback ( )

inlinevirtualinherited

The default implementation is based on event<user> which is signalled when triggered via callback() from kernel. This is to achieve compatibility with Windows events. Its probably more adequate to overwrite callback() and do the work here if feasible.

catch() [1/12]

dx::event< user >::catch ( ... )

inlineinherited

catch() [2/12]

dx::event< user >::catch ( ... )

inlineinherited

catch() [3/12]

dx::event< user >::catch ( ... )

inlineinherited

catch() [4/12]

dx::event< user >::catch ( ... )

inlineinherited

catch() [5/12]

dx::event< user >::catch ( const dx::exception & __dx_exception )

inlineinherited

catch() [6/12]

dx::event< user >::catch ( const dx::exception & __dx_exception )

inlineinherited

catch() [7/12]

dx::event< user >::catch ( const dx::exception & __dx_exception )

inlineinherited

catch() [8/12]

dx::event< user >::catch ( const dx::exception & __dx_exception )

inlineinherited

catch() [9/12]

dx::event< user >::catch ( const std::exception & __std_exception )

inlineinherited

catch() [10/12]

dx::event< user >::catch ( const std::exception & __std_exception )

inlineinherited

catch() [11/12]

dx::event< user >::catch ( const std::exception & __std_exception )

inlineinherited

catch() [12/12]

dx::event< user >::catch ( const std::exception & __std_exception )

inlineinherited

conclude()

template<typename device_t = device>

void dx::usb::pipe< device_t >::conclude ( )

inlineoverridevirtualnoexcept

conclude notification: object will be removed. If you overwrite conclude() you also need to overwrite destructor and check if its needed to be called from there.

Reimplemented from dx::object.

dx_catchall_handler() [1/2]

dx::stream::control< dx::stream::object< device_t > >::dx_catchall_handler ( this )

inlineoverridenoexceptinherited

dx_catchall_handler() [2/2]

dx::stream::control< stream::object< device_t > >::dx_catchall_handler ( this )

inlineoverridenoexceptinherited

dx_catchall_rethrow() [1/3]

template<typename device_t , typename interface_t >

dx::usb::platform::pipe< device_t, interface_t >::dx_catchall_rethrow ( ) const

inlinenoexceptinherited

Here is the call graph for this function:

dx_catchall_rethrow() [2/3]

template<typename device_t = device>

dx::usb::pipe< device_t >::dx_catchall_rethrow ( ; , "endpoint:%x interface:%d setting:%d" , endpoint. address, endpoint. interface, endpoint. setting ) const

inlinenoexcept

dx_catchall_rethrow() [3/3]

template<typename device_t , typename interface_t >

dx::usb::platform::pipe< device_t, interface_t >::dx_catchall_rethrow ( try {const_cast< pipe< device_t, interface_t > * > this) ->clear();} dx_catchall_handler(this,, "idx:%d size:%lld" , idx , sizeof request ) const &

inlineinherited

control request to pipe

exception()

virtual void dx::object::exception ( const exception & exception, bool filtered = false ) const

pure virtualnoexceptinherited

notification exception handler

Implemented in dx::device< std::string >, dx::device<::AudioObjectID >, dx::device<::io_service_t >, dx::device< id_t >, dx::stream::pin< device_t, _circular_t >, dx::virtuel::stream::_device< desc_t, preference_t, stream_t >, dx::proxy::device, dx::usb::platform::device, and dx::proxy::device.

Here is the caller graph for this function:

flush() [1/2]

virtual void dx::stream::control< stream::object< device_t > >::flush ( )

inlineprotectedvirtualinherited

Reimplemented in dx::stream::stream< device< desc_t, dx::preference, pipe >, dx::circular, usb::pipe< device< desc_t, dx::preference, pipe > > >, and dx::stream::stream< device_t, dx::circular, usb::pipe< device_t > >.

flush() [2/2]

virtual void dx::stream::control< dx::stream::object< device_t > >::flush ( )

inlineprotectedvirtualinherited

Reimplemented in dx::stream::stream< device< desc_t, dx::preference, pipe >, dx::circular, usb::pipe< device< desc_t, dx::preference, pipe > > >, and dx::stream::stream< device_t, dx::circular, usb::pipe< device_t > >.

halt()

template<typename device_t , typename interface_t >

void dx::usb::platform::pipe< device_t, interface_t >::halt ( )

inlineoverrideprotectedvirtualnoexceptinherited

async IO thread control (required for Windows compatibility)

Reimplemented from dx::stream::control< stream::object< device_t > >.

Reimplemented in dx::stream::stream< device< desc_t, dx::preference, pipe >, dx::circular, usb::pipe< device< desc_t, dx::preference, pipe > > >, and dx::stream::stream< device_t, dx::circular, usb::pipe< device_t > >.

Here is the call graph for this function:

in()

template<typename device_t , typename interface_t >

bool dx::usb::platform::pipe< device_t, interface_t >::in ( ) const

inlinenoexceptinherited

bus initializer (isoc, bulk, pci, etc.) compatibility

info()

template<typename device_t = device>

void dx::usb::pipe< device_t >::info ( std::ostream & os )

inlineoverridevirtualnoexcept

log object class information

< Bit D7 indicates a requirement for wMaxPacketSize packets.; D7: MaxPacketsOnly

< D1..0: Pitch Control; D3..2: Data Overrun Control; D5..4: Data Underrun Control; D7..6: Reserved. Must be set to 0.

< Indicates the units used for the wLockDelay field: 0: Undefined; 1: Milliseconds; 2: Decoded PCM samples; 3..255: Reserved

< Indicates the time it takes this endpoint to reliably lock its internal clock recovery circuitry. Units used depend on the value of the bLockDelayUnits field.

< Number of Embedded MIDI Jacks: n.

< ID of the n-th Embedded Jack that is associated with this endpoint.

Reimplemented from dx::stream::control< stream::object< device_t > >.

Reimplemented in dx::stream::stream< device< desc_t, dx::preference, pipe >, dx::circular, usb::pipe< device< desc_t, dx::preference, pipe > > >, and dx::stream::stream< device_t, dx::circular, usb::pipe< device_t > >.

launch()

virtual void dx::object::launch ( )

inlinevirtualinherited

launch notification: object mounted and ready to use

Reimplemented in dx::map::driver< device >, dx::map::driver< device_t >, dx::stream::stream< device< desc_t, dx::preference, pipe >, dx::circular, usb::pipe< device< desc_t, dx::preference, pipe > > >, dx::stream::stream< device_t, dx::circular, usb::pipe< device_t > >, dx::usb::stream::_device< desc_t, preference_t, stream_t >, dx::virtuel::driver< device_t >, dx::proxy::driver< device< pin_t > >, dx::proxy::driver< device< stream_pin_t > >, dx::proxy::driver< device< super_device_t > >, dx::proxy::driver< device_t >, dx::proxy::driver< dx::test::device< super_device_t > >, dx::proxy::driver< dx::test::midi::device< super_device_t > >, dx::proxy::driver< device_t >, dx::proxy::driver< device< pin_t > >, dx::proxy::driver< device< stream_pin_t > >, dx::proxy::driver< device< super_device_t > >, dx::proxy::driver< device_t >, dx::proxy::driver< dx::test::device< super_device_t > >, dx::proxy::driver< dx::test::midi::device< super_device_t > >, and dx::proxy::driver< device_t >.

Here is the caller graph for this function:

max_frame_size()

template<typename device_t = device>

pipe & dx::usb::pipe< device_t >::max_frame_size ( uint32_t frame_size )

inline

operator os_event()

dx::event< kernel >::operator os_event ( )

inlinenoexceptinherited

operator<<()

template<typename device_t = device>

template<typename data_t >

pipe & dx::usb::pipe< device_t >::operator<< ( const data_t & data )

inline

synchronous USB write request

operator>>()

template<typename device_t = device>

template<typename data_t >

pipe & dx::usb::pipe< device_t >::operator>> ( data_t & data )

inline

synchronous USB read request

received() [1/4]

template<typename device_t , typename interface_t >

virtual void dx::usb::platform::pipe< device_t, interface_t >::received ( os_result , size_t  )

inlineprotectedvirtualinherited

virtual async callbacks

received() [2/4]

template<typename device_t , typename interface_t >

virtual void dx::usb::platform::pipe< device_t, interface_t >::received ( os_result , size_t  )

inlineprotectedvirtualinherited

virtual async callbacks

received() [3/4]

template<typename device_t , typename interface_t >

virtual void dx::usb::platform::pipe< device_t, interface_t >::received ( os_result , size_t , int64_t , usb::isoc::frame *  )

inlineprotectedvirtualinherited

received() [4/4]

template<typename device_t , typename interface_t >

virtual void dx::usb::platform::pipe< device_t, interface_t >::received ( os_result , size_t , int64_t , usb::isoc::frame *  )

inlineprotectedvirtualinherited

reset() [1/2]

event & dx::event< user >::reset ( uint64_t count = 0 )

inlineinherited

reset() [2/2]

event & dx::event< user >::reset ( uint64_t count = 0 )

inlineinherited

signal() [1/2]

event & dx::event< user >::signal ( uint64_t count = 1 )

inlineinherited

signal() [2/2]

event & dx::event< user >::signal ( uint64_t count = 1 )

inlineinherited

signalled() [1/2]

uint64_t dx::event< user >::signalled ( ) const

inlineinherited

signalled() [2/2]

uint64_t dx::event< user >::signalled ( ) const

inlineinherited

start()

template<typename device_t , typename interface_t >

bool dx::usb::platform::pipe< device_t, interface_t >::start ( uint64_t frame, unsigned int started = 1 )

inlineoverridevirtualinherited

async IO thread control

Reimplemented from dx::stream::control< stream::object< device_t > >.

Reimplemented in dx::stream::stream< device< desc_t, dx::preference, pipe >, dx::circular, usb::pipe< device< desc_t, dx::preference, pipe > > >, and dx::stream::stream< device_t, dx::circular, usb::pipe< device_t > >.

Here is the call graph for this function:

stop() [1/2]

virtual unsigned int dx::stream::control< stream::object< device_t > >::stop ( bool force = false )

inlinevirtualnoexceptinherited

result indicates the amount of stopped start references

stop() [2/2]

virtual unsigned int dx::stream::control< dx::stream::object< device_t > >::stop ( bool force = false )

inlinevirtualnoexceptinherited

result indicates the amount of stopped start references

submit()

template<typename device_t , typename interface_t >

template<typename data_t >

pipe & dx::usb::platform::pipe< device_t, interface_t >::submit ( const request< data_t > & request ) const

inlineinherited

standard request to pipe

transmitted() [1/4]

template<typename device_t , typename interface_t >

virtual void dx::usb::platform::pipe< device_t, interface_t >::transmitted ( os_result , size_t  )

inlineprotectedvirtualinherited

transmitted() [2/4]

template<typename device_t , typename interface_t >

virtual void dx::usb::platform::pipe< device_t, interface_t >::transmitted ( os_result , size_t  )

inlineprotectedvirtualinherited

transmitted() [3/4]

template<typename device_t , typename interface_t >

virtual void dx::usb::platform::pipe< device_t, interface_t >::transmitted ( os_result , size_t , int64_t , usb::isoc::frame *  )

inlineprotectedvirtualinherited

transmitted() [4/4]

template<typename device_t , typename interface_t >

virtual void dx::usb::platform::pipe< device_t, interface_t >::transmitted ( os_result , size_t , int64_t , usb::isoc::frame *  )

inlineprotectedvirtualinherited

wait() [1/4]

event & dx::event< user >::wait ( bool reset = false )

inlineinherited

wait() [2/4]

event & dx::event< user >::wait ( bool reset = false )

inlineinherited

wait() [3/4]

template<typename rep_t , typename period_t >

bool dx::event< user >::wait ( const std::chrono::duration< rep_t, period_t > & timeout, bool reset = false )

inlineinherited

wait with duration timeout returns true: signalled false: timed out

wait() [4/4]

template<typename rep_t , typename period_t >

bool dx::event< user >::wait ( const std::chrono::duration< rep_t, period_t > & timeout, bool reset = false )

inlineinherited

wait with duration timeout returns true: signalled false: timed out

Member Data Documentation

[struct] [1/2]

struct { ... } dx::usb::platform::pipe< device_t, interface_t >::address

address [2/2]

template<typename device_t , typename interface_t >

uint8_t dx::usb::platform::pipe< device_t, interface_t >::address = 0

protectedinherited

attributes

template<typename device_t = device>

const usb::endpoint::attributes& dx::usb::pipe< device_t >::attributes = reinterpret_cast<const struct usb::endpoint::attributes&>(bmAttributes)

audio

std::deque<union audio::descriptor::endpoint> dx::usb::__::endpoint::audio

inherited

[class]

class { ... } ::buffer dx::usb::platform::pipe< device_t, interface_t >::buffer

device [1/2]

device_t & dx::stream::object< device_t >::device

protectedinherited

device [2/2]

device_t & dx::stream::object< device_t >::device

protectedinherited

handle

template<typename device_t , typename interface_t >

::WINUSB_INTERFACE_HANDLE dx::usb::platform::pipe< device_t, interface_t >::handle

inherited

idx

template<typename device_t , typename interface_t >

uint8_t dx::usb::platform::pipe< device_t, interface_t >::idx = 0

protectedinherited

interface

template<typename device_t , typename interface_t >

interface_t & dx::usb::platform::pipe< device_t, interface_t >::interface

inherited

[struct] [1/2]

struct { ... } dx::usb::platform::pipe< device_t, interface_t >::isoc

isoc [2/2]

template<typename device_t , typename interface_t >

struct dx::usb::platform::pipe::isoc dx::usb::platform::pipe< device_t, interface_t >::isoc

protectedinherited

launched [1/2]

bool dx::object::launched {}

inherited

launched [2/2]

bool dx::object::launched {}

inherited

micro_frames

template<typename device_t , typename interface_t >

unsigned int dx::usb::platform::pipe< device_t, interface_t >::micro_frames = 0

inherited

notify [1/2]

std::deque<std::function<void(control&)> dx::stream::control< dx::stream::object< device_t > >::notify)

inherited

notify [2/2]

std::deque<std::function<void(control&)> dx::stream::control< stream::object< device_t > >::notify)

inherited

scope

static constexpr auto dx::event< kernel >::scope = kernel

staticconstexprinherited

start_stop_in_progress [1/2]

std::recursive_mutex dx::stream::control< dx::stream::object< device_t > >::start_stop_in_progress

protectedinherited

start/stop operation in progress

start_stop_in_progress [2/2]

std::recursive_mutex dx::stream::control< stream::object< device_t > >::start_stop_in_progress

protectedinherited

start/stop operation in progress

started [1/2]

std::atomic<unsigned int> dx::stream::control< dx::stream::object< device_t > >::started

inherited

started [2/2]

std::atomic<unsigned int> dx::stream::control< stream::object< device_t > >::started

inherited

type

template<typename device_t , typename interface_t >

enum dx::usb::platform::pipe::type dx::usb::platform::pipe< device_t, interface_t >::type

inherited

[struct]

struct { ... } dx::usb::platform::pipe< device_t, interface_t >::winusb

---

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

• dx_usb_device.h