virtual streaming device interface class More...

#include <dx_virtual_stream_device.h>

Inheritance diagram for dx::virtuel::stream::_device< desc_t, preference_t, stream_t >:

Collaboration diagram for dx::virtuel::stream::_device< desc_t, preference_t, stream_t >:

Public Types
typedef desc_t	desc_t
typedef shared::event	event
typedef stream_t	stream_t

Public Member Functions
	_device (decltype(super::driver)&driver, decltype(super::id)&id)
	the virtual stream device class constructor
	_device (decltype(super::driver)&driver, decltype(super::id)&id, const desc_t &desc)
	catch (...)
DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN	catch (const dx::exception &__dx_exception)
	catch (const std::exception &__std_exception)
void	conclude () noexcept override
	dx_catchall_handler (this,) void conclude() noexcept override
void	exception (const dx::exception &exception, bool filtered=false) const noexcept override
virtual uint64_t	frame () const
DX_PRAGMA_IGNORE_RETURN_VALUE_END bool	hw_clock () const noexcept override
void	hw_clock (abstract::event *) override try
DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN DX_PRAGMA_IGNORE_RETURN_VALUE_END void	info (std::ostream &os) noexcept override
_device &	reset ()
virtual bool	start (uint64_t=0, unsigned int starting=1)
virtual unsigned int	stop (bool force=false) noexcept
virtual std::string	string (uint8_t) const
void	wake () override
	~_device () override

Public Attributes
promoted< typename super::client_map >	clients
abstract::event *	clock
promoted< uint32_t >::preference< decltype(dx::stream::control< dx::device< std::string, preference_t > >::preference)>	clocksource
std::atomic< size_t >	counter
promoted< desc_t >::template preference< preference_t, typename desc_t::value_t >	desc {this->preference}
struct {
abstract::event * clock
std::atomic< size_t > counter
uint32_t iosize
}	hw
promoted< std::string >::preference< decltype(dx::stream::control< dx::device< std::string, preference_t > >::preference)>	icon
promoted< uint32_t >::preference< decltype(dx::stream::control< dx::device< std::string, preference_t > >::preference)>	iosize
uint32_t	iosize
dx::stream::device::monitor	monitor
std::deque< std::function< void(control &)> >	notify
promoted< uint32_t >::preference< decltype(dx::stream::control< dx::device< std::string, preference_t > >::preference)>	safety_offset [direction::directions]
promoted< uint32_t >::preference< decltype(dx::stream::control< dx::device< std::string, preference_t > >::preference)>	samplerate
std::atomic< unsigned int >	started {}
std::map< decltype(desc_t::stream::target.idx()), std::weak_ptr< stream_t > >	streams
promoted< uint32_t >::preference< decltype(dx::stream::control< dx::device< std::string, preference_t > >::preference)>	sync_cycle_ticks
promoted< structdesc_t::stream * >::template preference< decltype(dx::stream::control< dx::device< std::string, preference_t > >::preference), uint32_t >	sync_reference
dx::stream::device::monitor	version

Protected Member Functions
virtual void	flush ()
virtual void	halt ()

Protected Attributes
std::recursive_mutex	start_stop_in_progress
	start/stop operation in progress

Detailed Description

template<typename desc_t, typename preference_t, typename stream_t>
class dx::virtuel::stream::_device< desc_t, preference_t, stream_t >

virtual streaming device interface class

Exceptions

In	case of an error returned by the underlaying API the device class throws a dx::exception.

Member Typedef Documentation

◆ desc_t

typedef desc_t dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >::desc_t

inherited

◆ event

template<typename desc_t, typename preference_t, typename stream_t>

typedef shared::event dx::virtuel::stream::_device< desc_t, preference_t, stream_t >::event

◆ stream_t

typedef stream_t dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >::stream_t

inherited

Constructor & Destructor Documentation

◆ _device() [1/2]

template<typename desc_t, typename preference_t, typename stream_t>

dx::virtuel::stream::_device< desc_t, preference_t, stream_t >::_device	(	decltype(super::driver)&	driver,
		decltype(super::id)&	id )

inline

the virtual stream device class constructor

◆ _device() [2/2]

template<typename desc_t, typename preference_t, typename stream_t>

dx::virtuel::stream::_device< desc_t, preference_t, stream_t >::_device	(	decltype(super::driver)&	driver,
		decltype(super::id)&	id,
		const desc_t &	desc )

inline

◆ ~_device()

template<typename desc_t, typename preference_t, typename stream_t>

dx::virtuel::stream::_device< desc_t, preference_t, stream_t >::~_device ( )

inlineoverride

Member Function Documentation

◆ catch() [1/3]

template<typename desc_t, typename preference_t, typename stream_t>

dx::virtuel::stream::_device< desc_t, preference_t, stream_t >::catch ( ... )

inline

◆ catch() [2/3]

template<typename desc_t, typename preference_t, typename stream_t>

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::virtuel::stream::_device< desc_t, preference_t, stream_t >::catch ( const dx::exception & __dx_exception )

inline

◆ catch() [3/3]

template<typename desc_t, typename preference_t, typename stream_t>

dx::virtuel::stream::_device< desc_t, preference_t, stream_t >::catch ( const std::exception & __std_exception )

inline

◆ conclude()

template<typename desc_t, typename preference_t, typename stream_t>

void dx::virtuel::stream::_device< desc_t, preference_t, stream_t >::conclude ( )

inlineoverridenoexcept

Here is the caller graph for this function:

◆ dx_catchall_handler()

template<typename object_t>

dx::stream::control< object_t >::dx_catchall_handler ( this )

inlineoverridenoexceptinherited

◆ exception()

template<typename desc_t, typename preference_t, typename stream_t>

void dx::virtuel::stream::_device< desc_t, preference_t, stream_t >::exception	(	const dx::exception &	exception,
		bool	filtered = false ) const

inlineoverridenoexcept

◆ flush()

template<typename object_t>

virtual void dx::stream::control< object_t >::flush ( )

inlineprotectedvirtualinherited

Reimplemented in dx::stream::stream< device_t, dx::circular, usb::pipe< device_t > >.

◆ frame()

template<typename desc_t, typename preference_t, typename stream_t>

virtual uint64_t dx::virtuel::stream::_device< desc_t, preference_t, stream_t >::frame ( ) const

inlinevirtual

◆ halt()

template<typename object_t>

virtual void dx::stream::control< object_t >::halt ( )

inlineprotectedvirtualinherited

Reimplemented in dx::coreaudio::_device< desc_t, preference_t, stream_t >, dx::coreaudio::_device< desc_t, preference_t, stream_t< device< desc_t, preference_t, stream_t > > >, dx::coreaudio::_device< dx::virtuel::stream::desc, cf::preference, dx::stream::stream< device< dx::virtuel::stream::desc, cf::preference, dx::stream::stream > > >, dx::coreaudio::_device< dx::virtuel::stream::desc, cf::preference, stream< device< dx::virtuel::stream::desc, cf::preference, stream > > >, dx::proxy::stream::_device< desc_t, preference_t, stream_t >, dx::proxy::stream::_device< desc_t, preference_t, stream_t< device< desc_t, preference_t, stream_t > > >, dx::proxy::stream::_device< dx::stream::desc<>, dx::preference, stream< device< dx::stream::desc<>, dx::preference, stream > > >, dx::stream::pin< device_t, _circular_t >, dx::stream::stream< device_t, dx::circular, usb::pipe< device_t > >, dx::usb::platform::pipe< device_t, interface_t >, dx::usb::platform::pipe< device<>, interface >, dx::usb::platform::pipe< device_t, interface >, dx::usb::platform::pipe< device_t, usb::interface >, and dx::usb::stream::pipe< device_t, circular_t, stream_t >.

Here is the caller graph for this function:

◆ hw_clock() [1/2]

template<typename desc_t, typename preference_t, typename stream_t>

DX_PRAGMA_IGNORE_RETURN_VALUE_END bool dx::virtuel::stream::_device< desc_t, preference_t, stream_t >::hw_clock ( ) const

inlineoverridevirtualnoexcept

Reimplemented from dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >.

◆ hw_clock() [2/2]

template<typename desc_t, typename preference_t, typename stream_t>

void dx::virtuel::stream::_device< desc_t, preference_t, stream_t >::hw_clock ( abstract::event * )

inlineoverridevirtual

Reimplemented from dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >.

◆ info()

template<typename desc_t, typename preference_t, typename stream_t>

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN DX_PRAGMA_IGNORE_RETURN_VALUE_END void dx::virtuel::stream::_device< desc_t, preference_t, stream_t >::info ( std::ostream & os )

inlineoverridenoexcept

◆ reset()

template<typename desc_t, typename preference_t, typename stream_t>

_device & dx::virtuel::stream::_device< desc_t, preference_t, stream_t >::reset ( )

inline

◆ start()

template<typename object_t>

virtual bool dx::stream::control< object_t >::start	(	uint64_t	= 0,
		unsigned int	starting = 1 )

inlinevirtualinherited

result indicates if start changed the state.

Reimplemented in dx::coreaudio::_device< desc_t, preference_t, stream_t >, dx::coreaudio::_device< desc_t, preference_t, stream_t< device< desc_t, preference_t, stream_t > > >, dx::coreaudio::_device< dx::virtuel::stream::desc, cf::preference, dx::stream::stream< device< dx::virtuel::stream::desc, cf::preference, dx::stream::stream > > >, dx::coreaudio::_device< dx::virtuel::stream::desc, cf::preference, stream< device< dx::virtuel::stream::desc, cf::preference, stream > > >, dx::coreaudio::pod::device< desc_t, preference_t, stream_t >, dx::stream::pin< device_t, _circular_t >, dx::stream::stream< device_t, dx::circular, usb::pipe< device_t > >, dx::usb::platform::pipe< device_t, interface_t >, dx::usb::platform::pipe< device<>, interface >, dx::usb::platform::pipe< device_t, interface >, dx::usb::platform::pipe< device_t, usb::interface >, and dx::usb::stream::pipe< device_t, circular_t, stream_t >.

Here is the caller graph for this function:

◆ stop()

template<typename object_t>

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

inlinevirtualnoexceptinherited

result indicates the amount of stopped start references

◆ string()

template<typename desc_t, typename preference_t, typename stream_t>

virtual std::string dx::virtuel::stream::_device< desc_t, preference_t, stream_t >::string ( uint8_t ) const

inlinevirtual

◆ wake()

void dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >::wake ( )

inlineoverrideinherited

Member Data Documentation

◆ clients

template<typename desc_t, typename preference_t, typename stream_t>

promoted<typename super::client_map> dx::virtuel::stream::_device< desc_t, preference_t, stream_t >::clients

Initial value:

{
        [this](dx::promoted<typename super::client_map>::lock_t&& lock, const typename super::client_map& value, const typename super::client_map&){
            dx::promoted<uint32_t>::lock_t tmp{std::move(lock)};
            if(clients.transient)
                clients.commit(std::move(tmp), value);
        }}

◆ clock

abstract::event* dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >::clock

inherited

◆ clocksource

promoted<uint32_t>::preference<decltype(dx::stream::control< dx::device< std::string, preference_t > >::preference)> dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >::clocksource

inherited

◆ counter

std::atomic<size_t> dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >::counter

inherited

◆ desc

template<typename desc_t, typename preference_t, typename stream_t>

promoted<desc_t>::template preference<preference_t, typename desc_t::value_t> dx::virtuel::stream::_device< desc_t, preference_t, stream_t >::desc {this->preference}

◆ [struct]

struct { ... } dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >::hw

◆ icon

promoted<std::string>::preference<decltype(dx::stream::control< dx::device< std::string, preference_t > >::preference)> dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >::icon

inherited

◆ iosize [1/2]

promoted<uint32_t>::preference<decltype(dx::stream::control< dx::device< std::string, preference_t > >::preference)> dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >::iosize

inherited

◆ iosize [2/2]

uint32_t dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >::iosize

inherited

◆ monitor

dx::stream::device::monitor dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >::monitor

inherited

◆ notify

template<typename object_t>

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

inherited

◆ safety_offset

promoted<uint32_t>::preference<decltype(dx::stream::control< dx::device< std::string, preference_t > >::preference)> dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >::safety_offset[direction::directions]

inherited

◆ samplerate

promoted<uint32_t>::preference<decltype(dx::stream::control< dx::device< std::string, preference_t > >::preference)> dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >::samplerate

inherited

◆ start_stop_in_progress

template<typename object_t>

std::recursive_mutex dx::stream::control< object_t >::start_stop_in_progress

protectedinherited

start/stop operation in progress

◆ started

template<typename object_t>

std::atomic<unsigned int> dx::stream::control< object_t >::started {}

inherited

◆ streams

std::map<decltype(desc_t::stream::target.idx()), std::weak_ptr<stream_t> > dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >::streams

inherited

◆ sync_cycle_ticks

promoted<uint32_t>::preference<decltype(dx::stream::control< dx::device< std::string, preference_t > >::preference)> dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >::sync_cycle_ticks

inherited

◆ sync_reference

promoted<structdesc_t::stream*>::template preference<decltype(dx::stream::control< dx::device< std::string, preference_t > >::preference), uint32_t> dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >::sync_reference

inherited

◆ version

dx::stream::device::monitor dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >::version

inherited

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

dx_virtual_stream_device.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ desc_t

◆ event

◆ stream_t

Constructor & Destructor Documentation

◆ _device() [1/2]

◆ _device() [2/2]

◆ ~_device()

Member Function Documentation

◆ catch() [1/3]

◆ catch() [2/3]

◆ catch() [3/3]

◆ conclude()

◆ dx_catchall_handler()

◆ exception()

◆ flush()

◆ frame()

◆ halt()

◆ hw_clock() [1/2]

◆ hw_clock() [2/2]

◆ info()

◆ reset()

◆ start()

◆ stop()

◆ string()

◆ wake()

Member Data Documentation

◆ clients

◆ clock

◆ clocksource

◆ counter

◆ desc

◆ [struct]

◆ icon

◆ iosize [1/2]

◆ iosize [2/2]

◆ monitor

◆ notify

◆ safety_offset

◆ samplerate

◆ start_stop_in_progress

◆ started

◆ streams

◆ sync_cycle_ticks

◆ sync_reference

◆ version