dxd - dynax driver framework 3.0.0d222
cross platform open source driver development framework
Loading...
Searching...
No Matches
dx::usb::device< preference_t > Class Template Reference

#include <dx_usb_device.h>

Inheritance diagram for dx::usb::device< preference_t >:
Collaboration diagram for dx::usb::device< preference_t >:

Public Types

typedef shared::event event_t

Public Member Functions

device & close (bool force=false) noexcept
void conclude () noexcept override
 conclude notifacation: device will be removed from tree
uint8_t configurations () const
auto count () const noexcept
auto count () const noexcept
void ctl (uint32_t ioctl) const try
 dx_catchall_rethrow (, "name: %s, access rights: %x, sharing options:%x", name, access, share)
 dx_pass (::IOConnectCallStructMethod(io_connect, ioctl, nullptr, 0, &rx, &size), "%s rx:%p size:%d", fourchar::to::string(ioctl).c_str(), &rx, size)
uint64_t frame (int64_t *timestamp=nullptr) const try
 current bus frame number; timestamp: dx::timestamp() of the readout
value_t get (::CFStringRef key) const
::CFTypeRef get (::CFStringRef key) const
::CFTypeRef get (::CFStringRef key) const
value_t get (::CFStringRef key, ::CFTypeRef dflt) const noexcept
::CFTypeRef get (::CFStringRef key, ::CFTypeRef dflt) const noexcept
::CFTypeRef get (::CFStringRef key, ::CFTypeRef dflt) const noexcept
value_t get (::CFStringRef key, value_t dflt) const noexcept
value_t get (::CFStringRef key, value_t dflt) const noexcept
value_t get (key_t key) const
::CFTypeRef get (key_t key) const
::CFTypeRef get (key_t key) const
rx_t ictl (unsigned int ioctl) const
 Windows: member ioctl.
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) try
 (re-)initialization the underlaying windows API is CreateFile(). for detailed information see http://msdn.microsoft.com/en-us/library/aa363858(VS.85).aspx
rx_t ioctl (unsigned int ioctl, const tx_t &tx) const
size_t ioctl (unsigned int ioctl, const tx_t &tx, rx_t &rx) const
void launch () override
 launch notification: object mounted and ready to use. Called only through try_launch() - never call this directly from outside the class hierarchy.
void octl (unsigned int ioctl, const tx_t &tx) const
device & open ()
 opens the USB device for exclusice access
 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 const ::io_registry_entry_t & () const noexcept
 auto converter into const io_object
 operator const os_event () const noexcept
 operator const std::string & () const noexcept
 identifying device string, mirroring macOS' io::registry conversion
 operator os_event () noexcept
 operator uint64_t () const
 operator uint64_t () const
::IOUSBDeviceInterface650 * operator-> () const
 operator::CFMutableDictionaryRef () const
 operator::CFMutableDictionaryRef () const
 operator::CFStringRef () const
 operator::CFStringRef () const
 operator::HANDLE () const noexcept
 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
 operator::io_registry_entry_t * () noexcept
 auto converter into io_object pointer
 operator::io_registry_entry_t * () noexcept
 auto converter into io_object pointer
 operator::io_registry_entry_t * () noexcept
 auto converter into io_object pointer
 operator::IOUSBDeviceInterface650 ** () const
bool operator== (::io_registry_entry_t io_object) const noexcept
bool operator== (::io_registry_entry_t io_object) const noexcept
virtual device & operator>> (std::ostream &) const
virtual device & operator>> (std::ostream &) const
::CFTypeRef operator[] (::CFStringRef key) const
::CFTypeRef operator[] (::CFStringRef key) const
::CFTypeRef operator[] (key_t key) const
::CFTypeRef operator[] (key_t key) const
registry parent () const
registry parent () const
device & reenumerate ()
referenceretain ()
referenceretain ()
registryset (::CFStringRef key, ::CFTypeRef value)
registryset (::CFStringRef key, ::CFTypeRef value)
registryset (::CFStringRef key, value_t value)
registryset (::CFStringRef key, value_t value)
device & 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.
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.
registryset (key_t key, ::CFTypeRef value)
registryset (key_t key, ::CFTypeRef value)
registryset (key_t key, value_t value)
registryset (key_t key, value_t value)
virtual void sleep ()
 notify system will sleep stub
virtual void sleep ()
 notify system will sleep stub
device & submit (const request< data_t > &request, bool autoclear=true) const try
bool try_conclude () noexcept
 atomically conclude()s if currently launched; returns whether this call did it
bool try_conclude () noexcept
 atomically conclude()s if currently launched; returns whether this call did it
bool try_launch ()
 atomically launch()es if not already launched; returns whether this call did it
bool try_launch ()
 atomically launch()es if not already launched; returns whether this call did it
virtual void wake ()
 notify system wake completed stub
virtual void wake ()
 notify system wake completed stub

Static Public Member Functions

static void create (const char *product_id, const ::GUID &guid, const std::string &id, const desc_t &desc)
 persisted software device: PnP keeps it enumerated after the creating handle closes
static void destroy (const char *product_id, const ::GUID &guid, const std::string &id)
 re-acquires the persisted device and binds it to the closing handle; PnP keeps the removed device's node as a phantom, uninstalled here
static std::pair< std::string, std::string > identity (::io_service_t id)
 the device class constructor

Public Attributes

cf::string bundle_id
bool composite
 indicate WinUSB matched against single interface of composite device;
dx::driver< decltype(id), dx::preference > & driver
dx::driver< decltype(id), dx::preference > & driver
::WINUSB_INTERFACE_HANDLE handle
const ::io_service_t id
const ::io_service_t id
std::atomic< bool > launched
std::atomic< bool > launched
dx::preference preference
dx::preference preference
std::string puid
 persistent UID - system unique - could change with location
std::string puid
 persistent UID - system unique - could change with location
std::string puuid
 persistent universal UID - universally unique ID (i.e. serial number)
std::string puuid
 persistent universal UID - universally unique ID (i.e. serial number)
return size
enum speed speed
rx_t &rx const try

Protected Types

typedef service::request< service::stream::data< typename super_device_t::desc_t > > request
typedef pipe< request >::template server< user_client, std::weak_ptr< device > > server
 pipe::server connecting user_clients The pipe holds a std::weak_ptr<device> as a temporary by the pipe::server::args variadic tuple to create shared device references for the user_client. At time of device construction there is not yet a std::shared_ptr<device>, therefore the pipe::server::args weak_ptr assignment happens at service::device::launch().
enum  type

Protected Member Functions

std::string canonical (const std::string &name) const try
 catch (...)
 catch (...)
virtual void conclude () noexcept
 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. Called only through try_conclude() - never call this directly from outside the class hierarchy.
 dx_catchall_rethrow () registry(const registry &registry
registryerase (const char *subkey=nullptr) noexcept
void grouped (typename super::group_t &group) override
void initialize (::IOCFPlugInInterface **cf_interface, ::CFUUIDRef uuid)
registryinitialize (const std::string &key, ::HKEY root=HKEY_CURRENT_USER, ::REGSAM rights=KEY_ALL_ACCESS) try
registryinitialize (const std::string &key, ::REGSAM rights, ::HKEY root, const char *path=nullptr) try
virtual void launch ()
 launch notification: object mounted and ready to use. Called only through try_launch() - never call this directly from outside the class hierarchy.
registryrun ()
dx_catchall_rethrow() registry &initialize(size_t size () const noexcept

Static Protected Member Functions

static self_t void assign (const self_t &self, const value_t &value) try
static registry at (const self_t &self)
static container_t children (const self_t &self) noexcept try
static bool fetch (const self_t &self, value_t &value) try
static bool nested (const self_t &self) noexcept
static size_t size (const self_t &self) noexcept

Protected Attributes

class dx::service::device::promoted clocksource
bool connected
std::unique_ptr< uint8_t[]> descriptors
 the selected configuration's complete descriptor, wTotalLength bytes
std::list< promoted > group_server
 per-group chains, wired as each group comes into existence (grouped())
struct { 
   cf::string   bundle_id 
   cf::string   class_name 
kernel
std::string key
const std::string & key
std::deque< std::function< void()> > listen
std::atomic< int > opened
const std::string owns_root
class dx::service::device::promoted pipe
server pipe
io::port port
::HANDLE process
const std::string root
class dx::service::device::promoted samplerate
bool schedule_erase
struct { 
   ::WINUSB_INTERFACE_HANDLE   handle 
winusb

Member Typedef Documentation

◆ event_t

typedef shared::event dx::service::device< dx::preference >::event_t
inherited

◆ request

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

◆ server

typedef pipe<request>::template server<user_client, std::weak_ptr<device> > dx::service::device< dx::preference >::server
protectedinherited

pipe::server connecting user_clients The pipe holds a std::weak_ptr<device> as a temporary by the pipe::server::args variadic tuple to create shared device references for the user_client. At time of device construction there is not yet a std::shared_ptr<device>, therefore the pipe::server::args weak_ptr assignment happens at service::device::launch().

Member Enumeration Documentation

◆ type

enum dx::registry::type : ::DWORD
strongprotectedinherited

Member Function Documentation

◆ assign()

self_t void dx::registry::assign ( const self_t & self,
const value_t & value )
inlinestaticprotectedinherited

◆ at()

registry dx::registry::at ( const self_t & self)
inlinestaticprotectedinherited

dx::key_value_tree<registry> contract: resolves self's parent chain into one real key/value position, then delegates below - the only place a registry[k1][k2]..[kN] chain becomes real subkeys/values.

◆ canonical()

std::string dx::registry::canonical ( const std::string & name) const
inlineprotectedinherited

◆ catch() [1/2]

dx::registry::catch ( ...)
inlineprotectedinherited

◆ catch() [2/2]

dx::registry::catch ( ...)
inlineprotectedinherited

◆ children()

container_t dx::registry::children ( const self_t & self)
inlinestaticprotectednoexceptinherited

self's own child names as any string container, yielding an empty one when the key is absent or inaccessible. Stays a static, not a dx::key_value_tree-style operator container_t(): registry is a dependent base of key_value_tree<registry> (inherited via the tree_t template parameter), and key_value_tree's own operator value_t() becomes entirely unreachable once a dependent base declares a same-shaped operator container_t() template of its own.

◆ close()

device & dx::usb::platform::device< dx::preference >::close ( bool force = false)
inlinenoexceptinherited

◆ conclude() [1/2]

virtual void dx::object::conclude ( )
inlineprotectedvirtualnoexceptinherited

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. Called only through try_conclude() - never call this directly from outside the class hierarchy.

◆ conclude() [2/2]

void dx::proxy::device< dx::preference >::conclude ( )
inlineoverridenoexceptinherited

conclude notifacation: device will be removed from tree

◆ configurations()

uint8_t dx::usb::platform::device< dx::preference >::configurations ( ) const
inlineinherited

◆ count() [1/2]

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

◆ count() [2/2]

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

◆ create()

void dx::proxy::device< dx::preference >::create ( const char * product_id,
const ::GUID & guid,
const std::string & id,
const desc_t & desc )
inlinestaticinherited

persisted software device: PnP keeps it enumerated after the creating handle closes

◆ ctl()

void dx::proxy::device< dx::preference >::ctl ( uint32_t ioctl) const
inlineinherited

◆ destroy()

void dx::proxy::device< dx::preference >::destroy ( const char * product_id,
const ::GUID & guid,
const std::string & id )
inlinestaticinherited

re-acquires the persisted device and binds it to the closing handle; PnP keeps the removed device's node as a phantom, uninstalled here

◆ dx_catchall_rethrow() [1/2]

dx::registry::dx_catchall_rethrow ( ) const &
protectedinherited

cheap: purely in-memory identity extension with a bare child name - what dx::key_value_tree::operator[] builds on.

◆ dx_catchall_rethrow() [2/2]

dx::file::dx_catchall_rethrow ( "name: % s,
access rights:% x,
sharing options:%x" ,
name ,
access ,
share  )
inherited

◆ dx_pass()

dx::proxy::device< dx::preference >::dx_pass ( ::IOConnectCallStructMethod( io_connect, ioctl, nullptr, 0, &rx, &size) ,
"%s rx:%p size:%d" ,
fourchar::to::string(ioctl).c_str() ,
& rx,
size  )
inherited

◆ erase()

registry & dx::registry::erase ( const char * subkey = nullptr)
inlineprotectednoexceptinherited

◆ fetch()

bool dx::registry::fetch ( const self_t & self,
value_t & value )
inlinestaticprotectedinherited

a value that serializes itself into a tree node recurses through its own named children; only what has no such serialization reaches the flat position below, where a struct would become one opaque REG_BINARY of its layout

◆ frame()

uint64_t dx::usb::platform::device< dx::preference >::frame ( int64_t * timestamp = nullptr) const
inlineinherited

current bus frame number; timestamp: dx::timestamp() of the readout

◆ get() [1/11]

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

◆ get() [2/11]

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

◆ get() [3/11]

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

◆ get() [4/11]

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

◆ get() [5/11]

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

◆ get() [6/11]

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

◆ get() [7/11]

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

◆ get() [8/11]

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

◆ get() [9/11]

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

◆ get() [10/11]

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

◆ get() [11/11]

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

◆ grouped()

void dx::service::device< dx::preference >::grouped ( typename super::group_t & group)
inlineoverrideprotectedinherited

◆ ictl() [1/2]

rx_t dx::proxy::device< dx::preference >::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

◆ ictl() [2/2]

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

◆ identity()

std::pair< std::string, std::string > dx::usb::platform::device< dx::preference >::identity ( ::io_service_t id)
inlinestaticinherited

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

the registry holds the device's string descriptors before anyone opens it: vendor, product and serial name the device, the path locates it; without a serial the path stands for both

◆ initialize() [1/4]

void cf::interface< ::IOUSBDeviceInterface650 >::initialize ( ::IOCFPlugInInterface ** cf_interface,
::CFUUIDRef uuid )
inlineprotectedinherited

◆ initialize() [2/4]

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

(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/amicrosoft does not give information about what possible errors values are provided by its OS

◆ initialize() [3/4]

registry & dx::registry::initialize ( const std::string & key,
::HKEY root = HKEY_CURRENT_USER,
::REGSAM rights = KEY_ALL_ACCESS )
inlineprotectedinherited

◆ initialize() [4/4]

registry & dx::registry::initialize ( const std::string & key,
::REGSAM rights,
::HKEY root,
const char * path = nullptr )
inlineprotectedinherited

◆ ioctl() [1/2]

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

◆ ioctl() [2/2]

size_t dx::proxy::device< dx::preference >::ioctl ( unsigned int ioctl,
const tx_t & tx,
rx_t & rx ) const
inlineinherited

◆ launch() [1/2]

virtual void dx::object::launch ( )
inlineprotectedvirtualinherited

launch notification: object mounted and ready to use. Called only through try_launch() - never call this directly from outside the class hierarchy.

◆ launch() [2/2]

void dx::service::device< dx::preference >::launch ( )
inlineoverrideinherited

launch notification: object mounted and ready to use. Called only through try_launch() - never call this directly from outside the class hierarchy.

◆ nested()

bool dx::registry::nested ( const self_t & self)
inlinestaticprotectednoexceptinherited

◆ octl()

void dx::proxy::device< dx::preference >::octl ( unsigned int ioctl,
const tx_t & tx ) const
inlineinherited

◆ open()

device & dx::usb::platform::device< dx::preference >::open ( )
inlineinherited

opens the USB device for exclusice access

◆ operator const ::io_registry_entry_t &() [1/3]

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/3]

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 &() [3/3]

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

auto converter into const io_object

◆ operator const os_event()

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

◆ operator const std::string &()

dx::proxy::device< dx::preference >::operator const std::string & ( ) const
inlinenoexceptinherited

identifying device string, mirroring macOS' io::registry conversion

◆ operator os_event()

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

◆ operator uint64_t() [1/2]

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

◆ operator uint64_t() [2/2]

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

◆ operator->()

::IOUSBDeviceInterface650 * cf::interface< ::IOUSBDeviceInterface650 >::operator-> ( ) const
inlineinherited

◆ operator::CFMutableDictionaryRef() [1/2]

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

◆ operator::CFMutableDictionaryRef() [2/2]

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

◆ operator::CFStringRef() [1/2]

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

◆ operator::CFStringRef() [2/2]

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

◆ operator::HANDLE()

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

◆ operator::io_registry_entry_t &() [1/3]

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

auto converter into io_object

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

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

auto converter into io_object

◆ operator::io_registry_entry_t &() [3/3]

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

auto converter into io_object

◆ operator::io_registry_entry_t *() [1/3]

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

auto converter into io_object pointer

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

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

auto converter into io_object pointer

◆ operator::io_registry_entry_t *() [3/3]

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

auto converter into io_object pointer

◆ operator::IOUSBDeviceInterface650 **()

cf::interface< ::IOUSBDeviceInterface650 >::operator ::IOUSBDeviceInterface650 ** ( ) const
inlineinherited

◆ operator==() [1/2]

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

◆ operator==() [2/2]

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

◆ operator>>() [1/2]

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

◆ operator>>() [2/2]

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

◆ operator[]() [1/4]

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

◆ operator[]() [2/4]

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

◆ operator[]() [3/4]

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

◆ operator[]() [4/4]

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

◆ parent() [1/2]

registry io::registry::parent ( ) const
inlineinherited

◆ parent() [2/2]

registry io::registry::parent ( ) const
inlineinherited

◆ reenumerate()

device & dx::usb::platform::device< dx::preference >::reenumerate ( )
inlineinherited

◆ retain() [1/2]

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

◆ retain() [2/2]

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

◆ run()

registry & dx::registry::run ( )
inlineprotectedinherited

◆ set() [1/10]

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

◆ set() [2/10]

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

◆ set() [3/10]

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

◆ set() [4/10]

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

◆ set() [5/10]

device & dx::proxy::device< dx::preference >::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.

◆ set() [6/10]

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.

◆ set() [7/10]

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

◆ set() [8/10]

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

◆ set() [9/10]

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

◆ set() [10/10]

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

◆ size() [1/2]

dx_catchall_rethrow() registry &initialize(size_t dx::registry::size ( ) const
inlineprotectednoexceptinherited

stays a named method: base and derived conversion function templates are simultaneous overload candidates, so an operator value_t() here would compete with dx::key_value_tree's own. like get<value_t>() but returns false for ERROR_FILE_NOT_FOUND, from either RegQueryValueExA or value_of() itself; any other failure throws. a sibling thread/process may delete the containing key between value_of()'s create and the set - retry recreates the whole chain in that case subkey+value count, 0 if the key doesn't exist (key_of()'s non-throwing overload - an ordinary, expected outcome here, not a genuine error).

◆ size() [2/2]

size_t dx::registry::size ( const self_t & self)
inlinestaticprotectednoexceptinherited

◆ sleep() [1/2]

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

notify system will sleep stub

◆ sleep() [2/2]

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

notify system will sleep stub

◆ submit()

device & dx::usb::platform::device< dx::preference >::submit ( const request< data_t > & request,
bool autoclear = true ) const
inlineinherited

◆ try_conclude() [1/2]

bool dx::object::try_conclude ( )
inlinenoexceptinherited

atomically conclude()s if currently launched; returns whether this call did it

◆ try_conclude() [2/2]

bool dx::object::try_conclude ( )
inlinenoexceptinherited

atomically conclude()s if currently launched; returns whether this call did it

◆ try_launch() [1/2]

bool dx::object::try_launch ( )
inlineinherited

atomically launch()es if not already launched; returns whether this call did it

◆ try_launch() [2/2]

bool dx::object::try_launch ( )
inlineinherited

atomically launch()es if not already launched; returns whether this call did it

◆ wake() [1/2]

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

notify system wake completed stub

◆ wake() [2/2]

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

notify system wake completed stub

Member Data Documentation

◆ bundle_id

◆ clocksource

◆ composite

bool dx::usb::platform::device< dx::preference >::composite
inherited

indicate WinUSB matched against single interface of composite device;

◆ connected

bool dx::proxy::device< dx::preference >::connected
protectedinherited

◆ descriptors

template<typename preference_t = dx::preference>
std::unique_ptr<uint8_t[]> dx::usb::device< preference_t >::descriptors
protected

the selected configuration's complete descriptor, wTotalLength bytes

◆ driver [1/2]

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

◆ driver [2/2]

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

◆ group_server

std::list<promoted> dx::service::device< dx::preference >::group_server
protectedinherited

per-group chains, wired as each group comes into existence (grouped())

◆ handle

::WINUSB_INTERFACE_HANDLE dx::usb::platform::device< dx::preference >::handle
inherited

◆ id [1/2]

const ::io_service_t dx::device< ::io_service_t, dx::preference >::id
inherited

◆ id [2/2]

const ::io_service_t dx::device< ::io_service_t, dx::preference >::id
inherited

◆ [struct]

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

◆ key [1/2]

std::string dx::registry::key
protectedinherited

◆ key [2/2]

const std::string& dx::registry::key
protectedinherited

◆ launched [1/2]

std::atomic<bool> dx::object::launched
inherited

◆ launched [2/2]

std::atomic<bool> dx::object::launched
inherited

◆ listen

std::deque<std::function<void()> > dx::registry::listen
protectedinherited

◆ opened

std::atomic< int > dx::usb::platform::device< dx::preference >::opened
protectedinherited
Todo
add runloop ////////////////////////////////////////////////////////////////////////////

◆ owns_root

const std::string dx::registry::owns_root
protectedinherited

◆ pipe [1/2]

◆ pipe [2/2]

◆ port

io::port dx::proxy::device< dx::preference >::port
protectedinherited

◆ preference [1/2]

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

◆ preference [2/2]

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

◆ process

::HANDLE dx::resource< invalid_t >::process
protectedinherited

◆ puid [1/2]

std::string dx::device< ::io_service_t, dx::preference >::puid
inherited

persistent UID - system unique - could change with location

◆ puid [2/2]

std::string dx::device< ::io_service_t, dx::preference >::puid
inherited

persistent UID - system unique - could change with location

◆ puuid [1/2]

std::string dx::device< ::io_service_t, dx::preference >::puuid
inherited

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

◆ puuid [2/2]

std::string dx::device< ::io_service_t, dx::preference >::puuid
inherited

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

◆ root

const std::string dx::registry::root
protectedinherited

◆ samplerate

◆ schedule_erase

bool dx::registry::schedule_erase
protectedinherited

◆ size

return dx::proxy::device< dx::preference >::size
inherited

◆ speed

◆ try

rx_t& rx const dx::proxy::device< dx::preference >::try
inherited

◆ [struct]

struct { ... } dx::usb::platform::device< dx::preference >::winusb

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

(c) copyright 2009 dynamic acoustics e.U. generated on

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.