dx::driver< device_id_t, preference_t > Class Template Reference

abstract base driver interface class This is the abstract base interface to a driver. More...

#include <dx_driver.h>

Inheritance diagram for dx::driver< device_id_t, preference_t >:

Collaboration diagram for dx::driver< device_id_t, preference_t >:

Classes
class	disconnect

Public Member Functions
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)
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.
	driver (const char *product_id, dx::log log)
	abstract 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
virtual void	info (std::ostream &os) noexcept
	log object class information
virtual void	launch ()
	launch notification: object mounted and ready to use
virtual dx::log	operator= (const dx::log &log)
virtual bool	shutdown () try
	client driver::shutdown/boot(): override to shutdown/boot host driver
	~driver () noexcept override

Public Attributes
bool	launched {}
log	log {}
preference_t	preference {product_id}
const char *	product_id
uint32_t	version = DX_VERSION32

Protected Member Functions
virtual void	add (const device_id_t &)=0
	adds a new device to the device list
virtual void	arrived ()
	notify device arrivals completed stub
virtual void	remove (const device_id_t &)=0
	finds and removes a device from the device list
virtual void	removed () noexcept
	notify device removals completed stub

Detailed Description

template<typename device_id_t, typename preference_t>
class dx::driver< device_id_t, preference_t >

abstract base driver interface class This is the abstract base interface to a driver.

Exceptions

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

Constructor & Destructor Documentation

driver()

template<typename device_id_t , typename preference_t >

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

inline

abstract driver interface class constructor

Parameters

product_id	driver ID
log	log settings

~driver()

template<typename device_id_t , typename preference_t >

dx::driver< device_id_t, preference_t >::~driver ( )

inlineoverridenoexcept

Here is the call graph for this function:

Member Function Documentation

add()

template<typename device_id_t , typename preference_t >

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

protectedpure virtual

adds a new device to the device list

Exceptions

dx::exception

Implemented in dx::map::driver< device<> >, dx::map::driver< device_t >, dx::virtuel::driver< device_t >, dx::asio::client::driver< device_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 >.

arrived()

template<typename device_id_t , typename preference_t >

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

inlineprotectedvirtual

notify device arrivals completed stub

Reimplemented in dx::map::driver< device<> >, dx::map::driver< device_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 >, 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 >.

boot()

template<typename device_id_t , typename preference_t >

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

inlinevirtual

Here is the call graph for this function:

Here is the caller graph for this function:

catch() [1/6]

template<typename device_id_t , typename preference_t >

dx::driver< device_id_t, preference_t >::catch ( ... )

inline

catch() [2/6]

template<typename device_id_t , typename preference_t >

dx::driver< device_id_t, preference_t >::catch ( ... )

inline

catch() [3/6]

template<typename device_id_t , typename preference_t >

dx::driver< device_id_t, preference_t >::catch ( const dx::exception & __dx_exception )

inline

catch() [4/6]

template<typename device_id_t , typename preference_t >

dx::driver< device_id_t, preference_t >::catch ( const dx::exception & __dx_exception )

inline

catch() [5/6]

template<typename device_id_t , typename preference_t >

dx::driver< device_id_t, preference_t >::catch ( const std::exception & __std_exception )

inline

catch() [6/6]

template<typename device_id_t , typename preference_t >

dx::driver< device_id_t, preference_t >::catch ( const std::exception & __std_exception )

inline

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

Here is the caller graph for this function:

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 )

inlineoverridenoexcept

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 )

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::stream::pin< device_t, _circular_t >, dx::virtuel::stream::_device< desc_t, preference_t, stream_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()

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

inlinevirtualnoexceptinherited

log object class information

Reimplemented 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::map::driver< device<> >, dx::map::driver< device_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::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::_device< desc_t, preference_t, stream_t >, dx::coreaudio::pod::device< desc_t, preference_t, stream_t >, dx::coreaudio::stream::device< desc_t, preference_t, stream_t >, dx::coremidi::_device< desc_t, preference_t, stream_t >, dx::usb::platform::device< preference_t >, dx::asio::client::_device< desc_t, preference_t, stream_t >, dx::asio::client::driver< device_t >, dx::proxy::device< dx::preference >, dx::proxy::device<>, dx::proxy::device< preference_t >, dx::stream::object< _device_t >, dx::stream::object< device<> >, dx::stream::object< device_t >, dx::stream::control< dx::device< dx::guid, dx::preference > >, dx::stream::control< dx::device< dx::guid, preference_t > >, dx::stream::control< dx::device< std::string, preference_t > >, dx::stream::control< dx::device<::AudioObjectID, cf::preference > >, dx::stream::control< dx::device<::AudioObjectID, preference_t > >, dx::stream::control< dx::device<::MIDIDeviceRef, cf::preference > >, dx::stream::control< dx::device<::MIDIDeviceRef, preference_t > >, dx::stream::control< dx::proxy::device< dx::preference > >, dx::stream::control< dx::proxy::device< preference_t > >, 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::preference > >, dx::stream::control< usb::device< preference_t > >, dx::stream::device< dx::stream::control< dx::device< dx::guid, dx::preference > >, desc, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >, dx::stream::device< dx::stream::control< dx::device< dx::guid, preference_t > >, desc_t, stream_t >, dx::stream::device< dx::stream::control< dx::device< std::string, preference_t > >, desc_t, stream_t >, dx::stream::device< dx::stream::control< dx::device<::AudioObjectID, cf::preference > >, dx::virtuel::stream::desc, dx::stream::stream< device< dx::virtuel::stream::desc, cf::preference, dx::stream::stream > > >, dx::stream::device< dx::stream::control< dx::device<::AudioObjectID, cf::preference > >, dx::virtuel::stream::desc, stream< device< dx::virtuel::stream::desc, cf::preference, stream > > >, dx::stream::device< dx::stream::control< dx::device<::AudioObjectID, preference_t > >, desc_t, stream_t >, dx::stream::device< dx::stream::control< dx::device<::MIDIDeviceRef, cf::preference > >, desc, stream< device< desc, cf::preference, stream > > >, dx::stream::device< dx::stream::control< dx::device<::MIDIDeviceRef, preference_t > >, desc_t, stream_t >, dx::stream::device< dx::stream::control< dx::proxy::device< dx::preference > >, dx::stream::desc<>, stream< device< dx::stream::desc<>, dx::preference, stream > > >, dx::stream::device< dx::stream::control< dx::proxy::device< preference_t > >, desc_t, stream_t >, dx::stream::device< dx::stream::control< usb::device< dx::preference > >, desc_t, pipe< device< desc_t, dx::preference, pipe > > >, dx::stream::device< dx::stream::control< usb::device< preference_t > >, desc_t, stream_t >, dx::stream::pin< device_t, _circular_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()

virtual void dx::object::launch ( )

inlinevirtualinherited

launch notification: object mounted and ready to use

Reimplemented in dx::asio::client::driver< device_t >, dx::map::driver< device<> >, dx::map::driver< device_t >, dx::usb::stream::_device< desc_t, preference_t, stream_t >, dx::virtuel::driver< device_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_id_t , typename preference_t >

virtual dx::log dx::driver< device_id_t, preference_t >::operator= ( const dx::log & log )

inlinevirtual

Reimplemented in dx::map::driver< device<> >, dx::map::driver< device_t >, and dx::coreaudio::driver< device_t >.

Here is the caller graph for this function:

remove()

template<typename device_id_t , typename preference_t >

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

protectedpure virtual

finds and removes a device from the device list

Implemented in dx::map::driver< device<> >, and dx::map::driver< device_t >.

removed()

template<typename device_id_t , typename preference_t >

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

inlineprotectedvirtualnoexcept

notify device removals completed stub

Reimplemented in dx::map::driver< device<> >, and dx::map::driver< device_t >.

shutdown()

template<typename device_id_t , typename preference_t >

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

inlinevirtual

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

launched

bool dx::object::launched {}

inherited

log

template<typename device_id_t , typename preference_t >

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

preference

template<typename device_id_t , typename preference_t >

preference_t dx::driver< device_id_t, preference_t >::preference {product_id}

product_id

template<typename device_id_t , typename preference_t >

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

version

template<typename device_id_t , typename preference_t >

uint32_t dx::driver< device_id_t, preference_t >::version = DX_VERSION32

---

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

• dx_driver.h