#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
void	add (const device_id_t &device_id) override try

dx_catchall_rethrow() using super void	add (const std::string &, const typename device_t::desc_t &)

void	add (const std::string &, const typename device_t::desc_t &)

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

	dx_catchall_rethrow () virtual operator bool() const noexcept

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

virtual bool	shutdown () try
	client driver::shutdown/boot(): override to shutdown/boot host driver

Public Attributes
cf::type< const char * >	connection_id = ::IOObjectCopyBundleIdentifierForClass(cf::type<const char*>(this->product_id).retain())

T	elements
	STL member.

K	keys
	STL member.

bool	launched {}

log	log

const char *	product_id

io::registry	registry

std::deque< setup >	setup

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

	dx_catchall_handler (this,) virtual void operator<<(std
	restores device settings

void	info (std::ostream &os) noexcept override
	log object class information

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

◆ device_id_t

template<typename device_t >

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

protectedinherited

◆ 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

Todo: proxy::driver::connection_id: reflect driver presence

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

template<class device_t = device>

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

inlineoverridevirtual

Todo: proxy::driver::operator bool() check if driver is installed

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

◆ add() [2/3]

template<class device_t = device>

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

inline

Here is the caller graph for this function:

◆ add() [3/3]

template<class device_t = device>

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

inline

◆ 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:

◆ dx_catchall_handler()

template<typename device_t >

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

inlineprotectedinherited

restores device settings

◆ dx_catchall_rethrow()

template<class device_t = device>

dx::proxy::driver< device_t >::dx_catchall_rethrow ( ) const

inlinenoexcept

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 )

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<typename device_t >

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

inlineoverrideprotectedvirtualnoexceptinherited

log object class information

Reimplemented from dx::object.

Here is the call graph for this function:

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:

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

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

inline

◆ removed()

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

◆ connection_id [1/2]

template<class device_t = device>

cf::type<const char*> dx::proxy::driver< device_t >::connection_id = ::IOObjectCopyBundleIdentifierForClass(cf::type<const char*>(this->product_id).retain())

◆ connection_id [2/2]

template<class device_t = device>

constexpr auto dx::proxy::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 = 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:

Classes

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ device_id_t

◆ match [1/2]

◆ match [2/2]

Constructor & Destructor Documentation

◆ driver() [1/2]

◆ driver() [2/2]

Member Function Documentation

◆ add() [1/3]

◆ add() [2/3]

◆ add() [3/3]

◆ arrived() [1/2]

◆ arrived() [2/2]

◆ boot()

◆ catch() [1/12]

◆ catch() [2/12]

◆ catch() [3/12]

◆ catch() [4/12]

◆ catch() [5/12]

◆ catch() [6/12]

◆ catch() [7/12]

◆ catch() [8/12]

◆ catch() [9/12]

◆ catch() [10/12]

◆ catch() [11/12]

◆ catch() [12/12]

◆ clear()

◆ conclude()

◆ dx_catchall_handler()

◆ dx_catchall_rethrow()

◆ exception() [1/2]

◆ exception() [2/2]

◆ info()

◆ launch() [1/2]

◆ launch() [2/2]

◆ operator>>()

◆ remove() [1/2]

◆ remove() [2/2]

◆ removed()

◆ shutdown()

Member Data Documentation

◆ connection_id [1/2]

◆ connection_id [2/2]

◆ elements

◆ keys

◆ launched

◆ log

◆ map

◆ matching_ids

◆ notification

◆ product_id

◆ registry

◆ setup

◆ version