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

#include <dx_proxy_driver.h>

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

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

Classes
struct	notification
class	setup

Public Types
typedef decltype(matching_ids)	match
typedef decltype(matching_ids)	match

Public Member Functions
dx_catchall_rethrow() using super void	add (const std::string &id, const typename device_t::desc &)
virtual bool	boot () try
	driver (const match &matching_ids, const char *id, dx::log log={})
	the virtual driver interface class constructor
	driver (const match &matching_ids, const char *id, dx::log log={})
	the driver interface class constructor
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
virtual void	info (std::ostream &os) noexcept
	log object class information
void	launch () override try
	launch notification: object mounted and ready to use
virtual void	launch () try
	launch notification: object mounted and ready to use
dx_catchall_rethrow() using super void	remove (const std::string &id)
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 {}
const log	log
const char *	product_id
io::registry	registry
std::deque< setup >	setup
uint32_t	version

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

Protected Attributes
dx_catchall_handler(this,) public typedef std::map< device_id_t, std::shared_ptr< device_t > >	map
std::vector<::GUID >	matching_ids
struct dx::proxy::driver::notification	notification

Member Typedef Documentation

match [1/2]

template<class device_t = device>

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

match [2/2]

template<class device_t = device>

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

Constructor & Destructor Documentation

driver() [1/2]

template<class device_t = device>

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

inline

the virtual driver interface class constructor

checks if kext is installed at all

Parameters

matching_ids	the matching device IDs identifying the OS driver interface
id	driver ID
log	log settings

driver() [2/2]

template<class device_t = device>

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

inline

the driver interface class constructor

Parameters

matching_ids	the matching device IDs identifying the OS driver interface
id	driver ID
log	log settings

Member Function Documentation

add() [1/2]

template<typename device_t >

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

inlineoverrideprotectedvirtualinherited

adds a new device to the device list

Exceptions

dx::exception

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

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

Here is the call graph for this function:

add() [2/2]

template<class device_t = device>

dx_catchall_rethrow() using super void dx::proxy::driver< device_t >::add ( const std::string & id, const typename device_t::desc &  )

inline

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/12]

template<typename device_t >

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

inlineprotectedinherited

catch() [2/12]

template<typename device_t >

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

inlineprotectedinherited

catch() [3/12]

template<typename device_t >

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

inlineprotectedinherited

catch() [4/12]

template<typename device_t >

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

inlineprotectedinherited

catch() [5/12]

template<typename device_t >

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

inlineprotectedinherited

catch() [6/12]

template<typename device_t >

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

inlineprotectedinherited

catch() [7/12]

template<typename device_t >

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

inlineprotectedinherited

catch() [8/12]

template<typename device_t >

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

inlineprotectedinherited

catch() [9/12]

template<typename device_t >

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

inlineprotectedinherited

catch() [10/12]

template<typename device_t >

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

inlineprotectedinherited

catch() [11/12]

template<typename device_t >

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

inlineprotectedinherited

catch() [12/12]

template<typename device_t >

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

inlineprotectedinherited

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:

exception() [1/2]

void dx::driver< decltype(device_t::id) >::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< 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:

info()

virtual void dx::object::info ( std::ostream & os )

inlinevirtualnoexceptinherited

log object class information

Reimplemented in dx::device< std::string >, dx::device<::AudioObjectID >, dx::device<::io_service_t >, dx::device< id_t >, 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::usb::pipe< device_t >, dx::usb::stream::_device< desc_t, preference_t, stream_t >, dx::virtuel::driver< device_t >, dx::virtuel::stream::_device< desc_t, preference_t, stream_t >, dx::coreaudio::pod::device< desc_t, preference_t, stream_t >, dx::proxy::device, dx::usb::platform::device, dx::proxy::device, dx::stream::object< _device_t >, dx::stream::object< device >, dx::stream::object< device_t >, dx::stream::control< dx::device< std::string > >, dx::stream::control< dx::device<::AudioObjectID > >, dx::stream::control< dx::proxy::device >, dx::stream::control< dx::stream::object< device > >, dx::stream::control< dx::stream::object< device_t > >, dx::stream::control< object< device_t > >, dx::stream::control< stream::object< device > >, dx::stream::control< stream::object< device_t > >, dx::stream::control< usb::device >, dx::stream::device< dx::stream::control< dx::device< std::string > >, desc, dx::preference, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >, dx::stream::device< dx::stream::control< dx::device< std::string > >, desc_t, preference_t, stream_t >, dx::stream::device< dx::stream::control< dx::device<::AudioObjectID > >, desc_t, preference_t, stream_t >, dx::stream::device< dx::stream::control< dx::device<::AudioObjectID > >, dx::virtuel::stream::desc, cf::preference, dx::stream::stream< device< dx::virtuel::stream::desc, cf::preference, dx::stream::stream > > >, dx::stream::device< dx::stream::control< dx::device<::AudioObjectID > >, dx::virtuel::stream::desc, cf::preference, stream< device< dx::virtuel::stream::desc, cf::preference, stream > > >, dx::stream::device< dx::stream::control< dx::proxy::device >, desc_t, preference_t, stream_t >, dx::stream::device< dx::stream::control< dx::proxy::device >, dx::stream::desc<>, dx::preference, stream< device< dx::stream::desc<>, dx::preference, stream > > >, dx::stream::device< dx::stream::control< usb::device >, desc_t, dx::preference, pipe< device< desc_t, dx::preference, pipe > > >, dx::stream::device< dx::stream::control< usb::device >, desc_t, preference_t, stream_t >, dx::stream::pin< device_t, _circular_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::test::driver< super_device_t, audio_pin_t, int32_t, dx::test::device< super_device_t >, dx::proxy::driver< dx::test::device< super_device_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::test::driver< super_device_t, audio_pin_t, int32_t, dx::test::device< super_device_t >, dx::virtuel::driver< dx::test::device< super_device_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::test::driver< super_device_t, audio_pin_t, int32_t, dx::test::midi::device< super_device_t >, dx::proxy::driver< dx::test::midi::device< super_device_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::test::driver< super_device_t, audio_pin_t, io_t, device_t, driver_t, engine_t >, and dx::test::usb::driver< super_device_t, audio_pin_t, io_t, device_t, driver_t, engine_t >.

Here is the caller graph for this function:

launch() [1/2]

template<class device_t = device>

void dx::proxy::driver< device_t >::launch ( )

inlineoverridevirtual

launch notification: object mounted and ready to use

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

Here is the call graph for this function:

Here is the caller graph for this function:

launch() [2/2]

template<class device_t = device>

virtual void dx::proxy::driver< device_t >::launch ( )

inlinevirtual

launch notification: object mounted and ready to use

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

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 = device>

dx_catchall_rethrow() using super void dx::proxy::driver< device_t >::remove ( const std::string & id )

inline

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 >.

shutdown()

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

inlinevirtualinherited

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

Member Data Documentation

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

const 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 = device>

std::vector<::GUID> dx::proxy::driver< device_t >::matching_ids

protected

notification

template<class device_t = device>

struct dx::proxy::driver::notification dx::proxy::driver< device_t >::notification

protected

product_id

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

inherited

registry

template<class device_t = device>

io::registry dx::proxy::driver< device_t >::registry

setup

template<class device_t = device>

std::deque<setup> dx::proxy::driver< device_t >::setup

version

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

inherited

---

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

• macOS/dx_proxy_driver.h
• windows/dx_proxy_driver.h