dx::driver< device_t > Class Template Reference

#include <dx_driver.h>

Inheritance diagram for dx::driver< device_t >:

Collaboration diagram for dx::driver< device_t >:

Public Types
typedef decltype(matching_dictionaries)	match
typedef ::GUID	match

Public Member Functions
virtual void	conclude () noexcept
void	conclude () noexcept override
::CFStringRef	copy () const
	driver (const match &matching_dictionaries, const char *id, dx::log log=dx::log{{ .bus={ .setup=log::level::dflt,.operation=log::level::dflt,},.interface={ .setup=log::level::dflt,.operation=log::level::dflt}}})
	the driver interface class constructor
	dx_catchall () static void idle(int64_t nsec)
	dx_catchall () static void idle(uint64_t timeout) noexcept
virtual void	exception (const exception &exception, bool filtered=false) const noexcept try
	notification exception handler
virtual void	exception (const exception &exception, bool filtered=false) const noexcept try
	notification exception handler
device_t *	find (std::string uid) const noexcept
	Finds the device by guid. The user is responsible for making sure the device list cannot be modified during find().
CFTypeID	id () noexcept
CFTypeID	id () noexcept
CFTypeID	id () noexcept
CFTypeID	id () noexcept
CFTypeID	id () noexcept
CFTypeID	id () noexcept
CFTypeID	id () noexcept
CFTypeID	id () noexcept
CFTypeID	id () noexcept
CFTypeID	id () noexcept
reference &	initialize (cf_object_t cf_object, bool retain=true)
virtual void	launch ()
virtual void	launch ()
	operator bool () const noexcept
	operator cf_object_t () const noexcept
	operator const char * () const
	operator double () const noexcept
	Skips whitespace; returns 0.0 on error.
	operator int32_t () const noexcept
	Skips whitespace; returns 0 on error, MAX or -MAX on overflow.
	operator std::string () const
template<typename petty_t = cf_object_t, typename = typename std::enable_if_t <!std::is_same_v<petty_t, ::CFTypeRef>>>
	operator type<> () const noexcept
bool	operator!= (::CFStringRef value) const noexcept
bool	operator!= (cf_object_t cf_object) const noexcept
bool	operator!= (value_t value)
::CFMutableStringRef	operator+ (::CFStringRef value) const noexcept
::CFMutableStringRef	operator+ (const char *value) const noexcept
	operator::CFDataRef () const noexcept
	operator::CFTypeID () const noexcept
template<typename petty_t = cf_object_t, typename = typename std::enable_if_t <!std::is_same_v<petty_t, ::CFTypeRef>>>
	operator::CFTypeRef () const noexcept
bool	operator< (::CFStringRef value) const noexcept
bool	operator< (value_t value)
bool	operator<= (::CFStringRef value) const noexcept
bool	operator<= (value_t value)
bool	operator== (::CFStringRef value) const noexcept
bool	operator== (cf_object_t cf_object) const noexcept
bool	operator== (value_t value)
bool	operator> (::CFStringRef value) const noexcept
bool	operator> (value_t value)
bool	operator>= (::CFStringRef value) const noexcept
bool	operator>= (value_t value)
reference &	release () noexcept
reference &	retain () noexcept
virtual	~driver () noexcept
	~driver () noexcept override

Static Public Member Functions
::CFTypeID	id () noexcept

Public Attributes
::CFStringRef	cf_type_desc = nullptr
::CFStringRef	cf_type_id = nullptr
T	elements
	STL member.
bool	launched = false
log	log {}
dx::log	log {}
cf::preference	preference
dx::registry	preference
dx::generic::driver::setup	setup

Protected Member Functions
virtual void	arrived ()
	notify device arrivals completed stub
virtual void	arrived (device_t &)
	notify specific device arrival stub
void	clear () noexcept
	replaces std::deque::clear to call virtual notification methods
	operator::CFRunLoopSourceRef () const noexcept
	operator::IONotificationPortRef () const noexcept
	operator::mach_port_t () const noexcept
virtual void	removed () noexcept
	notify device removals completed stub
virtual void	removed (device_t &) noexcept
	notify specific device removal stub

Protected Attributes
cf_object_t	cf_object = nullptr

Member Typedef Documentation

match [1/2]

typedef decltype(matching_dictionaries) dx::generic::driver::match

inherited

match [2/2]

typedef ::GUID dx::generic::driver::match

inherited

Constructor & Destructor Documentation

driver()

template<class device_t = device>

dx::driver< device_t >::driver ( const match & matching_dictionaries, const char * id, dx::log log = dx::log{{ .bus={ .setup= log::level::dflt, .operation= log::level::dflt,}, .interface={ .setup= log::level::dflt, .operation= log::level::dflt}}} )

inline

the driver interface class constructor

Parameters

matching_dictionaries	the matching dictionary identifying the driver interface
id	drivers bundle ID

~driver() [1/2]

template<class device_t = device>

dx::driver< device_t >::~driver ( )

inlineoverridevirtualnoexcept

Reimplemented from dx::generic::driver.

Here is the call graph for this function:

~driver() [2/2]

template<class device_t = device>

virtual dx::driver< device_t >::~driver ( )

inlinevirtualnoexcept

Reimplemented from dx::generic::driver.

Here is the call graph for this function:

Member Function Documentation

arrived() [1/2]

template<class device_t = device>

virtual void dx::generic::driver::arrived ( )

inlineprotectedvirtual

notify device arrivals completed stub

Reimplemented from dx::generic::driver.

Reimplemented in dx::stream::engine< device_t, pin_t, io_t, circular_t, driver_t >, and dx::stream::engine< device< typename audio_pin_t::circular_t, super_device_t, typename midi_pin_t::circular_t >, audio_pin_t, int32_t, typename audio_pin_t::circular_t, dx::driver< device< typename audio_pin_t::circular_t, super_device_t, typename midi_pin_t::circular_t > > >.

arrived() [2/2]

template<class device_t = device>

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

inlineprotectedvirtual

notify specific device arrival stub

Reimplemented in dx::coreaudio::server::plugin< pin_t, device_t >, and dx::coremidi::server::plugin< stream_pin_t, device_t, driver_t >.

clear()

template<class device_t = device>

void dx::driver< device_t >::clear ( )

inlineprotectednoexcept

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

Todo

check if exception catching needed for device::conclude()

Here is the call graph for this function:

conclude() [1/2]

template<class device_t = device>

virtual void dx::driver< device_t >::conclude ( )

inlinevirtualnoexcept

Reimplemented from dx::generic::driver.

conclude() [2/2]

template<class device_t = device>

void dx::driver< device_t >::conclude ( )

inlineoverridevirtualnoexcept

Reimplemented from dx::generic::driver.

Here is the call graph for this function:

Here is the caller graph for this function:

copy()

::CFStringRef dx::cf::__string< ::CFStringRef >::copy ( ) const

inlineinherited

dx_catchall() [1/2]

dx::generic::driver::dx_catchall ( )

inlineinherited

Here is the caller graph for this function:

dx_catchall() [2/2]

dx::generic::driver::dx_catchall ( )

inlinenoexceptinherited

exception() [1/2]

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

inlinevirtualnoexceptinherited

notification exception handler

Reimplemented in dx::asio< device_t, pin_t >.

Here is the caller graph for this function:

exception() [2/2]

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

inlinevirtualnoexceptinherited

notification exception handler

Reimplemented in dx::asio< device_t, pin_t >.

find()

template<class device_t = device>

device_t * dx::driver< device_t >::find ( std::string uid ) const

inlinenoexcept

Finds the device by guid.
The user is responsible for making sure the device list cannot be modified during find().

Exceptions

n/a	this method does not throw exceptions

id() [1/11]

template<typename cf_object_t >

::CFTypeID dx::cf::reference< cf_object_t >::id ( )

staticnoexceptinherited

Here is the caller graph for this function:

id() [2/11]

CFTypeID dx::cf::reference<::CFDictionaryRef >::id ( )

inlinenoexceptinherited

id() [3/11]

CFTypeID dx::cf::reference<::CFMutableDictionaryRef >::id ( )

inlinenoexceptinherited

id() [4/11]

CFTypeID dx::cf::reference<::CFNumberRef >::id ( )

inlinenoexceptinherited

id() [5/11]

CFTypeID dx::cf::reference<::CFStringRef >::id ( )

inlinenoexceptinherited

id() [6/11]

CFTypeID dx::cf::reference<::CFArrayRef >::id ( )

inlinenoexceptinherited

id() [7/11]

CFTypeID dx::cf::reference<::CFURLRef >::id ( )

inlinenoexceptinherited

id() [8/11]

CFTypeID dx::cf::reference<::CFBundleRef >::id ( )

inlinenoexceptinherited

id() [9/11]

CFTypeID dx::cf::reference<::CFDataRef >::id ( )

inlinenoexceptinherited

id() [10/11]

CFTypeID dx::cf::reference<::CFUUIDRef >::id ( )

inlinenoexceptinherited

id() [11/11]

CFTypeID dx::cf::reference<::SCPreferencesRef >::id ( )

inlinenoexceptinherited

initialize()

template<typename cf_object_t >

reference & dx::cf::reference< cf_object_t >::initialize ( cf_object_t cf_object, bool retain = true )

inlineinherited

Here is the call graph for this function:

Here is the caller graph for this function:

launch() [1/2]

virtual void dx::generic::driver::launch ( )

inlinevirtualinherited

Here is the caller graph for this function:

launch() [2/2]

virtual void dx::generic::driver::launch ( )

inlinevirtualinherited

Here is the call graph for this function:

operator bool()

template<typename cf_object_t >

dx::cf::reference< cf_object_t >::operator bool ( ) const

inlinenoexceptinherited

operator cf_object_t()

template<typename cf_object_t >

dx::cf::reference< cf_object_t >::operator cf_object_t ( ) const

inlinenoexceptinherited

operator const char *()

dx::cf::__string< ::CFStringRef >::operator const char * ( ) const

inlineinherited

operator double()

dx::cf::__string< ::CFStringRef >::operator double ( ) const

inlinenoexceptinherited

Skips whitespace; returns 0.0 on error.

operator int32_t()

dx::cf::__string< ::CFStringRef >::operator int32_t ( ) const

inlinenoexceptinherited

Skips whitespace; returns 0 on error, MAX or -MAX on overflow.

operator std::string()

dx::cf::__string< ::CFStringRef >::operator std::string ( ) const

inlineinherited

operator type<>()

template<typename cf_object_t >

template<typename petty_t = cf_object_t, typename = typename std::enable_if_t <!std::is_same_v<petty_t, ::CFTypeRef>>>

dx::cf::reference< cf_object_t >::operator type<> ( ) const

noexceptinherited

operator!=() [1/3]

bool dx::cf::__string< ::CFStringRef >::operator!= ( ::CFStringRef value ) const

inlinenoexceptinherited

operator!=() [2/3]

template<typename cf_object_t >

bool dx::cf::reference< cf_object_t >::operator!= ( cf_object_t cf_object ) const

inlinenoexceptinherited

operator!=() [3/3]

bool dx::cf::__string< ::CFStringRef >::operator!= ( value_t value )

inlineinherited

operator+() [1/2]

::CFMutableStringRef dx::cf::__string< ::CFStringRef >::operator+ ( ::CFStringRef value ) const

inlinenoexceptinherited

operator+() [2/2]

::CFMutableStringRef dx::cf::__string< ::CFStringRef >::operator+ ( const char * value ) const

inlinenoexceptinherited

operator::CFDataRef()

dx::cf::__string< ::CFStringRef >::operator::CFDataRef ( ) const

inlinenoexceptinherited

operator::CFRunLoopSourceRef()

dx::io::power::operator::CFRunLoopSourceRef ( ) const

inlinenoexceptinherited

operator::CFTypeID()

template<typename cf_object_t >

dx::cf::reference< cf_object_t >::operator::CFTypeID ( ) const

inlinenoexceptinherited

operator::CFTypeRef()

template<typename cf_object_t >

template<typename petty_t = cf_object_t, typename = typename std::enable_if_t <!std::is_same_v<petty_t, ::CFTypeRef>>>

dx::cf::reference< cf_object_t >::operator::CFTypeRef ( ) const

inlinenoexceptinherited

operator::IONotificationPortRef()

dx::io::power::operator::IONotificationPortRef ( ) const

inlinenoexceptinherited

operator::mach_port_t()

dx::io::power::operator::mach_port_t ( ) const

inlinenoexceptinherited

operator<() [1/2]

bool dx::cf::__string< ::CFStringRef >::operator< ( ::CFStringRef value ) const

inlinenoexceptinherited

operator<() [2/2]

bool dx::cf::__string< ::CFStringRef >::operator< ( value_t value )

inlineinherited

operator<=() [1/2]

bool dx::cf::__string< ::CFStringRef >::operator<= ( ::CFStringRef value ) const

inlinenoexceptinherited

operator<=() [2/2]

bool dx::cf::__string< ::CFStringRef >::operator<= ( value_t value )

inlineinherited

operator==() [1/3]

bool dx::cf::__string< ::CFStringRef >::operator== ( ::CFStringRef value ) const

inlinenoexceptinherited

operator==() [2/3]

template<typename cf_object_t >

bool dx::cf::reference< cf_object_t >::operator== ( cf_object_t cf_object ) const

inlinenoexceptinherited

operator==() [3/3]

bool dx::cf::__string< ::CFStringRef >::operator== ( value_t value )

inlineinherited

operator>() [1/2]

bool dx::cf::__string< ::CFStringRef >::operator> ( ::CFStringRef value ) const

inlinenoexceptinherited

operator>() [2/2]

bool dx::cf::__string< ::CFStringRef >::operator> ( value_t value )

inlineinherited

operator>=() [1/2]

bool dx::cf::__string< ::CFStringRef >::operator>= ( ::CFStringRef value ) const

inlinenoexceptinherited

operator>=() [2/2]

bool dx::cf::__string< ::CFStringRef >::operator>= ( value_t value )

inlineinherited

release()

template<typename cf_object_t >

reference & dx::cf::reference< cf_object_t >::release ( )

inlinenoexceptinherited

Here is the caller graph for this function:

removed() [1/2]

template<class device_t = device>

virtual void dx::generic::driver::removed ( )

inlineprotectedvirtualnoexcept

notify device removals completed stub

Reimplemented from dx::generic::driver.

removed() [2/2]

template<class device_t = device>

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

inlineprotectedvirtualnoexcept

notify specific device removal stub

Reimplemented in dx::stream::engine< device_t, pin_t, io_t, circular_t, driver_t >.

retain()

template<typename cf_object_t >

reference & dx::cf::reference< cf_object_t >::retain ( )

inlinenoexceptinherited

Here is the caller graph for this function:

Member Data Documentation

cf_object

template<typename cf_object_t >

cf_object_t dx::cf::reference< cf_object_t >::cf_object = nullptr

protectedinherited

cf_type_desc

template<typename cf_object_t >

::CFStringRef dx::cf::reference< cf_object_t >::cf_type_desc = nullptr

inherited

cf_type_id

template<typename cf_object_t >

::CFStringRef dx::cf::reference< cf_object_t >::cf_type_id = nullptr

inherited

elements

T std::deque< T >::elements

inherited

STL member.

launched

template<class device_t = device>

bool dx::driver< device_t >::launched = false

log [1/2]

log dx::generic::driver::log {}

inherited

log [2/2]

dx::log dx::generic::driver::log {}

inherited

preference [1/2]

cf::preference dx::generic::driver::preference

inherited

preference [2/2]

dx::registry dx::generic::driver::preference

inherited

setup

dx::generic::driver::setup dx::generic::driver::setup

inherited

---

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

• macOS/dx_driver.h
• windows/dx_driver.h