dxd - dynax driver framework  2675
cross platform open source driver development framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
dx::device< exception_t > Class Template Reference

generic device interface class More...

#include <dx_device.h>

+ Inheritance diagram for dx::device< exception_t >:
+ Collaboration diagram for dx::device< exception_t >:

Classes

class  creator
 

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 throw (exception_t)
 
void ctl (unsigned int ioctl) const throw (exception_t)
 
 device (::io_service_t io_service) throw (exception_t)
 the device class constructor More...
 
 device (const creator &creator) throw (exception_t)
 the device class constructor More...
 
template<typename rx_t >
rx_t ictl (unsigned int ioctl) const throw (exception_t)
 member ioctl More...
 
template<typename rx_t >
size_t ictl (unsigned int ioctl, rx_t &rx) const throw (exception_t)
 
template<typename rx_t >
rx_t ictl (unsigned int ioctl) const throw (exception_t)
 Windows: member ioctl. More...
 
template<typename rx_t >
size_t ictl (unsigned int ioctl, rx_t &rx) const throw (exception_t)
 
template<typename rx_t , typename tx_t >
size_t ioctl (unsigned int ioctl, const tx_t &tx, rx_t &rx) const throw (exception_t)
 
template<typename rx_t , typename tx_t >
rx_t ioctl (unsigned int ioctl, const tx_t &tx) const throw (exception_t)
 
size_t ioctl (unsigned int ioctl, const void *tx=nullptr, size_t tx_size=0, void *rx=nullptr, size_t rx_size=0) const throw (exception_t)
 
template<typename tx_t , typename rx_t >
size_t ioctl (unsigned int ioctl, const tx_t &tx, rx_t &rx) const throw (exception_t)
 
template<typename rx_t , typename tx_t >
rx_t ioctl (unsigned int ioctl, const tx_t &tx) const throw (exception_t)
 
virtual void launch () throw (exception_t)
 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 throw (exception_t)
 
template<typename tx_t >
void octl (unsigned int ioctl, const tx_t &tx) const throw (exception_t)
 
 operator const io_registry_entry_t & () const
 auto converter into const object More...
 
 operator io_registry_entry_t & ()
 auto converter into object More...
 
 operator io_registry_entry_t * ()
 auto converter into object pointer More...
 
 operator::HANDLE () const
 
bool operator== (io_registry_entry_tobject) const noexcept
 
template<typename type_t >
type_t operator[] (const char *key) const throw (exception_t)
 
virtual ~device () noexcept
 the device class destructor More...
 
virtual ~device ()
 

Static Public Member Functions

static void pass (::HRESULT test) throw (exception_t)
 
template<class return_t >
static void pass (return_t value) throw (exception_t)
 
template<class return_t >
static void pass (bool test, return_t value) throw (exception_t)
 
static void pass_strict (::LONG test) throw (exception_t)
 

Public Attributes

typedef::io_service_t creator
 
bool removed =false
 

Static Protected Member Functions

static void pass (::HRESULT test) throw (exception_t)
 
static void pass (unsigned long test) throw (exception_t)
 
static void pass (::BOOL test) throw (exception_t)
 specialization for standard windows API BOOL return type More...
 
static void pass (::HANDLE test) throw (exception_t)
 specialization for test validy of windows HANDLE type More...
 
static void pass (::HWND test) throw (exception_t)
 specialization for test validy of windows HWND type - which is of course different from HANDLE More...
 
static void pass (::ATOM test) throw (exception_t)
 specialization for standard windows API ATOM return type More...
 
template<>
static void pass (unsigned long test) throw(::HRESULT)
 
template<>
static void pass (::BOOL test) throw(::HRESULT)
 
template<>
static void pass (::HANDLE test) throw(::HRESULT)
 
template<>
static void pass (::HWND test) throw(::HRESULT)
 
template<>
static void pass (::ATOM test) throw(::HRESULT)
 
template<class return_t >
static void pass (return_t value) throw (exception_t)
 
template<class return_t >
static void pass (bool test, return_t value) throw (exception_t)
 
static void pass_strict (::LONG test) throw (exception_t)
 

Protected Attributes

io::port< exception_t > port
 

Detailed Description

template<class exception_t = os_result>
class dx::device< exception_t >

generic device interface class

generic device class

This is the generic device interface class. This class is used for a platform independent way of accessing devices. The template parameter defines the exception class to be thrown. The device class uses the driver interface helper class to construct the device object and to bind the device to the driver identified by the GUID.

example:

try() { // guard the block
// choose a driver
dx::driver<>driver(GUID_MYDEVICE);
// enumerate devices
std::cout<<driver.size()<<" device(s) found:"<<std::endl;
// go thru all devices; you have to lock the driver if this multi-threaded
for (dx::driver<>::iterator i=driver.begin();i!=driver.end();i++){
// select a device
dx::reference<dx::device<>>device=*i;
// return an int from an IOCTL served by the driver
int my_data=device->ioctl<int>(kMyIoctl);
}
catch(dx::os_error error) {
std::cerr << "OS aborted operation with error #" << error << std::endl;
}
}
Exceptions
Incase of an error returned by the underlaying API the device class throws an exception converted from dx::os_error. With the default exception_t=dx::os_error template parameter the dx::os_error itself will be thrown.

this is the generic device class. the template parameter defines the exception class to be thrown. the device class uses the driver interface helper class to construct the device object and to bind the device to the driver identified by the GUID.

example:

try{ // guard the block
// choose a driver
dx::driver<>driver(GUID_MYDEVICE);
// enumerate devices
std::cout<<driver.size()<<" device(s) found:"<<std::endl;
// go thru all devices; you have to lock the driver if this multi-threaded
for (dx::driver<>::iterator i=driver.begin();i!=driver.end();i++){
// select a device
dx::reference<dx::device<> >device=*i;
// return an int from an IOCTL served by the driver
int my_data=device->ioctl<int>(kMyIoctl);
}
catch(dx::os_result error) {
std::cerr << "OS aborted operation with error #" << error << std::endl;
}
}
Exceptions
incase of an error returned by the underlaying API the device class throws an exception converted from dx::os_result. with the default exception_t=dx::os_result template parameter the dx::os_result itself will be thrown.

Constructor & Destructor Documentation

template<class exception_t = os_result>
dx::device< exception_t >::device ( ::io_service_t  io_service)
throw (exception_t
)
inline

the device class constructor

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

Constructs and open device,

connects notification port

Parameters
io_servicethe IOService object to open the device connection for. This will be hold (but not retained) during device class lifetime
template<class exception_t = os_result>
virtual dx::device< exception_t >::~device ( )
inlinenoexcept

the device class destructor

the underlaying IOKit API is IOServiceClose().

remark: The io_service reference itself is managed by inherited io::reference

for detailed information see

Disconnect notification port,

closes the connection to the IOService object

template<class exception_t = os_result>
dx::device< exception_t >::device ( const creator creator)
throw (exception_t
)
inline

the device class constructor

the underlaying windows API is RegisterDeviceNotification(). for detailed information see http://msdn.microsoft.com/en-us/library/windows/desktop/aa363431(v=vs.85).aspx

Exceptions
n/amicrosoft does not give information about what possible errors values are provided by its OS

+ Here is the call graph for this function:

template<class exception_t = os_result>
virtual dx::device< exception_t >::~device ( )
inline

Member Function Documentation

template<class exception_t = os_result>
virtual void dx::device< exception_t >::conclude ( )
inlinevirtualnoexcept

conclude notification: device will be removed from tree

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

template<class exception_t = os_result>
virtual void dx::device< exception_t >::conclude ( )
inlinevirtual

conclude notifacation: device will be removed from tree

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

template<class exception_t = os_result>
void dx::device< exception_t >::ctl ( unsigned int  ioctl) const
throw (exception_t
)
inline

+ Here is the call graph for this function:

template<class exception_t = os_result>
void dx::device< exception_t >::ctl ( unsigned int  ioctl) const
throw (exception_t
)
inline

+ Here is the call graph for this function:

template<class exception_t = os_result>
template<typename rx_t >
rx_t dx::device< exception_t >::ictl ( unsigned int  ioctl) const
throw (exception_t
)
inline

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

+ Here is the caller graph for this function:

template<class exception_t = os_result>
template<typename rx_t >
size_t dx::device< exception_t >::ictl ( unsigned int  ioctl,
rx_t &  rx 
) const
throw (exception_t
)
inline

+ Here is the call graph for this function:

template<class exception_t = os_result>
template<typename rx_t >
rx_t dx::device< exception_t >::ictl ( unsigned int  ioctl) const
throw (exception_t
)
inline

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:

template<class exception_t = os_result>
template<typename rx_t >
size_t dx::device< exception_t >::ictl ( unsigned int  ioctl,
rx_t &  rx 
) const
throw (exception_t
)
inline

+ Here is the call graph for this function:

template<class exception_t = os_result>
template<typename rx_t , typename tx_t >
size_t dx::device< exception_t >::ioctl ( unsigned int  ioctl,
const tx_t &  tx,
rx_t &  rx 
) const
throw (exception_t
)
inline

+ Here is the caller graph for this function:

template<class exception_t = os_result>
template<typename rx_t , typename tx_t >
rx_t dx::device< exception_t >::ioctl ( unsigned int  ioctl,
const tx_t &  tx 
) const
throw (exception_t
)
inline

+ Here is the call graph for this function:

template<class exception_t = os_result>
size_t dx::device< exception_t >::ioctl ( unsigned int  ioctl,
const void *  tx = nullptr,
size_t  tx_size = 0,
void *  rx = nullptr,
size_t  rx_size = 0 
) const
throw (exception_t
)
inline
template<class exception_t = os_result>
template<typename tx_t , typename rx_t >
size_t dx::device< exception_t >::ioctl ( unsigned int  ioctl,
const tx_t &  tx,
rx_t &  rx 
) const
throw (exception_t
)
inline

+ Here is the call graph for this function:

template<class exception_t = os_result>
template<typename rx_t , typename tx_t >
rx_t dx::device< exception_t >::ioctl ( unsigned int  ioctl,
const tx_t &  tx 
) const
throw (exception_t
)
inline

+ Here is the call graph for this function:

template<class exception_t = os_result>
virtual void dx::device< exception_t >::launch ( )
throw (exception_t
)
inlinevirtual

launch notification: device mounted in tree and ready to use

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

+ Here is the caller graph for this function:

template<class exception_t = os_result>
virtual void dx::device< exception_t >::launch ( )
inlinevirtual

launch notifacation: device mounted in tree and ready to use

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

template<class exception_t = os_result>
template<typename tx_t >
void dx::device< exception_t >::octl ( unsigned int  ioctl,
const tx_t &  tx 
) const
throw (exception_t
)
inline

+ Here is the call graph for this function:

template<class exception_t = os_result>
template<typename tx_t >
void dx::device< exception_t >::octl ( unsigned int  ioctl,
const tx_t &  tx 
) const
throw (exception_t
)
inline

+ Here is the call graph for this function:

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::reference< io_registry_entry_t >::operator io_registry_entry_t * ( )
inlineinherited

auto converter into object pointer

template<class exception_t = os_result>
dx::device< exception_t >::operator::HANDLE ( ) const
inline

+ 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
template<class exception_t = os_result>
template<typename type_t >
type_t dx::io::registry< exception_t >::operator[] ( const char *  key) const
throw (exception_t
)
inlineinherited
template<class exception_t = os_result>
static void dx::exception< exception_t >::pass ( ::HRESULT  test)
throw (exception_t
)
inlinestaticinherited
template<class exception_t = os_result>
static void dx::exception< exception_t >::pass ( ::HRESULT  test)
throw (exception_t
)
inlinestaticinherited
template<class exception_t = os_result>
static void dx::exception< exception_t >::pass ( unsigned long  test)
throw (exception_t
)
inlinestaticinherited
template<class exception_t = os_result>
static void dx::exception< exception_t >::pass ( ::BOOL  test)
throw (exception_t
)
inlinestaticinherited

specialization for standard windows API BOOL return type

template<class exception_t = os_result>
static void dx::exception< exception_t >::pass ( ::HANDLE  test)
throw (exception_t
)
inlinestaticinherited

specialization for test validy of windows HANDLE type

template<class exception_t = os_result>
static void dx::exception< exception_t >::pass ( ::HWND  test)
throw (exception_t
)
inlinestaticinherited

specialization for test validy of windows HWND type - which is of course different from HANDLE

template<class exception_t = os_result>
static void dx::exception< exception_t >::pass ( ::ATOM  test)
throw (exception_t
)
inlinestaticinherited

specialization for standard windows API ATOM return type

template<>
static void dx::exception<::HRESULT >::pass ( unsigned long  test)
throw(::HRESULT
)
staticinherited
template<>
static void dx::exception<::HRESULT >::pass ( ::BOOL  test)
throw(::HRESULT
)
staticinherited
template<>
static void dx::exception<::HRESULT >::pass ( ::HANDLE  test)
throw(::HRESULT
)
staticinherited
template<>
static void dx::exception<::HRESULT >::pass ( ::HWND  test)
throw(::HRESULT
)
staticinherited
template<>
static void dx::exception<::HRESULT >::pass ( ::ATOM  test)
throw(::HRESULT
)
staticinherited
template<class exception_t = os_result>
template<class return_t >
static void dx::exception< exception_t >::pass ( return_t  value)
throw (exception_t
)
inlinestaticinherited

+ Here is the caller graph for this function:

template<class exception_t = os_result>
template<class return_t >
static void dx::exception< exception_t >::pass ( return_t  value)
throw (exception_t
)
inlinestaticinherited

+ Here is the caller graph for this function:

template<class exception_t = os_result>
template<class return_t >
static void dx::exception< exception_t >::pass ( bool  test,
return_t  value 
)
throw (exception_t
)
inlinestaticinherited
template<class exception_t = os_result>
template<class return_t >
static void dx::exception< exception_t >::pass ( bool  test,
return_t  value 
)
throw (exception_t
)
inlinestaticinherited
template<class exception_t = os_result>
static void dx::exception< exception_t >::pass_strict ( ::LONG  test)
throw (exception_t
)
inlinestaticinherited

+ Here is the caller graph for this function:

template<class exception_t = os_result>
static void dx::exception< exception_t >::pass_strict ( ::LONG  test)
throw (exception_t
)
inlinestaticinherited

+ Here is the caller graph for this function:

Member Data Documentation

template<class exception_t = os_result>
typedef::io_service_t dx::device< exception_t >::creator
template<class exception_t = os_result>
io::port<exception_t> dx::device< exception_t >::port
protected
template<class exception_t = os_result>
bool dx::device< exception_t >::removed =false

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

(c) copyright 2009 dynamic acoustics e.U. generated on Tue Dec 4 2018

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.