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 Member Functions
virtual void	conclude () noexcept
	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.
virtual void	exception (const exception &exception, bool filtered=false) const noexcept=0
	notification exception handler
virtual void	launch ()
	launch notification: object mounted and ready to use
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 {}
decltype(device_t::preference)	preference
const char *	product_id
uint32_t	version

Protected Types
typedef decltype(device_t::id)	device_id_t

Protected Member Functions
	_Pragma ("clang diagnostic pop") driver(const match &matching_ids
	the virtual driver interface class constructor
	_Pragma ("clang diagnostic pop") void launch() override try
	_Pragma ("clang diagnostic push") _Pragma("clang diagnostic ignored \"-Wreturn-type\"") catch(const dx
	_Pragma ("clang diagnostic push") _Pragma("clang diagnostic ignored \"-Wreturn-type\"") catch(const dx
	_Pragma ("clang diagnostic push") _Pragma("clang diagnostic ignored \"-Wreturn-type\"") catch(const dx
	_Pragma ("clang diagnostic push") _Pragma("clang diagnostic ignored \"-Wreturn-type\"") catch(const dx
void	add (const device_id_t &device_id) override try
	adds a new device to the device list
void	add (const std::string &device_id, const typename device_t::desc_t &desc) try
virtual void	arrived ()
	notify device arrivals completed stub
virtual void	arrived (device_t &)
	notify specific device arrival stub
	catch (...)
	catch (...)
	catch (...)
	catch (...)
	catch (const std::exception &__std_exception)
	catch (const std::exception &__std_exception)
	catch (const std::exception &__std_exception)
	catch (const std::exception &__std_exception)
	dx_catchall_handler (this,) virtual driver &operator<<(std
	restores device settings
void	info (std::ostream &os) noexcept override
	log object class information
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
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 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
const char *	id
	<the matching virtual driver IDs identifying the driver interface
const char dx::log	log
	log settings
_Pragma("clang diagnostic pop") public typedef decltype(matching_ids)	match
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

Member Function Documentation

_Pragma() [1/6]

template<class device_t >

dx::virtuel::driver< device_t >::_Pragma ( "clang diagnostic pop" ) const &

protected

the virtual driver interface class constructor

_Pragma() [2/6]

template<class device_t >

dx::virtuel::driver< device_t >::_Pragma ( "clang diagnostic pop" )

inlineoverrideprotected

Todo

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

_Pragma() [3/6]

template<class device_t >

dx::virtuel::driver< device_t >::_Pragma ( "clang diagnostic push" ) const

inlineprotected

_Pragma() [4/6]

template<class device_t >

dx::virtuel::driver< device_t >::_Pragma ( "clang diagnostic push" ) const

inlineprotected

_Pragma() [5/6]

template<class device_t >

dx::virtuel::driver< device_t >::_Pragma ( "clang diagnostic push" ) const

inlineprotected

_Pragma() [6/6]

template<class device_t >

dx::virtuel::driver< device_t >::_Pragma ( "clang diagnostic push" ) const

inlineprotected

Here is the call graph for this function:

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 )

inlineprotected

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, 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< 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::test::driver< super_device_t, audio_pin_t, io_t, device_t, driver_t, engine_t >, 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 >.

catch() [1/8]

template<class device_t >

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

inlineprotected

catch() [2/8]

template<class device_t >

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

inlineprotected

catch() [3/8]

template<class device_t >

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

inlineprotected

catch() [4/8]

template<class device_t >

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

inlineprotected

catch() [5/8]

template<class device_t >

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

inlineprotected

catch() [6/8]

template<class device_t >

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

inlineprotected

catch() [7/8]

template<class device_t >

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

inlineprotected

catch() [8/8]

template<class device_t >

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

inlineprotected

conclude()

virtual void dx::object::conclude ( )

inlinevirtualnoexceptinherited

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 in dx::proxy::stream::_device< desc_t, preference_t, stream_t >, 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 >, 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 >, dx::usb::pipe< device_t >, dx::virtuel::stream::_device< desc_t, preference_t, stream_t >, dx::proxy::device< dx::preference >, dx::proxy::device<>, and dx::proxy::device< preference_t >.

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

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<::MIDIDeviceRef, cf::preference >, dx::device<::MIDIDeviceRef, preference_t >, dx::device< id_t, preference_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<>, and dx::proxy::device< preference_t >.

Here is the caller graph for this function:

info()

template<typename device_t >

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

inlineoverrideprotectedvirtualnoexceptinherited

log object class information

Reimplemented from dx::object.

Reimplemented in dx::test::driver< super_device_t, audio_pin_t, io_t, device_t, driver_t, engine_t >.

Here is the call graph for this function:

Here is the caller graph for this function:

launch()

virtual void dx::object::launch ( )

inlinevirtualinherited

launch notification: object mounted and ready to use

Reimplemented in dx::asio::client::driver< device_t >, dx::usb::stream::_device< desc_t, preference_t, stream_t >, dx::coremidi::server::plugin< stream_pin_t, device_t, driver_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::asio::client::_device< desc_t, preference_t, stream_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:

operator<<()

template<typename device_t >

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

inlineprotectedvirtualinherited

Here is the call graph for this function:

Here is the caller graph for this function:

operator>>() [1/2]

template<typename device_t >

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

inlineprotectedvirtualinherited

Here is the call graph for this function:

operator>>() [2/2]

template<typename device_t >

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

inlineprotectedvirtualinherited

saves device tree

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

Here is the caller graph for this function:

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]

template<class device_t >

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

inlineprotected

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, preference_t >::removed ( )

inlineprotectedvirtualnoexceptinherited

notify device removals completed stub

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

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 >, and dx::test::driver< super_device_t, audio_pin_t, io_t, device_t, driver_t, engine_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) , decltype(device_t::preference) >::shutdown ( )

inlinevirtualinherited

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

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

sleep()

template<typename device_t >

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

inlineoverrideprotectedinherited

< notify system will sleep

notify system wake completed stub

Here is the call graph for this function:

wake()

template<typename device_t >

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

inlineoverrideprotectedinherited

Here is the call graph for this function:

Member Data Documentation

elements

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

inherited

STL member.

id

template<class device_t >

const char* dx::virtuel::driver< device_t >::id

protected

<the matching virtual driver IDs identifying the driver interface

virtual driver ID

keys

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

inherited

STL member.

launched

bool dx::object::launched {}

inherited

log

template<class device_t >

const char dx::log dx::virtuel::driver< device_t >::log

protected

Initial value:

={}
        ):
        super{id, log},
        matching_ids{matching_ids}{
    }
 
    static constexpr auto connection_id= class_name

log settings

match

template<class device_t >

_Pragma ("clang diagnostic pop") public typedef decltype(matching_ids) dx::virtuel::driver< device_t >::match

protected

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