dx::service::device< preference_t > Class Template Reference

#include <dx_service_device.h>

Inheritance diagram for dx::service::device< preference_t >:

Collaboration diagram for dx::service::device< preference_t >:

Classes
class	chain

Public Member Functions
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.
auto	count () const noexcept
	device (decltype(super::driver)&driver, ::io_service_t id)
	the device class constructor
template<typename ... initializer_t>
	device (decltype(super::driver)&driver, const decltype(super::id)&id, initializer_t... initializer)
void	exception (const dx::exception &exception, bool filtered=false) const noexcept override
	notification exception handler
template<typename value_t, typename = cf::enable_if_convertible<value_t>>
value_t	get (::CFStringRef key) const
::CFTypeRef	get (::CFStringRef key) const
template<typename value_t, typename = cf::enable_if_convertible<value_t>>
value_t	get (::CFStringRef key, ::CFTypeRef dflt) const noexcept
::CFTypeRef	get (::CFStringRef key, ::CFTypeRef dflt) const noexcept
template<typename value_t, typename = cf::enable_if_convertible<value_t>>
value_t	get (::CFStringRef key, value_t dflt) const noexcept
template<typename key_t, typename value_t, typename = cf::enable_if_convertible<key_t>, typename = cf::enable_if_convertible<value_t>>
value_t	get (key_t key) const
template<typename key_t, typename = cf::enable_if_convertible<key_t>>
::CFTypeRef	get (key_t key) const
void	info (std::ostream &os) noexcept override try
	log object class information
void	launch () override
	launch notification: object mounted and ready to use
	operator const ::io_registry_entry_t & () const noexcept
	auto converter into const io_object
	operator const ::io_registry_entry_t & () const noexcept
	auto converter into const io_object
	operator uint64_t () const
	operator::CFMutableDictionaryRef () const
	operator::CFStringRef () const
	operator::io_registry_entry_t & () noexcept
	auto converter into io_object
	operator::io_registry_entry_t & () noexcept
	auto converter into io_object
	operator::io_registry_entry_t * () noexcept
	auto converter into io_object pointer
	operator::io_registry_entry_t * () noexcept
	auto converter into io_object pointer
bool	operator== (::io_registry_entry_t io_object) const noexcept
virtual device &	operator>> (std::ostream &) const
::CFTypeRef	operator[] (::CFStringRef key) const
template<typename key_t, typename = cf::enable_if_convertible<key_t>>
::CFTypeRef	operator[] (key_t key) const
registry	parent () const
reference &	retain ()
registry &	set (::CFStringRef key, ::CFTypeRef value)
template<typename value_t, typename = cf::enable_if_convertible<value_t>>
registry &	set (::CFStringRef key, value_t value)
registry &	set (::CFTypeRef properties)
	Setting properties in a registry entry is not generally supported, it is more common to support setting of properties of the connection based property setting of dx::device.
template<typename key_t, typename = cf::enable_if_convertible<key_t>>
registry &	set (key_t key, ::CFTypeRef value)
template<typename key_t, typename value_t, typename = cf::enable_if_convertible<key_t>, typename = cf::enable_if_convertible<value_t>>
registry &	set (key_t key, value_t value)
virtual void	sleep ()
	notify system will sleep stub
virtual void	wake ()
	notify system wake completed stub

Public Attributes
dx::driver< decltype(id), preference_t > &	driver
const ::io_service_t	id
bool	launched
preference_t	preference
std::string	puid
	persistent UID - system unique - could change with location
std::string	puuid
	persistent universal UID - universally unique ID (i.e. serial number)

Protected Types
typedef service::request< service::stream::data< typename super_device_t::desc_t > >	request

Protected Attributes
dx::service::device::chain	clocksource
dx::service::device::chain	iosize
struct {
cf::string   bundle_id
cf::string   class_name
}	kernel
dx::service::device::chain	pipe
pipe< request >::server	pipe
dx::service::device::chain	safety_offset [dx::stream::direction::out]
dx::service::device::chain	safety_offset_in [dx::stream::direction::in]
dx::service::device::chain	safety_offset_out [dx::stream::direction::out]
dx::service::device::chain	samplerate

Member Typedef Documentation

request

template<typename preference_t>

typedef service::request<service::stream::data<typename super_device_t::desc_t> > dx::service::device< preference_t >::request

protected

Constructor & Destructor Documentation

device() [1/2]

template<typename preference_t>

dx::service::device< preference_t >::device ( decltype(super::driver)& driver, ::io_service_t id )

inline

the device class constructor

Exceptions

kIOReturn

NoMemory means that the system couldn't allocate the class defined in the drivers plist, or nub which ever its trying connecting to

Parameters

driver	device tree hosting dx::driver
id	the IOService object to open the device connection for. This will be retained during device class lifetime

device() [2/2]

template<typename preference_t>

template<typename ... initializer_t>

dx::service::device< preference_t >::device ( decltype(super::driver)& driver, const decltype(super::id)& id, initializer_t... initializer )

inline

Member Function Documentation

conclude()

template<typename preference_t>

void dx::service::device< preference_t >::conclude ( )

inlineoverridevirtualnoexcept

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 caller graph for this function:

count()

auto io::reference< ::io_registry_entry_t >::count ( ) const

inlinenoexceptinherited

exception()

void dx::device< ::io_service_t, preference_t >::exception ( const dx::exception & exception, bool filtered = false ) const

inlineoverridevirtualnoexceptinherited

notification exception handler

Implements dx::object.

Reimplemented in dx::proxy::device< preference_t >, and dx::usb::platform::device< preference_t >.

Here is the call graph for this function:

Here is the caller graph for this function:

get() [1/7]

template<typename value_t, typename = cf::enable_if_convertible<value_t>>

value_t io::registry::get ( ::CFStringRef key ) const

inlineinherited

Here is the call graph for this function:

get() [2/7]

::CFTypeRef io::registry::get ( ::CFStringRef key ) const

inlineinherited

Here is the call graph for this function:

Here is the caller graph for this function:

get() [3/7]

template<typename value_t, typename = cf::enable_if_convertible<value_t>>

value_t io::registry::get ( ::CFStringRef key, ::CFTypeRef dflt ) const

inlinenoexceptinherited

Here is the call graph for this function:

get() [4/7]

::CFTypeRef io::registry::get ( ::CFStringRef key, ::CFTypeRef dflt ) const

inlinenoexceptinherited

Here is the call graph for this function:

get() [5/7]

template<typename value_t, typename = cf::enable_if_convertible<value_t>>

value_t io::registry::get ( ::CFStringRef key, value_t dflt ) const

inlinenoexceptinherited

Here is the call graph for this function:

get() [6/7]

template<typename key_t, typename value_t, typename = cf::enable_if_convertible<key_t>, typename = cf::enable_if_convertible<value_t>>

value_t io::registry::get ( key_t key ) const

inlineinherited

Here is the call graph for this function:

get() [7/7]

template<typename key_t, typename = cf::enable_if_convertible<key_t>>

::CFTypeRef io::registry::get ( key_t key ) const

inlineinherited

Here is the call graph for this function:

Here is the caller graph for this function:

info()

template<typename preference_t>

void dx::service::device< preference_t >::info ( std::ostream & os )

inlineoverridevirtualnoexcept

log object class information

Reimplemented from dx::device<::io_service_t, preference_t >.

Reimplemented in dx::stream::control< dx::proxy::device< dx::preference > >, dx::stream::control< usb::device< dx::preference > >, 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< usb::device< dx::preference > >, desc_t, pipe< device< desc_t, dx::preference, pipe > > >, dx::usb::platform::device< preference_t >, dx::usb::platform::device< dx::preference >, dx::usb::platform::device< preference_t >, and dx::usb::stream::_device< desc_t, dx::preference, pipe< device< desc_t, dx::preference, pipe > > >.

Here is the caller graph for this function:

launch()

template<typename preference_t>

void dx::service::device< preference_t >::launch ( )

inlineoverridevirtual

launch notification: object mounted and ready to use

Reimplemented from dx::object.

Reimplemented in dx::usb::stream::_device< desc_t, dx::preference, pipe< device< desc_t, dx::preference, pipe > > >.

operator const ::io_registry_entry_t &() [1/2]

io::reference< ::io_registry_entry_t >::operator const ::io_registry_entry_t & ( ) const

inlinenoexceptinherited

auto converter into const io_object

operator const ::io_registry_entry_t &() [2/2]

io::reference< ::io_registry_entry_t >::operator const ::io_registry_entry_t & ( ) const

inlinenoexceptinherited

auto converter into const io_object

operator uint64_t()

io::registry::operator uint64_t ( ) const

inlineexplicitinherited

operator::CFMutableDictionaryRef()

io::registry::operator::CFMutableDictionaryRef ( ) const

inlineexplicitinherited

Here is the call graph for this function:

Here is the caller graph for this function:

operator::CFStringRef()

io::registry::operator::CFStringRef ( ) const

inlineexplicitinherited

Here is the caller graph for this function:

operator::io_registry_entry_t &() [1/2]

io::reference< ::io_registry_entry_t >::operator ::io_registry_entry_t & ( )

inlinenoexceptinherited

auto converter into io_object

operator::io_registry_entry_t &() [2/2]

io::reference< ::io_registry_entry_t >::operator ::io_registry_entry_t & ( )

inlinenoexceptinherited

auto converter into io_object

operator::io_registry_entry_t *() [1/2]

io::reference< ::io_registry_entry_t >::operator ::io_registry_entry_t * ( )

inlinenoexceptinherited

auto converter into io_object pointer

operator::io_registry_entry_t *() [2/2]

io::reference< ::io_registry_entry_t >::operator ::io_registry_entry_t * ( )

inlinenoexceptinherited

auto converter into io_object pointer

operator==()

bool io::reference< ::io_registry_entry_t >::operator== ( ::io_registry_entry_t io_object ) const

inlinenoexceptinherited

operator>>()

virtual device & dx::device< ::io_service_t, preference_t >::operator>> ( std::ostream & ) const

inlinevirtualinherited

Here is the call graph for this function:

operator[]() [1/2]

::CFTypeRef io::registry::operator[] ( ::CFStringRef key ) const

inlineinherited

Here is the call graph for this function:

operator[]() [2/2]

template<typename key_t, typename = cf::enable_if_convertible<key_t>>

::CFTypeRef io::registry::operator[] ( key_t key ) const

inlineinherited

Here is the call graph for this function:

parent()

registry io::registry::parent ( ) const

inlineinherited

Here is the call graph for this function:

Here is the caller graph for this function:

retain()

reference & io::reference< ::io_registry_entry_t >::retain ( )

inlineinherited

Here is the caller graph for this function:

set() [1/5]

registry & io::registry::set ( ::CFStringRef key, ::CFTypeRef value )

inlineinherited

Here is the call graph for this function:

set() [2/5]

template<typename value_t, typename = cf::enable_if_convertible<value_t>>

registry & io::registry::set ( ::CFStringRef key, value_t value )

inlineinherited

Here is the call graph for this function:

set() [3/5]

registry & io::registry::set ( ::CFTypeRef properties )

inlineinherited

Setting properties in a registry entry is not generally supported, it is more common to support setting of properties of the connection based property setting of dx::device.

Here is the call graph for this function:

Here is the caller graph for this function:

set() [4/5]

template<typename key_t, typename = cf::enable_if_convertible<key_t>>

registry & io::registry::set ( key_t key, ::CFTypeRef value )

inlineinherited

Here is the call graph for this function:

set() [5/5]

template<typename key_t, typename value_t, typename = cf::enable_if_convertible<key_t>, typename = cf::enable_if_convertible<value_t>>

registry & io::registry::set ( key_t key, value_t value )

inlineinherited

Here is the call graph for this function:

sleep()

virtual void dx::device< ::io_service_t, preference_t >::sleep ( )

inlinevirtualinherited

notify system will sleep stub

wake()

virtual void dx::device< ::io_service_t, preference_t >::wake ( )

inlinevirtualinherited

notify system wake completed stub

Member Data Documentation

bundle_id

template<typename preference_t>

cf::string dx::service::device< preference_t >::bundle_id

class_name

template<typename preference_t>

cf::string dx::service::device< preference_t >::class_name

clocksource

template<typename preference_t>

dx::service::device::chain dx::service::device< preference_t >::clocksource

protected

driver

dx::driver<decltype(id), preference_t>& dx::device< ::io_service_t, preference_t >::driver

inherited

id

const ::io_service_t dx::device< ::io_service_t, preference_t >::id

inherited

iosize

template<typename preference_t>

dx::service::device::chain dx::service::device< preference_t >::iosize

protected

[struct]

struct { ... } dx::service::device< preference_t >::kernel

launched

bool dx::object::launched

inherited

pipe [1/2]

template<typename preference_t>

dx::service::device::chain dx::service::device< preference_t >::pipe[dx::stream::direction::out]

protected

pipe [2/2]

template<typename preference_t>

dx::service::device::chain dx::service::device< preference_t >::pipe

protected

Initial value:

{this->id.c_str(), [this](class pipe<request>::server::instance&, const request& request){
        std::clog<< class_name<< "<"<< this->id<< ">::pipe::listen: " << request << std::endl;
        switch(request.id){
        case request::id::start:
            this->start();
            break;
        case request::id::stop: 
            this->stop();
            break;
        case request::id::desc:
            pipe<< device::request{
                .id= request.id,
                .size= sizeof(request.data.desc),
                .data{.desc={
                    this->puid,
                    static_cast<typename super_device_t::desc_t>(*this)}}};
            break;
        }
    }}

preference

preference_t dx::device< ::io_service_t, preference_t >::preference

inherited

puid

std::string dx::device< ::io_service_t, preference_t >::puid

inherited

persistent UID - system unique - could change with location

puuid

std::string dx::device< ::io_service_t, preference_t >::puuid

inherited

persistent universal UID - universally unique ID (i.e. serial number)

safety_offset

template<typename preference_t>

dx::service::device::chain dx::service::device< preference_t >::safety_offset

protected

safety_offset_in

template<typename preference_t>

dx::service::device::chain dx::service::device< preference_t >::safety_offset_in[dx::stream::direction::in]

protected

safety_offset_out

template<typename preference_t>

dx::service::device::chain dx::service::device< preference_t >::safety_offset_out[dx::stream::direction::out]

protected

samplerate

template<typename preference_t>

dx::service::device::chain dx::service::device< preference_t >::samplerate

protected

---

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

• macOS/dx_proxy_device.h
• dx_service_device.h