dx::virtuel::driver< device_t > Class Template Reference

#include <dx_virtual_driver.h>

Inheritance diagram for dx::virtuel::driver< device_t >:

Collaboration diagram for dx::virtuel::driver< device_t >:

Public Types
typedef decltype(matching_ids)	match

Public Member Functions
virtual DX_PRAGMA_IGNORE_RETURN_VALUE_END bool	boot () try
	catch (...)
	catch (...)
	catch (...)
DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN	catch (const dx::exception &__dx_exception)
DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN	catch (const dx::exception &__dx_exception)
DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN	catch (const dx::exception &__dx_exception)
	catch (const std::exception &__std_exception)
	catch (const std::exception &__std_exception)
	catch (const std::exception &__std_exception)
DX_PRAGMA_IGNORE_RETURN_VALUE_END bool	contains (const std::string &id) noexcept
super &	create (const std::string &device_id, const typename device_t::desc_t &desc) override try
virtual driver &	create (const std::string &id, const typename super::device_t::desc_t &desc)
DX_PRAGMA_IGNORE_RETURN_VALUE_END super &	destroy (const std::string &id) override try
	destroy: to be used to permamently eliminate a virtual device
	driver (const match &matching_ids, const char *id, dx::log log={})
	the virtual driver interface class constructor
DX_PRAGMA_IGNORE_RETURN_VALUE_END void	exception (const class exception &exception, bool filtered=false) const noexcept override try
	notification exception handler
virtual void	exception (const exception &exception, bool filtered=false) const noexcept=0
	notification exception handler
DX_PRAGMA_IGNORE_RETURN_VALUE_END void	info (std::ostream &os) noexcept override
	log object class information
DX_PRAGMA_IGNORE_RETURN_VALUE_END void	launch () override try
	launch notification: object mounted and ready to use
std::shared_ptr< typename super::device_t >	operator[] (const std::string &id) try
virtual bool	shutdown () try
	client driver::shutdown/boot(): override to shutdown/boot host driver
std::shared_ptr< typename super::device_t >	wait (const std::string &id) noexcept

Public Attributes
promoted< uint32_t >	connection_id
T	elements
	STL member.
K	keys
	STL member.
bool	launched {}
log	log
decltype(_device_t::preference)	preference
const char *	product_id
uint32_t	version

Protected Types
typedef decltype(device_t::id)	device_id_t
typedef device_t	device_t

Protected Member Functions
virtual void	add (const decltype(_device_t::id) &)=0
	adds a new device to the device list
void	add (const device_id_t &device_id) override try
	adds a new device to the device list
virtual void	arrived ()
	notify device arrivals completed stub
void	arrived (super::device_t &device) override try
	catch (...)
DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN	catch (const dx::exception &__dx_exception)
	catch (const std::exception &__std_exception)
DX_PRAGMA_IGNORE_RETURN_VALUE_END void	clear () noexcept try
	replaces std::map::clear to call virtual notification methods
DX_PRAGMA_IGNORE_RETURN_VALUE_END void	conclude () noexcept override try
	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,) virtual driver &operator<<(std
	restores device settings
virtual driver &	operator<< (const char *file)
virtual driver &	operator>> (const char *file) const
virtual driver &	operator>> (std::ostream &ostream) const
	saves device tree
virtual void	remove (const decltype(_device_t::id) &)=0
	finds and removes a device from the device list
DX_PRAGMA_IGNORE_RETURN_VALUE_END void	remove (const device_id_t &device_id) override try
	finds and removes a device from the device list
virtual void	removed () noexcept
	notify device removals completed stub
virtual void	removed (device_t &) noexcept
	notify specific device removal stub
virtual void	scan () try
void	sleep () override
	< notify system will sleep
void	wake () override

Protected Attributes
std::vector< std::string >	matching_ids

Member Typedef Documentation

device_id_t

typedef decltype(device_t::id) dx::map::driver< device_t >::device_id_t

protectedinherited

device_t

typedef device_t dx::map::driver< device_t >::device_t

protectedinherited

match

template<class device_t >

typedef decltype(matching_ids) dx::virtuel::driver< device_t >::match

Constructor & Destructor Documentation

driver()

template<class device_t >

dx::virtuel::driver< device_t >::driver ( const match & matching_ids, const char * id, dx::log log = {} )

inline

the virtual driver interface class constructor

Parameters

matching_ids	the matching virtual driver IDs identifying the driver interface
id	virtual driver ID
log	log settings

Member Function Documentation

add() [1/2]

virtual void dx::driver< decltype(_device_t::id) , decltype(_device_t::preference) >::add ( const decltype(_device_t::id) & )

protectedpure virtualinherited

adds a new device to the device list

Exceptions

dx::exception

add() [2/2]

void dx::map::driver< device_t >::add ( const device_id_t & device_id )

inlineoverrideprotectedinherited

adds a new device to the device list

Exceptions

dx::exception

arrived() [1/2]

virtual void dx::driver< device_id_t, preference_t >::arrived ( )

inlineprotectedvirtualinherited

notify device arrivals completed stub

Reimplemented from dx::driver< decltype(_device_t::id), decltype(_device_t::preference)>.

Reimplemented in dx::stream::engine< dx::test::device< super_device_t >, audio_pin_t, dx::virtuel::driver< dx::test::device< super_device_t > >, int32_t >, and dx::service::client::driver< device_t >.

arrived() [2/2]

void dx::stream::driver< dx::map::driver< device_t > >::arrived ( super::device_t & )

inlineoverrideprotectedvirtualinherited

Reimplemented from dx::map::driver< device_t >.

boot()

virtual DX_PRAGMA_IGNORE_RETURN_VALUE_END bool dx::driver< decltype(_device_t::id) , decltype(_device_t::preference) >::boot ( )

inlinevirtualinherited

catch() [1/12]

template<class device_t >

dx::virtuel::driver< device_t >::catch ( ... )

inlineprotected

catch() [2/12]

template<class device_t >

dx::virtuel::driver< device_t >::catch ( ... )

inline

catch() [3/12]

template<class device_t >

dx::virtuel::driver< device_t >::catch ( ... )

inline

catch() [4/12]

template<class device_t >

dx::virtuel::driver< device_t >::catch ( ... )

inline

catch() [5/12]

template<class device_t >

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::virtuel::driver< device_t >::catch ( const dx::exception & __dx_exception )

inlineprotected

catch() [6/12]

template<class device_t >

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::virtuel::driver< device_t >::catch ( const dx::exception & __dx_exception )

inline

catch() [7/12]

template<class device_t >

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::virtuel::driver< device_t >::catch ( const dx::exception & __dx_exception )

inline

catch() [8/12]

template<class device_t >

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::virtuel::driver< device_t >::catch ( const dx::exception & __dx_exception )

inline

catch() [9/12]

template<class device_t >

dx::virtuel::driver< device_t >::catch ( const std::exception & __std_exception )

inlineprotected

catch() [10/12]

template<class device_t >

dx::virtuel::driver< device_t >::catch ( const std::exception & __std_exception )

inline

catch() [11/12]

template<class device_t >

dx::virtuel::driver< device_t >::catch ( const std::exception & __std_exception )

inline

catch() [12/12]

template<class device_t >

dx::virtuel::driver< device_t >::catch ( const std::exception & __std_exception )

inline

clear()

DX_PRAGMA_IGNORE_RETURN_VALUE_END void dx::map::driver< device_t >::clear ( )

inlineprotectednoexceptinherited

replaces std::map::clear to call virtual notification methods

conclude()

DX_PRAGMA_IGNORE_RETURN_VALUE_END void dx::map::driver< device_t >::conclude ( )

inlineoverrideprotectedvirtualnoexceptinherited

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.

Reimplemented in dx::stream::engine< dx::test::device< super_device_t >, audio_pin_t, dx::virtuel::driver< dx::test::device< super_device_t > >, int32_t >.

contains()

DX_PRAGMA_IGNORE_RETURN_VALUE_END bool dx::stream::driver< dx::map::driver< device_t > >::contains ( const std::string & id )

inlinenoexceptinherited

create() [1/2]

template<class device_t >

super & dx::virtuel::driver< device_t >::create ( const std::string & device_id, const typename device_t::desc_t & desc )

inlineoverride

Here is the call graph for this function:

create() [2/2]

virtual driver & dx::stream::driver< dx::map::driver< device_t > >::create ( const std::string & id, const typename super::device_t::desc_t & desc )

inlinevirtualinherited

destroy()

template<class device_t >

DX_PRAGMA_IGNORE_RETURN_VALUE_END super & dx::virtuel::driver< device_t >::destroy ( const std::string & id )

inlineoverridevirtual

destroy: to be used to permamently eliminate a virtual device

Reimplemented from dx::stream::driver< dx::map::driver< device_t > >.

Here is the call graph for this function:

dx_catchall_handler()

dx::map::driver< device_t >::dx_catchall_handler ( this ) &

inlineprotectedinherited

restores device settings

exception() [1/2]

DX_PRAGMA_IGNORE_RETURN_VALUE_END void dx::driver< decltype(_device_t::id) , decltype(_device_t::preference) >::exception ( const class exception & exception, bool filtered = false ) const

inlineoverridenoexceptinherited

notification exception handler

exception() [2/2]

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

pure virtualnoexceptinherited

notification exception handler

Implemented in dx::device< dx::guid, dx::preference >, dx::device< dx::guid, preference_t >, dx::device< std::string, dx::preference >, dx::device< std::string, preference_t >, dx::device<::AudioObjectID, cf::preference >, dx::device<::AudioObjectID, preference_t >, dx::device<::io_service_t, dx::preference >, dx::device<::io_service_t, preference_t >, dx::device<::io_service_t, super_device_t >, dx::device<::MIDIDeviceRef, cf::preference >, dx::device<::MIDIDeviceRef, preference_t >, dx::device< id_t, preference_t >, dx::stream::pin< device_t, _circular_t >, dx::virtuel::stream::_device< desc_t, preference_t, stream_t >, dx::usb::platform::device< preference_t >, dx::asio::client::_device< desc_t, preference_t, stream_t >, dx::proxy::device< dx::preference >, dx::proxy::device<>, dx::proxy::device< preference_t >, dx::service::app, and dx::service::client::_device< desc_t, preference_t, stream_t >.

Here is the caller graph for this function:

info()

template<class device_t >

DX_PRAGMA_IGNORE_RETURN_VALUE_END void dx::virtuel::driver< device_t >::info ( std::ostream & os )

inlineoverridevirtualnoexcept

log object class information

Reimplemented from dx::stream::driver< dx::map::driver< device_t > >.

Reimplemented in dx::stream::engine< dx::test::device< super_device_t >, audio_pin_t, dx::virtuel::driver< dx::test::device< super_device_t > >, int32_t >.

Here is the call graph for this function:

launch()

template<class device_t >

DX_PRAGMA_IGNORE_RETURN_VALUE_END void dx::virtuel::driver< device_t >::launch ( )

inlineoverridevirtual

launch notification: object mounted and ready to use

Todo

virtual::driver::launch(): fix preference[] and remove ":" test hack

Reimplemented from dx::map::driver< device_t >.

Here is the call graph for this function:

operator<<()

virtual driver & dx::map::driver< device_t >::operator<< ( const char * file )

inlineprotectedvirtualinherited

operator>>() [1/2]

virtual driver & dx::map::driver< device_t >::operator>> ( const char * file ) const

inlineprotectedvirtualinherited

operator>>() [2/2]

virtual driver & dx::map::driver< device_t >::operator>> ( std::ostream & ostream ) const

inlineprotectedvirtualinherited

saves device tree

Reimplemented in dx::coreaudio::driver< device_t >.

operator[]()

std::shared_ptr< typename super::device_t > dx::stream::driver< dx::map::driver< device_t > >::operator[] ( const std::string & id )

inlineinherited

remove() [1/2]

virtual void dx::driver< decltype(_device_t::id) , decltype(_device_t::preference) >::remove ( const decltype(_device_t::id) & )

protectedpure virtualinherited

finds and removes a device from the device list

remove() [2/2]

DX_PRAGMA_IGNORE_RETURN_VALUE_END void dx::map::driver< device_t >::remove ( const device_id_t & device_id )

inlineoverrideprotectedinherited

finds and removes a device from the device list

Exceptions

dx::exception

removed() [1/2]

virtual void dx::driver< device_id_t, preference_t >::removed ( )

inlineprotectedvirtualnoexceptinherited

notify device removals completed stub

Reimplemented from dx::driver< decltype(_device_t::id), decltype(_device_t::preference)>.

removed() [2/2]

virtual void dx::map::driver< device_t >::removed ( device_t & )

inlineprotectedvirtualnoexceptinherited

notify specific device removal stub

scan()

template<class device_t >

virtual void dx::virtuel::driver< device_t >::scan ( )

inlineprotectedvirtual

Here is the call graph for this function:

shutdown()

virtual bool dx::driver< decltype(_device_t::id) , decltype(_device_t::preference) >::shutdown ( )

inlinevirtualinherited

client driver::shutdown/boot(): override to shutdown/boot host driver

Reimplemented in dx::coreaudio::driver< device_t >.

sleep()

void dx::map::driver< device_t >::sleep ( )

inlineoverrideprotectedinherited

< notify system will sleep

notify system wake completed stub

wait()

std::shared_ptr< typename super::device_t > dx::stream::driver< dx::map::driver< device_t > >::wait ( const std::string & id )

inlinenoexceptinherited

wake()

void dx::map::driver< device_t >::wake ( )

inlineoverrideprotectedinherited

Member Data Documentation

connection_id

template<class device_t >

promoted<uint32_t> dx::virtuel::driver< device_t >::connection_id

elements

T std::map< K, T >::elements

inherited

STL member.

keys

K std::map< K, T >::keys

inherited

STL member.

launched

bool dx::object::launched {}

inherited

log

log dx::driver< decltype(_device_t::id) , decltype(_device_t::preference) >::log

inherited

matching_ids

template<class device_t >

std::vector<std::string> dx::virtuel::driver< device_t >::matching_ids

protected

preference

decltype(_device_t::preference) dx::driver< decltype(_device_t::id) , decltype(_device_t::preference) >::preference

inherited

product_id

const char* dx::driver< decltype(_device_t::id) , decltype(_device_t::preference) >::product_id

inherited

version

uint32_t dx::driver< decltype(_device_t::id) , decltype(_device_t::preference) >::version

inherited

---

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

• dx_virtual_driver.h