dx::asio::client::driver< device_t, devices > Class Template Reference

ASIO client driver interface class. More...

#include <dx_asio_client_driver.h>

Inheritance diagram for dx::asio::client::driver< device_t, devices >:

Collaboration diagram for dx::asio::client::driver< device_t, devices >:

Classes
struct	property

Public Types
typedef std::conditional_t< held, typename view::template iterator< typename holders::const_iterator >, typename holders::const_iterator >	const_iterator
typedef std::conditional_t< held, typename view::template iterator< typename holders::iterator >, typename holders::iterator >	iterator
typedef driver	map
typedef decltype(matching_ids)	match
typedef driver_settings< dx::promoted< dx::log >::preference< preference_t > >	settings
typedef std::conditional_t< held, typename view::value_type, typename holders::value_type >	value_type

Public Member Functions
const_iterator	begin () const noexcept
iterator	begin () noexcept
virtual bool	boot ()
void	conclude () noexcept override
	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. Called only through try_conclude() - never call this directly from outside the class hierarchy.
	driver (const match &matching_ids, const char *product_id, const decltype(super::preference)&preference, dx::log log={})
	the ASIO client driver interface class constructor
	driver (const match &matching_ids, const char *product_id, dx::log log={})
const_iterator	end () const noexcept
iterator	end () noexcept
void	exception (const class exception &exception, bool filtered=false) const noexcept override
	notification exception handler
virtual void	exception (const exception &exception, bool filtered=false) const noexcept=0
	notification exception handler
iterator	find (const device_id_t &device_id)
const_iterator	find (const device_id_t &device_id) const
void	info (std::ostream &os) noexcept override
	log object class information
void	launch () override
	launch notification: object mounted and ready to use. Called only through try_launch() - never call this directly from outside the class hierarchy.
virtual	operator bool () const noexcept
virtual driver &	operator<< (const char *file)
virtual driver &	operator<< (std::ifstream &)
	restores device settings
virtual driver &	operator>> (const char *file) const
virtual driver &	operator>> (std::ostream &ostream) const
	saves device tree
virtual bool	shutdown ()
	client driver::shutdown/boot(): override to shutdown/boot host driver
bool	try_conclude () noexcept
	atomically conclude()s if currently launched; returns whether this call did it
bool	try_launch ()
	atomically launch()es if not already launched; returns whether this call did it

Public Attributes
promoted< uint32_t >	connection_id {1}
T	elements
	STL member.
K	keys
	STL member.
std::atomic< bool >	launched {}
dx::log	log {}
	cached local log level, mirrors settings::log
preference_t	preference
const char *	product_id
promoted< os_result >	status {driver_not_connected}
uint32_t	version {DX_VERSION32}

Protected Types
typedef decltype(device_t::id)	device_id_t
typedef std::map< device_id_t, std::shared_ptr< dx::apartment< device_t > > >	holders

Protected Member Functions
virtual void	add (const device_id_t &)=0
	adds a new device to the device list
void	add (const device_id_t &device_id) override
	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
virtual void	clear () noexcept
	replaces std::map::clear to call virtual notification methods
std::set< dx::guid >	matching_clsids () const
	the CLSIDs of the SOFTWARE\ASIO entries any match dictionary takes
virtual void	remove (const device_id_t &)=0
	finds and removes a device from the device list
void	remove (const device_id_t &device_id) override
	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 ()
void	sleep () override
	< notify system will sleep
void	wake () override

Static Protected Member Functions
static uint32_t	thunk_idx (callbacks *callbacks)

Protected Attributes
registry	asio {asio::property::root, HKEY_LOCAL_MACHINE, KEY_NOTIFY, {[this](){scan();}}}
std::optional<::AsioDriverList >	list
	the SDK's view of SOFTWARE\ASIO, taken anew by every scan: a driver registers with its device
std::vector< asio::dictionary >	matching_ids

Static Protected Attributes
static auto	thunks

Detailed Description

template<class device_t, size_t devices = 100>
class dx::asio::client::driver< device_t, devices >

ASIO client driver interface class.

This is the interface to a ASIO client driver identified by a set of matching dx::guid IDs. The driver class is a helper to create device objects and to bind the device to the driver identified by the set of matching dictionaries.

device arrival/removal is initiated by launch/conclude at driver start/end and as registry notification. Therefor manipulating the device std::deque needs to be locked.

Exceptions

in	case of an error returned by the underlaying API the driver class throws a dx::exception.

Member Typedef Documentation

const_iterator

typedef std::conditional_t<held, typename view::template iterator<typename holders::const_iterator>, typename holders::const_iterator> dx::map::driver< device_t, dx::apartment< device_t > >::const_iterator

inherited

device_id_t

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

protectedinherited

holders

typedef std::map<device_id_t, std::shared_ptr<dx::apartment< device_t >> > dx::map::driver< device_t, dx::apartment< device_t > >::holders

protectedinherited

iterator

typedef std::conditional_t<held, typename view::template iterator<typename holders::iterator>, typename holders::iterator> dx::map::driver< device_t, dx::apartment< device_t > >::iterator

inherited

map

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

inherited

match

template<class device_t, size_t devices = 100>

typedef decltype(matching_ids) dx::asio::client::driver< device_t, devices >::match

settings

template<typename device_id_t, typename preference_t>

typedef driver_settings<dx::promoted<dx::log>::preference<preference_t> > dx::driver< device_id_t, preference_t >::settings

inherited

the driver's own settings: the log a promoted::preference on the store's dx::log::id node, resolved like a stream desc (dx::log's DX_TREE_SERIALIZE), the constructor's log its default - stored as no entry, reloaded on the store's change

value_type

typedef std::conditional_t<held, typename view::value_type, typename holders::value_type> dx::map::driver< device_t, dx::apartment< device_t > >::value_type

inherited

Constructor & Destructor Documentation

driver() [1/2]

template<class device_t, size_t devices = 100>

dx::asio::client::driver< device_t, devices >::driver ( const match & matching_ids, const char * product_id, const decltype(super::preference)& preference, dx::log log = {} )

inline

the ASIO client driver interface class constructor

Parameters

matching_ids	the matching dictionaries identifying the driver interface
product_id	ASIO client driver ID
preference	preference
log	log settings

driver() [2/2]

template<class device_t, size_t devices = 100>

dx::asio::client::driver< device_t, devices >::driver ( const match & matching_ids, const char * product_id, dx::log log = {} )

inline

Member Function Documentation

add() [1/2]

template<typename device_id_t, typename preference_t>

virtual void dx::driver< device_id_t, preference_t >::add ( const device_id_t & )

protectedpure virtualinherited

adds a new device to the device list

Exceptions

dx::exception

add() [2/2]

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

inlineoverrideprotectedinherited

adds a new device to the device list

Exceptions

dx::exception

Here is the caller graph for this function:

arrived() [1/2]

( )	protectedvirtualinherited

notify device arrivals completed stub

Reimplemented from dx::driver< device_id_t, preference_t >.

arrived() [2/2]

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

inlineprotectedvirtualinherited

notify specific device arrival stub

Here is the caller graph for this function:

begin() [1/2]

const_iterator dx::map::driver< device_t, dx::apartment< device_t > >::begin ( ) const

inlinenoexceptinherited

begin() [2/2]

iterator dx::map::driver< device_t, dx::apartment< device_t > >::begin ( )

inlinenoexceptinherited

boot()

template<typename device_id_t, typename preference_t>

virtual bool dx::driver< device_id_t, preference_t >::boot ( )

inlinevirtualinherited

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

Here is the caller graph for this function:

clear()

virtual void dx::map::driver< device_t, dx::apartment< device_t > >::clear ( )

inlineprotectedvirtualnoexceptinherited

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

conclude()

void dx::map::driver< device_t, dx::apartment< device_t > >::conclude ( )

inlineoverridevirtualnoexceptinherited

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. Called only through try_conclude() - never call this directly from outside the class hierarchy.

Reimplemented from dx::object.

end() [1/2]

const_iterator dx::map::driver< device_t, dx::apartment< device_t > >::end ( ) const

inlinenoexceptinherited

end() [2/2]

iterator dx::map::driver< device_t, dx::apartment< device_t > >::end ( )

inlinenoexceptinherited

exception() [1/2]

template<typename device_id_t, typename preference_t>

void dx::driver< device_id_t, preference_t >::exception ( const class exception & exception, bool filtered = false ) const

inlineoverridenoexceptinherited

notification exception handler

Here is the caller graph for this function:

exception() [2/2]

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

pure virtualnoexceptinherited

notification exception handler

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

Here is the call graph for this function:

Here is the caller graph for this function:

find() [1/2]

iterator dx::map::driver< device_t, dx::apartment< device_t > >::find ( const device_id_t & device_id )

inlineinherited

Here is the caller graph for this function:

find() [2/2]

const_iterator dx::map::driver< device_t, dx::apartment< device_t > >::find ( const device_id_t & device_id ) const

inlineinherited

info()

template<class device_t, size_t devices = 100>

void dx::asio::client::driver< device_t, devices >::info ( std::ostream & os )

inlineoverridevirtualnoexcept

log object class information

Reimplemented from dx::object.

Here is the call graph for this function:

launch()

template<class device_t, size_t devices = 100>

void dx::asio::client::driver< device_t, devices >::launch ( )

inlineoverridevirtual

launch notification: object mounted and ready to use. Called only through try_launch() - never call this directly from outside the class hierarchy.

Reimplemented from dx::object.

Here is the call graph for this function:

matching_clsids()

template<class device_t, size_t devices = 100>

std::set< dx::guid > dx::asio::client::driver< device_t, devices >::matching_clsids ( ) const

inlineprotected

the CLSIDs of the SOFTWARE\ASIO entries any match dictionary takes

Here is the caller graph for this function:

operator bool()

template<class device_t, size_t devices = 100>

virtual dx::asio::client::driver< device_t, devices >::operator bool ( ) const

inlinevirtualnoexcept

operator<<() [1/2]

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

inlinevirtualinherited

operator<<() [2/2]

virtual driver & dx::map::driver< device_t, dx::apartment< device_t > >::operator<< ( std::ifstream & )

inlinevirtualinherited

restores device settings

operator>>() [1/2]

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

inlinevirtualinherited

operator>>() [2/2]

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

inlinevirtualinherited

saves device tree

remove() [1/2]

template<typename device_id_t, typename preference_t>

virtual void dx::driver< device_id_t, preference_t >::remove ( const device_id_t & )

protectedpure virtualinherited

finds and removes a device from the device list

remove() [2/2]

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

inlineoverrideprotectedinherited

finds and removes a device from the device list

Exceptions

dx::exception

Here is the caller graph for this function:

removed() [1/2]

( )	protectedvirtualinherited

notify device removals completed stub

Reimplemented from dx::driver< device_id_t, preference_t >.

removed() [2/2]

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

inlineprotectedvirtualnoexceptinherited

notify specific device removal stub

Here is the caller graph for this function:

scan()

template<class device_t, size_t devices = 100>

virtual void dx::asio::client::driver< device_t, devices >::scan ( )

inlineprotectedvirtual

Here is the call graph for this function:

Here is the caller graph for this function:

shutdown()

template<typename device_id_t, typename preference_t>

virtual bool dx::driver< device_id_t, preference_t >::shutdown ( )

inlinevirtualinherited

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

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

Here is the caller graph for this function:

sleep()

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

inlineoverrideprotectedinherited

< notify system will sleep

notify system wake completed stub

thunk_idx()

template<class device_t, size_t devices = 100>

uint32_t dx::asio::client::driver< device_t, devices >::thunk_idx ( callbacks * callbacks )

inlinestaticprotected

Here is the call graph for this function:

Here is the caller graph for this function:

try_conclude()

bool dx::object::try_conclude ( )

inlinenoexceptinherited

atomically conclude()s if currently launched; returns whether this call did it

Here is the call graph for this function:

Here is the caller graph for this function:

try_launch()

bool dx::object::try_launch ( )

inlineinherited

atomically launch()es if not already launched; returns whether this call did it

Here is the call graph for this function:

Here is the caller graph for this function:

wake()

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

inlineoverrideprotectedinherited

Member Data Documentation

asio

template<class device_t, size_t devices = 100>

registry dx::asio::client::driver< device_t, devices >::asio {asio::property::root, HKEY_LOCAL_MACHINE, KEY_NOTIFY, {[this](){scan();}}}

protected

connection_id

template<class device_t, size_t devices = 100>

promoted<uint32_t> dx::asio::client::driver< device_t, devices >::connection_id {1}

elements

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

inherited

STL member.

keys

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

inherited

STL member.

launched

std::atomic<bool> dx::object::launched {}

inherited

list

template<class device_t, size_t devices = 100>

std::optional<::AsioDriverList> dx::asio::client::driver< device_t, devices >::list

protected

the SDK's view of SOFTWARE\ASIO, taken anew by every scan: a driver registers with its device

log

template<typename device_id_t, typename preference_t>

dx::log dx::driver< device_id_t, preference_t >::log {}

inherited

cached local log level, mirrors settings::log

matching_ids

template<class device_t, size_t devices = 100>

std::vector<asio::dictionary> dx::asio::client::driver< device_t, devices >::matching_ids

protected

preference

template<typename device_id_t, typename preference_t>

preference_t dx::driver< device_id_t, preference_t >::preference

inherited

product_id

template<typename device_id_t, typename preference_t>

const char* dx::driver< device_id_t, preference_t >::product_id

inherited

status

template<typename device_id_t, typename preference_t>

promoted<os_result> dx::driver< device_id_t, preference_t >::status {driver_not_connected}

inherited

thunks

template<class device_t, size_t devices = 100>

auto dx::asio::client::driver< device_t, devices >::thunks

inlinestaticprotected

Initial value:

                     = []<size_t... index_sequence>(std::index_sequence<index_sequence...>){
    return std::array<std::pair<::ASIOCallbacks, std::atomic<callbacks*>>, sizeof...(index_sequence)>{{
        {::ASIOCallbacks{
            .bufferSwitch= &thunk<index_sequence>::bufferSwitch,
            .sampleRateDidChange= &thunk<index_sequence>::sampleRateDidChange,
            .asioMessage= &thunk<index_sequence>::asioMessage,
            .bufferSwitchTimeInfo= &thunk<index_sequence>::bufferSwitchTimeInfo}, nullptr} ...}};
}(std::make_index_sequence<devices>{})

version

template<typename device_id_t, typename preference_t>

uint32_t dx::driver< device_id_t, preference_t >::version {DX_VERSION32}

inherited

---

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

• dx_asio_client_driver.h