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
void	add (const std::string &device_id, const typename device_t::desc_t &desc)
virtual bool	boot () try
	catch (...)
	catch (...)
	catch (const dx::exception &__dx_exception)
	catch (const dx::exception &__dx_exception)
	catch (const std::exception &__std_exception)
	catch (const std::exception &__std_exception)
	driver (const match &matching_ids, const char *id, dx::log log={})
	the virtual driver interface class constructor
void	exception (const class exception &exception, bool filtered=false) noexcept override try
	notification exception handler
virtual void	exception (const exception &exception, bool filtered=false) noexcept=0
	notification exception handler
void	info (std::ostream &os) noexcept override
	log object class information
void	launch () override try
	launch notification: object mounted and ready to use
void	remove (const std::string &id, bool=false) try
	non-virtual remove hides super::remove() to be used to permamently eliminate a virtual device
virtual bool	shutdown () try
	client driver::shutdown/boot(): override to shutdown/boot host driver

Public Attributes
T	elements
	STL member.
K	keys
	STL member.
bool	launched {}
log	log
const char *	product_id
uint32_t	version

Static Public Attributes
static constexpr auto	connection_id = class_name

Protected Types
typedef decltype(device_t::id)	device_id_t

Protected Member Functions
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
virtual void	arrived (device_t &)
	notify specific device arrival stub
	catch (...)
	catch (const dx::exception &__dx_exception)
	catch (const std::exception &__std_exception)
void	clear () noexcept try
	replaces std::map::clear to call virtual notification methods
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 void operator<<(std
	restores device settings
virtual void	operator>> (std::ostream &ostream) const
	saves device tree
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

Protected Attributes
dx_catchall_handler(this,) public typedef std::map< device_id_t, std::shared_ptr< device_t > >	map
std::vector< std::string >	matching_ids

Member Typedef Documentation

device_id_t

template<typename device_t >

typedef decltype(device_t::id) dx::map::driver< device_t >::device_id_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]

template<class device_t >

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

inlineoverrideprotectedvirtual

adds a new device to the device list

Exceptions

dx::exception

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

add() [2/2]

template<class device_t >

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

inline

Here is the call graph for this function:

Here is the caller graph for this function:

arrived() [1/2]

template<typename device_t >

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

inlineprotectedvirtualinherited

notify device arrivals completed stub

Reimplemented from dx::driver< decltype(device_t::id)>.

Reimplemented in dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >, dx::stream::engine< device< super_device_t >, audio_pin_t, dx::proxy::driver< device< super_device_t > >, int32_t >, dx::stream::engine< dx::test::device< super_device_t >, audio_pin_t, dx::proxy::driver< dx::test::device< super_device_t > >, int32_t >, 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::stream::engine< dx::test::midi::device< super_device_t >, audio_pin_t, dx::proxy::driver< dx::test::midi::device< super_device_t > >, int32_t >.

Here is the caller graph for this function:

arrived() [2/2]

template<typename device_t >

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

inlineprotectedvirtualinherited

notify specific device arrival stub

Reimplemented in dx::coremidi::server::plugin< stream_pin_t, device_t, driver_t >, dx::coreaudio::driver< device_t >, and dx::coreaudio::server::plugin< pin_t, device_t, driver_t >.

boot()

virtual bool dx::driver< decltype(device_t::id) >::boot ( )

inlinevirtualinherited

catch() [1/9]

template<class device_t >

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

inlineprotected

catch() [2/9]

template<class device_t >

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

inline

catch() [3/9]

template<class device_t >

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

inline

catch() [4/9]

template<class device_t >

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

inlineprotected

catch() [5/9]

template<class device_t >

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

inline

catch() [6/9]

template<class device_t >

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

inline

catch() [7/9]

template<class device_t >

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

inlineprotected

catch() [8/9]

template<class device_t >

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

inline

catch() [9/9]

template<class device_t >

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

inline

clear()

template<typename device_t >

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

inlineprotectednoexceptinherited

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

Here is the call graph for this function:

Here is the caller graph for this function:

conclude()

template<typename device_t >

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.

Here is the call graph for this function:

Here is the caller graph for this function:

dx_catchall_handler()

template<typename device_t >

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

inlineprotectedinherited

restores device settings

exception() [1/2]

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

inlineoverridenoexceptinherited

notification exception handler

exception() [2/2]

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

pure virtualnoexceptinherited

notification exception handler

Implemented in dx::device< dx::guid >, 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::usb::platform::device, dx::asio::client::_device< desc_t, preference_t, stream_t >, and dx::proxy::device.

Here is the caller graph for this function:

info()

template<class device_t >

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

inlineoverridevirtualnoexcept

log object class information

Reimplemented from 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 >

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>>()

template<typename device_t >

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

inlineprotectedvirtualinherited

saves device tree

Here is the call graph for this function:

remove() [1/2]

template<typename device_t >

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

inlineoverrideprotectedvirtualinherited

finds and removes a device from the device list

Exceptions

dx::exception

Implements dx::driver< decltype(device_t::id)>.

Here is the call graph for this function:

Here is the caller graph for this function:

remove() [2/2]

template<class device_t >

void dx::virtuel::driver< device_t >::remove ( const std::string & id, bool = false )

inline

non-virtual remove hides super::remove() to be used to permamently eliminate a virtual device

Here is the call graph for this function:

Here is the caller graph for this function:

removed() [1/2]

template<typename device_t >

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

inlineprotectedvirtualnoexceptinherited

notify device removals completed stub

Reimplemented from dx::driver< decltype(device_t::id)>.

Here is the caller graph for this function:

removed() [2/2]

template<typename device_t >

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

inlineprotectedvirtualnoexceptinherited

notify specific device removal stub

Reimplemented in dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >.

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) >::shutdown ( )

inlinevirtualinherited

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

Member Data Documentation

connection_id

template<class device_t >

constexpr auto dx::virtuel::driver< device_t >::connection_id = class_name

staticconstexpr

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) >::log

inherited

map

template<typename device_t >

dx_catchall_handler (this,) public typedef std::map<device_id_t, std::shared_ptr<device_t> > dx::map::driver< device_t >::map

protectedinherited

matching_ids

template<class device_t >

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

protected

product_id

const char* dx::driver< decltype(device_t::id) >::product_id

inherited

version

uint32_t dx::driver< decltype(device_t::id) >::version

inherited

---

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

• dx_virtual_driver.h