dxd - dynax driver framework  2979
cross platform open source driver development framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 >:

Public Member Functions

virtual void conclude () noexcept
 conclude notification: device will be removed from tree More...
 
virtual void conclude ()
 conclude notifacation: device will be removed from tree More...
 
void ctl (unsigned int ioctl) const
 
::CFTypeRef 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) const
 
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
 Windows: member ioctl. More...
 
template<typename rx_t >
size_t ictl (unsigned int ioctl, rx_t &rx) const
 
tx_t size_t ioctl (unsigned int ioctl, const tx_t &tx, rx_t &rx) const
 
template<typename rx_t , typename tx_t >
rx_t ioctl (unsigned int ioctl, const tx_t &tx) 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
 
template<typename tx_t , typename rx_t >
size_t ioctl (unsigned int ioctl, const tx_t &tx, rx_t &rx) const
 
template<typename rx_t , typename tx_t >
rx_t ioctl (unsigned int ioctl, const tx_t &tx) 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
 
 operator const io_registry_entry_t & () const
 auto converter into const object More...
 
 operator io_registry_entry_t & ()
 auto converter into object More...
 
 operator uint64_t () const
 
 operator::CFMutableDictionaryRef () const
 
 operator::HANDLE () const
 
bool operator== (io_registry_entry_tobject) const noexcept
 
::CFTypeRef operator[] (::CFStringRef key) const
 
template<typename key_t , typename = typename std::enable_if<std::is_pod<key_t>::value>>
::CFTypeRef operator[] (key_t key) const
 
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...
 
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)
 
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)
 

Public Attributes

typedef::io_service_t creator
 
bool removed =false
 
 typename
 
 value_t
 

Protected Member Functions

 catchall () public
 
 catchall_rethrow () unsigned char configuration(unsigned char configuration) try
 
 catchall_rethrow () unsigned char configurations() const try
 
 catchall_rethrow () unsigned char configuration() const try
 
 catchall_rethrow () unsigned int samplerate(unsigned int samplerate) try
 
 catchall_rethrow () unsigned int samplerate() try
 
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 Function Documentation

template<typename desc_t>
dx::stream::device< desc_t >::catchall ( )
inlineprotected
template<typename desc_t>
dx::stream::device< desc_t >::catchall_rethrow ( )
inlineprotected
template<typename desc_t>
dx::stream::device< desc_t >::catchall_rethrow ( ) const
inlineprotected
template<typename desc_t>
dx::stream::device< desc_t >::catchall_rethrow ( ) const
inlineprotected
template<typename desc_t>
dx::stream::device< desc_t >::catchall_rethrow ( )
inlineprotected
template<typename desc_t>
dx::stream::device< desc_t >::catchall_rethrow ( )
inlineprotected
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::coremidi::device< io_t, bus_t, desc_t >.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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::coremidi::device< io_t, bus_t, desc_t >.

void dx::device::ctl ( unsigned int  ioctl) const
inlineinherited
template<typename desc_t>
virtual void dx::stream::device< desc_t >::exception ( const dx::exception exception) const
inlineprotectedvirtualnoexcept
::CFTypeRef dx::io::registry::get ( ::CFStringRef  key) const
inlineinherited
::CFTypeRef dx::io::registry::get ( ::CFStringRef  key,
::CFTypeRef  dflt 
) const
inlinenoexceptinherited
template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
value_t dx::io::registry::get ( ::CFStringRef  key) const
inlineinherited
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
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
template<typename key_t , typename = typename cf::enable_if_convertible<key_t>::type>
::CFTypeRef dx::io::registry::get ( key_t  key) const
inlineinherited
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
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 caller graph for this function:

template<typename rx_t >
size_t dx::device::ictl ( unsigned int  ioctl,
rx_t &  rx 
) const
inlineinherited
tx_t size_t dx::device::ioctl ( unsigned int  ioctl,
const tx_t &  tx,
rx_t &  rx 
) const
inlineinherited
template<typename rx_t , typename tx_t >
rx_t dx::device::ioctl ( unsigned int  ioctl,
const tx_t &  tx 
) const
inlineinherited
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
template<typename tx_t , typename rx_t >
size_t dx::device::ioctl ( unsigned int  ioctl,
const tx_t &  tx,
rx_t &  rx 
) const
inlineinherited
template<typename rx_t , typename tx_t >
rx_t dx::device::ioctl ( unsigned int  ioctl,
const tx_t &  tx 
) const
inlineinherited
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::coremidi::device< io_t, bus_t, desc_t >.

+ Here is the caller graph for this function:

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::coremidi::device< io_t, bus_t, desc_t >.

template<typename tx_t >
void dx::device::octl ( unsigned int  ioctl,
const tx_t &  tx 
) const
inlineinherited
dx::io::reference< io_registry_entry_t >::operator const io_registry_entry_t & ( ) const
inlineinherited

auto converter into const object

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

auto converter into object

dx::io::registry::operator uint64_t ( ) const
inlineinherited
dx::io::registry::operator::CFMutableDictionaryRef ( ) const
inlineinherited
dx::device::operator::HANDLE ( ) const
inlineinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool dx::io::reference< io_registry_entry_t >::operator== ( io_registry_entry_t  object) const
inlinenoexceptinherited
::CFTypeRef dx::io::registry::operator[] ( ::CFStringRef  key) const
inlineinherited
template<typename key_t , typename = typename std::enable_if<std::is_pod<key_t>::value>>
::CFTypeRef dx::io::registry::operator[] ( key_t  key) const
inlineinherited
registry& dx::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 caller graph for this function:

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

+ Here is the call graph for this function:

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

+ Here is the call graph for this function:

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::io::registry::set ( key_t  key,
value_t  value 
)
inlineinherited

+ Here is the call graph for this function:

template<typename desc_t>
unsigned int dx::stream::device< desc_t >::version ( ) const
inlineprotected

Member Data Documentation

cf::type<const char*> dx::device::bundle_id
inherited
cf::type<const char*> dx::device::class_name
inherited
typedef::io_service_t dx::device::creator
inherited
struct { ... } dx::device::kernel
io::port dx::device::port
protectedinherited
bool dx::device::removed =false
inherited
dx::device::typename
inherited
Initial value:
= typename cf::enable_if_convertible<value_t>::type>
registry& set (::CFStringRef key, value_t value) {
return set (key, cf::type<value_t>(value));
}
template<typename key_t
dx::device::value_t
inherited

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

(c) copyright 2009 dynamic acoustics e.U. generated on Fri Nov 8 2019

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.