dx::file Class Reference

an open handle to a device interface - what every ioctl of a proxy device goes through More...

#include <dx_proxy.h>

Inheritance diagram for dx::file:

Collaboration diagram for dx::file:

Public Member Functions
void	ctl (unsigned int ioctl) const
	file (const char *name, ::DWORD access=GENERIC_READ|GENERIC_WRITE, ::DWORD share=FILE_SHARE_READ|FILE_SHARE_WRITE)
	the device class constructor
virtual void	free () noexcept
template<typename rx_t>
rx_t	ictl (unsigned int ioctl) const
	Windows: member ioctl.
template<typename rx_t>
size_t	ictl (unsigned int ioctl, rx_t &rx) const
void	initialize (const char *name, ::DWORD access=GENERIC_READ|GENERIC_WRITE, ::DWORD share=FILE_SHARE_READ|FILE_SHARE_WRITE)
	(re-)initialization the underlaying windows API is CreateFile(). for detailed information see http://msdn.microsoft.com/en-us/library/aa363858(VS.85).aspx
template<typename rx_t, typename tx_t>
rx_t	ioctl (unsigned int ioctl, const tx_t &tx) const
template<typename tx_t, typename rx_t>
size_t	ioctl (unsigned int ioctl, const tx_t &tx, rx_t &rx) const
template<typename tx_t>
void	octl (unsigned int ioctl, const tx_t &tx) const
	operator const os_event () const noexcept
	operator os_event () noexcept
	operator::HANDLE () const noexcept

Protected Attributes
::HANDLE	handle {invalid_t}
::HANDLE	process {::GetCurrentProcess()}

Detailed Description

an open handle to a device interface - what every ioctl of a proxy device goes through

Constructor & Destructor Documentation

file()

dx::file::file ( const char * name, ::DWORD access = GENERIC_READ| GENERIC_WRITE, ::DWORD share = FILE_SHARE_READ| FILE_SHARE_WRITE )

inline

the device class constructor

Here is the call graph for this function:

Member Function Documentation

ctl()

void dx::file::ctl ( unsigned int ioctl ) const

inline

Here is the call graph for this function:

free()

template<::HANDLE invalid_t = INVALID_HANDLE_VALUE>

virtual void dx::resource< invalid_t >::free ( )

inlinevirtualnoexceptinherited

Reimplemented in dx::coreaudio::pod::stream< device_t, circular_t >, dx::pipe< rcv_t >, dx::pipe< dx::service::request< service::stream::data< desc > > >, dx::pipe< dx::service::request< service::stream::data< desc_t > > >, dx::pipe< dx::service::request< service::stream::data< typename device_t::desc_t > > >, dx::pipe< request >, dx::pipe< request_t >, dx::service::manager::promoted, dx::shared::memory< buffer_t >, dx::shared::memory< buffer_t >, dx::shared::memory< circular_t >, dx::shared::memory< circular_t >, dx::shared::memory< dx::circular >, dx::shared::memory< dx::stream::clock::monitor >, dx::shared::memory< dx::stream::clock::monitor >, dx::stream::shared::stream< device_t, circular_t, super_stream_t, event_t >, dx::stream::shared::stream< device_t, circular_t >, dx::stream::shared::stream< device_t, circular_t, super_stream_t, event_t >, dx::stream::shared::stream< device_t, dx::circular >, dx::stream::stream< device_t, dx::circular, usb::pipe< device_t > >, dx::template server< request >, dx::template server< user_client, std::weak_ptr< device > >, and dx::usb::stream::pipe< device_t, circular_t, stream_t >.

Here is the caller graph for this function:

ictl() [1/2]

template<typename rx_t>

rx_t dx::file::ictl ( unsigned int ioctl ) const

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/a	microsoft does not give information about what possible errors values are provided by its OS other than
ERROR_INSUFFICIENT_BUFFER	if the output buffer is too small to receive any data

Template Parameters

rx_t	type of rx_t needs to be explicitly specified as it can't be deduced

Here is the call graph for this function:

ictl() [2/2]

template<typename rx_t>

size_t dx::file::ictl ( unsigned int ioctl, rx_t & rx ) const

inline

Here is the call graph for this function:

initialize()

void dx::file::initialize ( const char * name, ::DWORD access = GENERIC_READ| GENERIC_WRITE, ::DWORD share = FILE_SHARE_READ| FILE_SHARE_WRITE )

inline

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

Exceptions

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

Here is the call graph for this function:

Here is the caller graph for this function:

ioctl() [1/2]

template<typename rx_t, typename tx_t>

rx_t dx::file::ioctl ( unsigned int ioctl, const tx_t & tx ) const

inline

Here is the call graph for this function:

ioctl() [2/2]

template<typename tx_t, typename rx_t>

size_t dx::file::ioctl ( unsigned int ioctl, const tx_t & tx, rx_t & rx ) const

inline

Here is the call graph for this function:

Here is the caller graph for this function:

octl()

template<typename tx_t>

void dx::file::octl ( unsigned int ioctl, const tx_t & tx ) const

inline

Here is the call graph for this function:

operator const os_event()

template<::HANDLE invalid_t = INVALID_HANDLE_VALUE>

dx::resource< invalid_t >::operator const os_event ( ) const

inlinenoexceptinherited

operator os_event()

template<::HANDLE invalid_t = INVALID_HANDLE_VALUE>

dx::resource< invalid_t >::operator os_event ( )

inlinenoexceptinherited

operator::HANDLE()

template<::HANDLE invalid_t = INVALID_HANDLE_VALUE>

dx::resource< invalid_t >::operator::HANDLE ( ) const

inlinenoexceptinherited

Here is the caller graph for this function:

Member Data Documentation

handle

template<::HANDLE invalid_t = INVALID_HANDLE_VALUE>

::HANDLE dx::resource< invalid_t >::handle {invalid_t}

protectedinherited

process

template<::HANDLE invalid_t = INVALID_HANDLE_VALUE>

::HANDLE dx::resource< invalid_t >::process {::GetCurrentProcess()}

protectedinherited

---

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

• dx_proxy.h