dxd - dynax driver framework
cross platform open source driver development framework
dx::stream::device< desc_t > Class Template Reference

#include <dx_stream_device.h>

+ Inheritance diagram for dx::stream::device< desc_t >:
+ Collaboration diagram for dx::stream::device< desc_t >:

Classes

struct  property
 

Public Types

typedef ::io_service_t creator
 

Public Member Functions

virtual void conclude ()
 conclude notifacation: device will be removed from tree More...
 
virtual void conclude () noexcept
 conclude notification: device will be removed from tree More...
 
void ctl (unsigned int ioctl) const
 
void ctl (unsigned int ioctl) const
 
preferenceerase (::CFStringRef key=nullptr)
 
registryerase (const char *key=nullptr)
 
::CFTypeRef get (::CFStringRef key) const
 
template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
value_t get (::CFStringRef key) const
 
::CFTypeRef get (::CFStringRef key, ::CFTypeRef dflt) const noexcept
 
template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
value_t get (::CFStringRef key, ::CFTypeRef dflt) const noexcept
 
template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
value_t get (::CFStringRef key, value_t dflt) const noexcept
 
template<typename key_t , typename = typename cf::enable_if_convertible<key_t>::type>
::CFTypeRef get (key_t key) const
 
template<typename key_t , typename value_t , typename = typename cf::enable_if_convertible<key_t>::type, typename = typename cf::enable_if_convertible<value_t>::type>
value_t get (key_t key) const
 
template<typename rx_t >
rx_t ictl (unsigned int ioctl) const
 member ioctl More...
 
template<typename rx_t >
rx_t ictl (unsigned int ioctl) const
 Windows: member ioctl. More...
 
template<typename rx_t >
size_t ictl (unsigned int ioctl, rx_t &rx) const
 
template<typename rx_t >
size_t ictl (unsigned int ioctl, rx_t &rx) const
 
void initialize (const char *path, ::HKEY root, ::REGSAM rights=KEY_READ, const char *key=nullptr)
 
void initialize (const char *path, ::REGSAM rights=KEY_READ, ::HKEY root=HKEY_CURRENT_USER, const char *key=nullptr)
 
template<typename rx_t , typename tx_t >
rx_t ioctl (unsigned int ioctl, const tx_t &tx) const
 
template<typename rx_t , typename tx_t >
rx_t ioctl (unsigned int ioctl, const tx_t &tx) const
 
template<typename rx_t , typename tx_t >
size_t ioctl (unsigned int ioctl, const tx_t &tx, rx_t &rx) const
 
template<typename tx_t , typename rx_t >
size_t ioctl (unsigned int ioctl, const tx_t &tx, rx_t &rx) const
 
size_t ioctl (unsigned int ioctl, const void *tx=nullptr, size_t tx_size=0, void *rx=nullptr, size_t rx_size=0) const
 
virtual void launch ()
 launch notification: device mounted in tree and ready to use More...
 
virtual void launch ()
 launch notifacation: device mounted in tree and ready to use More...
 
template<typename tx_t >
void octl (unsigned int ioctl, const tx_t &tx) const
 
template<typename tx_t >
void octl (unsigned int ioctl, const tx_t &tx) const
 
 operator const io_registry_entry_t & () const noexcept
 auto converter into const object More...
 
 operator io_registry_entry_t & () noexcept
 auto converter into object More...
 
 operator io_registry_entry_t * () noexcept
 auto converter into object pointer More...
 
 operator std::string () const
 
 operator uint64_t () const
 
template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
 operator value_t () const
 
template<typename value_t >
 operator value_t () const
 
::CFDictionaryRef operator() (::CFDictionaryRef dflt) const noexcept
 
::CFPropertyListRef operator() (::CFPropertyListRef dflt) const
 
template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
value_t operator() (value_t dflt) const
 
template<typename value_t >
value_t operator() (value_t dflt) const
 
 operator::CFArrayRef () const noexcept
 
 operator::CFDictionaryRef () const noexcept
 
 operator::CFMutableDictionaryRef () const
 
 operator::CFPropertyListRef () const
 
 operator::HANDLE () const noexcept
 
bool operator== (io_registry_entry_t object) const noexcept
 
::CFTypeRef operator[] (::CFStringRef key) const
 
preference operator[] (::CFStringRef key) const
 
registry operator[] (const char *key) const
 
template<typename key_t , typename = typename cf::enable_if_convertible<key_t>::type>
::CFTypeRef operator[] (key_t key) const
 
template<typename key_t , typename = typename cf::enable_if_convertible<key_t>::type>
preference operator[] (key_t key) const
 
registryset (::CFStringRef key, ::CFTypeRef value) noexcept
 
template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
registryset (::CFStringRef key, value_t value)
 
registryset (::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. More...
 
template<typename key_t , typename = typename cf::enable_if_convertible<key_t>::type>
registryset (key_t key, ::CFTypeRef value)
 
template<typename key_t , typename value_t , typename = typename cf::enable_if_convertible<key_t>::type, typename = typename cf::enable_if_convertible<value_t>::type>
registryset (key_t key, value_t value)
 
registrysignal ()
 
registrywait (int64_t timeout=0, ::DWORD filter=REG_NOTIFY_CHANGE_NAME|REG_NOTIFY_CHANGE_ATTRIBUTES|REG_NOTIFY_CHANGE_LAST_SET|REG_NOTIFY_CHANGE_SECURITY, bool subtree=true)
 

Public Attributes

dx::log log {}
 
cf::preference preference
 
registry preference
 

Protected Member Functions

 catchall_rethrow () unsigned char configuration() const try
 
 catchall_rethrow () unsigned char configuration(unsigned char configuration) try
 
 catchall_rethrow () unsigned char configurations() const try
 
 catchall_rethrow () unsigned int samplerate() const try
 
 catchall_rethrow () unsigned int samplerate(unsigned int samplerate) try
 
catchall() public device (const typename super::creator &creator)
 
virtual void exception (const dx::exception &exception) const noexcept try
 
unsigned int version () const try
 

Protected Attributes

struct {
   cf::type< const char * >   bundle_id
 
   cf::type< const char * >   class_name
 
kernel
 
io::port port
 

Member Typedef Documentation

◆ creator

typedef ::io_service_t dx::device::creator
inherited

Constructor & Destructor Documentation

◆ device()

template<typename desc_t >
catchall () public dx::stream::device< desc_t >::device ( const typename super::creator creator)
inlineprotected
+ Here is the call graph for this function:

Member Function Documentation

◆ catchall_rethrow() [1/5]

template<typename desc_t >
dx::stream::device< desc_t >::catchall_rethrow ( ) const
inlineprotected

◆ catchall_rethrow() [2/5]

template<typename desc_t >
dx::stream::device< desc_t >::catchall_rethrow ( )
inlineprotected

◆ catchall_rethrow() [3/5]

template<typename desc_t >
dx::stream::device< desc_t >::catchall_rethrow ( ) const
inlineprotected

◆ catchall_rethrow() [4/5]

template<typename desc_t >
dx::stream::device< desc_t >::catchall_rethrow ( ) const
inlineprotected

◆ catchall_rethrow() [5/5]

template<typename desc_t >
dx::stream::device< desc_t >::catchall_rethrow ( )
inlineprotected

◆ conclude() [1/2]

virtual void dx::device::conclude ( )
inlinevirtualinherited

conclude notifacation: device will be removed from tree

Reimplemented in dx::coreaudio::device< io_t, bus_t, desc_t >, and dx::usb::device.

◆ conclude() [2/2]

virtual void dx::device::conclude ( )
inlinevirtualnoexceptinherited

conclude notification: device will be removed from tree

Reimplemented in dx::coreaudio::device< io_t, bus_t, desc_t >, and dx::usb::device.

+ Here is the caller graph for this function:

◆ ctl() [1/2]

void dx::device::ctl ( unsigned int  ioctl) const
inlineinherited

◆ ctl() [2/2]

void dx::device::ctl ( unsigned int  ioctl) const
inlineinherited
+ Here is the call graph for this function:

◆ erase() [1/2]

preference& dx::cf::preference::erase ( ::CFStringRef  key = nullptr)
inlineinherited

◆ erase() [2/2]

registry& dx::registry::erase ( const char *  key = nullptr)
inlineinherited

◆ exception()

template<typename desc_t >
virtual void dx::stream::device< desc_t >::exception ( const dx::exception exception) const
inlineprotectedvirtualnoexcept

◆ get() [1/7]

::CFTypeRef dx::io::registry::get ( ::CFStringRef  key) const
inlineinherited
+ Here is the caller graph for this function:

◆ get() [2/7]

template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
value_t dx::io::registry::get ( ::CFStringRef  key) const
inlineinherited
+ Here is the call graph for this function:

◆ get() [3/7]

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

◆ get() [4/7]

template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
value_t dx::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 = typename cf::enable_if_convertible<value_t>::type>
value_t dx::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 = typename cf::enable_if_convertible<key_t>::type>
::CFTypeRef dx::io::registry::get ( key_t  key) const
inlineinherited
+ Here is the call graph for this function:

◆ get() [7/7]

template<typename key_t , typename value_t , typename = typename cf::enable_if_convertible<key_t>::type, typename = typename cf::enable_if_convertible<value_t>::type>
value_t dx::io::registry::get ( key_t  key) const
inlineinherited
+ Here is the call graph for this function:

◆ ictl() [1/4]

template<typename rx_t >
rx_t dx::device::ictl ( unsigned int  ioctl) const
inlineinherited

member ioctl

this member retreives data from the device by providing an IOCTL code. the template argument defines the type of data to be retreived. this member is intended as a convinient way to retreive only small amounts of data since there is an intermediate stack copy involved in returning the data.

+ Here is the caller graph for this function:

◆ ictl() [2/4]

template<typename rx_t >
rx_t dx::device::ictl ( unsigned int  ioctl) const
inlineinherited

Windows: member ioctl.

this member retreives data from the device by providing an IOCTL code. the template argument defines the type of data to be retreived. this member is intended as a convinient way to retreive only small amounts of data since there is an intermediate stack copy involved in returning the data.

the underlaying windows API is DeviceIoControl(). for detailed information see http://msdn.microsoft.com/en-us/library/aa363216(VS.85).aspx

Exceptions
n/amicrosoft does not give information about what possible errors values are provided by its OS other than
ERROR_INSUFFICIENT_BUFFERif the output buffer is too small to receive any data
+ Here is the call graph for this function:

◆ ictl() [3/4]

template<typename rx_t >
size_t dx::device::ictl ( unsigned int  ioctl,
rx_t &  rx 
) const
inlineinherited

◆ ictl() [4/4]

template<typename rx_t >
size_t dx::device::ictl ( unsigned int  ioctl,
rx_t &  rx 
) const
inlineinherited
+ Here is the call graph for this function:

◆ initialize() [1/2]

void dx::registry::initialize ( const char *  path,
::HKEY  root,
::REGSAM  rights = KEY_READ,
const char *  key = nullptr 
)
inlineinherited
+ Here is the caller graph for this function:

◆ initialize() [2/2]

void dx::registry::initialize ( const char *  path,
::REGSAM  rights = KEY_READ,
::HKEY  root = HKEY_CURRENT_USER,
const char *  key = nullptr 
)
inlineinherited

◆ ioctl() [1/5]

template<typename rx_t , typename tx_t >
rx_t dx::device::ioctl ( unsigned int  ioctl,
const tx_t &  tx 
) const
inlineinherited

◆ ioctl() [2/5]

template<typename rx_t , typename tx_t >
rx_t dx::device::ioctl ( unsigned int  ioctl,
const tx_t &  tx 
) const
inlineinherited
+ Here is the call graph for this function:

◆ ioctl() [3/5]

template<typename rx_t , typename tx_t >
size_t dx::device::ioctl ( unsigned int  ioctl,
const tx_t &  tx,
rx_t &  rx 
) const
inlineinherited
+ Here is the caller graph for this function:

◆ ioctl() [4/5]

template<typename tx_t , typename rx_t >
size_t dx::device::ioctl ( unsigned int  ioctl,
const tx_t &  tx,
rx_t &  rx 
) const
inlineinherited
+ Here is the call graph for this function:

◆ ioctl() [5/5]

size_t dx::device::ioctl ( unsigned int  ioctl,
const void *  tx = nullptr,
size_t  tx_size = 0,
void *  rx = nullptr,
size_t  rx_size = 0 
) const
inlineinherited

◆ launch() [1/2]

virtual void dx::device::launch ( )
inlinevirtualinherited

launch notification: device mounted in tree and ready to use

Reimplemented in dx::coreaudio::device< io_t, bus_t, desc_t >, and dx::usb::device.

+ Here is the caller graph for this function:

◆ launch() [2/2]

virtual void dx::device::launch ( )
inlinevirtualinherited

launch notifacation: device mounted in tree and ready to use

Reimplemented in dx::coreaudio::device< io_t, bus_t, desc_t >, and dx::usb::device.

◆ octl() [1/2]

template<typename tx_t >
void dx::device::octl ( unsigned int  ioctl,
const tx_t &  tx 
) const
inlineinherited
+ Here is the caller graph for this function:

◆ octl() [2/2]

template<typename tx_t >
void dx::device::octl ( unsigned int  ioctl,
const tx_t &  tx 
) const
inlineinherited
+ Here is the call graph for this function:

◆ operator const io_registry_entry_t &()

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

auto converter into const object

◆ operator io_registry_entry_t &()

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

auto converter into object

◆ operator io_registry_entry_t *()

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

auto converter into object pointer

◆ operator std::string()

dx::registry::operator std::string ( ) const
inlineinherited

◆ operator uint64_t()

dx::io::registry::operator uint64_t ( ) const
inlineexplicitinherited

◆ operator value_t() [1/2]

template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
dx::cf::preference::operator value_t ( ) const
inlineinherited

◆ operator value_t() [2/2]

template<typename value_t >
dx::registry::operator value_t ( ) const
inlineinherited

◆ operator()() [1/4]

::CFDictionaryRef dx::cf::preference::operator() ( ::CFDictionaryRef  dflt) const
inlinenoexceptinherited

◆ operator()() [2/4]

::CFPropertyListRef dx::cf::preference::operator() ( ::CFPropertyListRef  dflt) const
inlineinherited

◆ operator()() [3/4]

template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
value_t dx::cf::preference::operator() ( value_t  dflt) const
inlineinherited

◆ operator()() [4/4]

template<typename value_t >
value_t dx::registry::operator() ( value_t  dflt) const
inlineinherited

◆ operator::CFArrayRef()

dx::cf::preference::operator::CFArrayRef ( ) const
inlinenoexceptinherited

◆ operator::CFDictionaryRef()

dx::cf::preference::operator::CFDictionaryRef ( ) const
inlinenoexceptinherited

◆ operator::CFMutableDictionaryRef()

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

◆ operator::CFPropertyListRef()

dx::cf::preference::operator::CFPropertyListRef ( ) const
inlineinherited

◆ operator::HANDLE()

dx::device::operator::HANDLE ( ) const
inlinenoexceptinherited

◆ operator==()

bool dx::io::reference< io_registry_entry_t >::operator== ( object_t  object) const
inlinenoexceptinherited

◆ operator[]() [1/5]

::CFTypeRef dx::io::registry::operator[] ( ::CFStringRef  key) const
inlineinherited
+ Here is the call graph for this function:

◆ operator[]() [2/5]

preference dx::cf::preference::operator[] ( ::CFStringRef  key) const
inlineinherited

◆ operator[]() [3/5]

registry dx::registry::operator[] ( const char *  key) const
inlineinherited
+ Here is the call graph for this function:

◆ operator[]() [4/5]

template<typename key_t , typename = typename cf::enable_if_convertible<key_t>::type>
::CFTypeRef dx::io::registry::operator[] ( key_t  key) const
inlineinherited
+ Here is the call graph for this function:

◆ operator[]() [5/5]

template<typename key_t , typename = typename cf::enable_if_convertible<key_t>::type>
preference dx::cf::preference::operator[] ( key_t  key) const
inlineinherited

◆ set() [1/5]

registry& dx::device::set ( ::CFStringRef  key,
::CFTypeRef  value 
)
inlinenoexceptinherited

◆ set() [2/5]

template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
registry& dx::device::set ( ::CFStringRef  key,
value_t  value 
)
inlineinherited

◆ set() [3/5]

registry& dx::device::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 caller graph for this function:

◆ set() [4/5]

template<typename key_t , typename = typename cf::enable_if_convertible<key_t>::type>
registry& dx::device::set ( key_t  key,
::CFTypeRef  value 
)
inlineinherited

◆ set() [5/5]

template<typename key_t , typename value_t , typename = typename cf::enable_if_convertible<key_t>::type, typename = typename cf::enable_if_convertible<value_t>::type>
registry& dx::device::set ( key_t  key,
value_t  value 
)
inlineinherited

◆ signal()

registry& dx::registry::signal ( )
inlineinherited
+ Here is the caller graph for this function:

◆ version()

template<typename desc_t >
unsigned int dx::stream::device< desc_t >::version ( ) const
inlineprotected
+ Here is the caller graph for this function:

◆ wait()

registry& dx::registry::wait ( int64_t  timeout = 0,
::DWORD  filter = REG_NOTIFY_CHANGE_NAME|REG_NOTIFY_CHANGE_ATTRIBUTES|REG_NOTIFY_CHANGE_LAST_SET|REG_NOTIFY_CHANGE_SECURITY,
bool  subtree = true 
)
inlineinherited

Member Data Documentation

◆ bundle_id

cf::type<const char*> dx::device::bundle_id
inherited

◆ class_name

cf::type<const char*> dx::device::class_name
inherited

◆ 

struct { ... } dx::device::kernel

◆ log

dx::log dx::device::log {}
inherited

◆ port

io::port dx::device::port
protectedinherited

◆ preference [1/2]

cf::preference dx::device::preference
inherited

◆ preference [2/2]

registry dx::device::preference
inherited

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

(c) copyright 2009 dynamic acoustics e.U. generated on Fri Jun 18 2021

a closed source license may be obtained by requesting a written permission from dynamic acoustics e.U.
however - governmental use generally and military use especially is strictly prohibited though.