dx::service::client::device< desc_t, preference_t, stream_t > Class Template Reference

#include <dx_service_client_device.h>

Inheritance diagram for dx::service::client::device< desc_t, preference_t, stream_t >:

Collaboration diagram for dx::service::client::device< desc_t, preference_t, stream_t >:

Public Types
enum class	bus { usb = 'usb ' , pci = 'pci ' , vm = 'virt' }
typedef desc	desc_t
typedef dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > >	stream_t
typedef desc	value_t

Public Member Functions
struct stream *	align (struct stream *sync_reference)
uint32_t	align (uint32_t sync_reference) const
void	conclude () noexcept override
	dx_catchall_handler (this,) void conclude() noexcept override
	dx_catchall_rethrow () virtual uint64_t frame() const
uint32_t	enumerate (const format &format=any) const
	enumerate typified pins
void	exception (const dx::exception &exception, bool filtered=false) const noexcept override
struct stream *	find (const decltype(stream::target.idx())&target)
struct stream *	find (const format &format=any, enum direction::direction direction=direction::any)
struct stream *	find (const target_t &target)
struct stream *	find (uint32_t &pin, const format &format=any, enum direction::direction direction=direction::any)
	finds and returns the stream description and pin idx into this stream
virtual bool	hw_clock () const noexcept
void	hw_clock (abstract::event *) override
void	info (std::ostream &os) noexcept override
void	launch () override
bool	operator== (const desc &desc) const
virtual device &	operator>> (std::ostream &) const
_device &	reset ()
virtual void	sleep ()
	notify system will sleep stub
virtual bool	start (uint64_t=0, unsigned int starting=1)
virtual unsigned int	stop (bool force=false) noexcept
std::string	string (uint8_t)
uint32_t	sync_reference (struct stream *sync_reference)
struct stream *	sync_reference (uint32_t sync_reference)
void	wake () override

Public Attributes
enum dx::stream::desc::bus	bus
dx::promoted< typename super::client_map >	clients
abstract::event *	clock
uint32_t	clocks
	number of independent clocks [currenlty only single clock support]
std::atomic< size_t >	counter
dx::promoted< desc >::template preference< dx::preference, typename desc::value_t >	desc
bool	dflt
	can be selected as default (OS audio) device
dx::driver< decltype(id), dx::preference > &	driver
bool	editable
	can be edited
bool	hidden
	hide device
struct {
abstract::event *   clock
std::atomic< size_t >   counter
uint32_t   iosize
}	hw
promoted< std::string >::preference< decltype(dx::stream::control< dx::device< std::string, dx::preference > >::preference)>	icon
const std::string	id
bool	launched
struct dx::stream::desc::name_id	model
dx::stream::device::monitor	monitor
std::deque< std::function< void(control &)> >	notify
bool	persistence
	device has capability to store persistent settings (i.e. sample rate; clock source; etc.)
dx::preference	preference
std::string	puid
	persistent UID - system unique - could change with location
std::string	puuid
	persistent universal UID - universally unique ID (i.e. serial number)
direction::direction	start_stop_order = direction::any
std::atomic< unsigned int >	started
struct dx::stream::desc::stream	stream [max_streams]
std::map< decltype(desc::stream::target.idx()), std::weak_ptr< dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > > >	streams
promoted< uint32_t >::preference< decltype(dx::stream::control< dx::device< std::string, dx::preference > >::preference)>	sync_cycle_ticks
promoted< structdesc_t::stream * >::template preference< decltype(dx::stream::control< dx::device< std::string, dx::preference > >::preference), uint32_t >	sync_reference
struct dx::stream::desc::name_id	vendor
dx::stream::device::monitor	version

Protected Types
typedef service::request< service::stream::data< desc > >	request

Protected Member Functions
virtual void	flush ()
virtual void	halt ()

Protected Attributes
dx::service::client::_device::chain	clocksource
dx::service::client::_device::chain	iosize
pipe< request >	pipe
dx::service::client::_device::chain	safety_offset [dx::stream::direction::out]
dx::service::client::_device::chain	safety_offset_in [dx::stream::direction::in]
dx::service::client::_device::chain	safety_offset_out [dx::stream::direction::out]
dx::service::client::_device::chain	samplerate
std::recursive_mutex	start_stop_in_progress
	start/stop operation in progress

Member Typedef Documentation

desc_t

typedef desc dx::stream::device< dx::stream::control< dx::device< std::string, dx::preference > >, desc, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::desc

inherited

request

typedef service::request<service::stream::data<desc> > dx::service::client::_device< desc, dx::preference, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::request

protectedinherited

stream_t

typedef dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > dx::stream::device< dx::stream::control< dx::device< std::string, dx::preference > >, desc, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > >

inherited

value_t

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

typedef desc dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::value_t

inherited

Member Enumeration Documentation

bus

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

enum class dx::stream::desc::bus

stronginherited

Enumerator
usb
pci
vm

Member Function Documentation

align() [1/2]

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

struct stream * dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::align ( struct stream * sync_reference )

inlineinherited

align() [2/2]

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::align ( uint32_t sync_reference ) const

inlineinherited

conclude()

void dx::service::client::_device< desc, dx::preference, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::conclude ( )

inlineoverridevirtualnoexceptinherited

Reimplemented from dx::object.

dx_catchall_handler()

dx::stream::control< object_t >::dx_catchall_handler ( this )

inlineoverridenoexceptinherited

dx_catchall_rethrow()

dx::service::client::_device< desc, dx::preference, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::dx_catchall_rethrow ( ) const

inlineinherited

enumerate()

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::enumerate ( const format & format = any ) const

inlineinherited

enumerate typified pins

exception()

void dx::service::client::_device< desc, dx::preference, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::exception ( const dx::exception & exception, bool filtered = false ) const

inlineoverridevirtualnoexceptinherited

Reimplemented from dx::device< std::string, dx::preference >.

find() [1/4]

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

struct stream * dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::find ( const decltype(stream::target.idx())& target )

inlineinherited

find() [2/4]

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

struct stream * dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::find ( const format & format = any, enum direction::direction direction = direction::any )

inlineinherited

Parameters

format	search stream format filter
direction	search stream direction filter

find() [3/4]

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

struct stream * dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::find ( const target_t & target )

inlineinherited

find() [4/4]

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

struct stream * dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::find ( uint32_t & pin, const format & format = any, enum direction::direction direction = direction::any )

inlineinherited

finds and returns the stream description and pin idx into this stream

Returns

stream description of indexed pin, pin idx will be altered on return!

Parameters

pin	in: global pin index, out: pin index into returned stream description
format	search stream format filter
direction	search stream direction filter

Here is the caller graph for this function:

flush()

virtual void dx::stream::control< object_t >::flush ( )

inlineprotectedvirtualinherited

halt()

virtual void dx::stream::control< object_t >::halt ( )

inlineprotectedvirtualinherited

hw_clock() [1/2]

virtual bool dx::stream::device< dx::stream::control< dx::device< std::string, dx::preference > >, desc, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::hw_clock ( ) const

inlinevirtualnoexceptinherited

hw_clock() [2/2]

void dx::service::client::_device< desc, dx::preference, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::hw_clock ( abstract::event * )

inlineoverridevirtualinherited

Reimplemented from dx::stream::device< dx::stream::control< dx::device< std::string, dx::preference > >, desc, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >.

info()

void dx::service::client::_device< desc, dx::preference, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::info ( std::ostream & os )

inlineoverridevirtualnoexceptinherited

Reimplemented from dx::device< std::string, dx::preference >.

launch()

void dx::service::client::_device< desc, dx::preference, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::launch ( )

inlineoverridevirtualinherited

Reimplemented from dx::object.

operator==()

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

bool dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::operator== ( const desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations > & desc ) const

inlineinherited

operator>>()

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

inlinevirtualinherited

reset()

_device & dx::service::client::_device< desc, dx::preference, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::reset ( )

inlineinherited

sleep()

virtual void dx::device< std::string, dx::preference >::sleep ( )

inlinevirtualinherited

notify system will sleep stub

start()

virtual bool dx::stream::control< object_t >::start ( uint64_t = 0, unsigned int starting = 1 )

inlinevirtualinherited

result indicates if start changed the state.

stop()

virtual unsigned int dx::stream::control< object_t >::stop ( bool force = false )

inlinevirtualnoexceptinherited

result indicates the amount of stopped start references

string()

std::string dx::service::client::_device< desc, dx::preference, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::string ( uint8_t )

inlineinherited

sync_reference() [1/2]

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::sync_reference ( struct stream * sync_reference )

inlineinherited

sync_reference() [2/2]

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

struct stream * dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::sync_reference ( uint32_t sync_reference )

inlineinherited

wake()

void dx::stream::device< dx::stream::control< dx::device< std::string, dx::preference > >, desc, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::wake ( )

inlineoverrideinherited

Member Data Documentation

bus

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

enum dx::stream::desc::bus dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::bus

inherited

clients

dx::promoted<typename super::client_map> dx::service::client::_device< desc, dx::preference, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::clients

inherited

clock

abstract::event* dx::stream::device< dx::stream::control< dx::device< std::string, dx::preference > >, desc, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::clock

inherited

clocks

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clocks

inherited

number of independent clocks [currenlty only single clock support]

clocksource

dx::service::client::_device::chain dx::service::client::_device< desc, dx::preference, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::clocksource

protectedinherited

counter

std::atomic<size_t> dx::stream::device< dx::stream::control< dx::device< std::string, dx::preference > >, desc, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::counter

inherited

desc

dx::promoted<desc>::template preference<dx::preference, typename desc::value_t> dx::service::client::_device< desc, dx::preference, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::desc

inherited

dflt

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

bool dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::dflt

inherited

can be selected as default (OS audio) device

driver

dx::driver<decltype(id), dx::preference>& dx::device< std::string, dx::preference >::driver

inherited

editable

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

bool dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::editable

inherited

can be edited

hidden

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

bool dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::hidden

inherited

hide device

[struct]

struct { ... } dx::stream::device< dx::stream::control< dx::device< std::string, dx::preference > >, desc, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::hw

icon

promoted<std::string>::preference<decltype(dx::stream::control< dx::device< std::string, dx::preference > >::preference)> dx::stream::device< dx::stream::control< dx::device< std::string, dx::preference > >, desc, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::icon

inherited

id

const std::string dx::device< std::string, dx::preference >::id

inherited

iosize

dx::service::client::_device::chain dx::service::client::_device< desc, dx::preference, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::iosize

protectedinherited

launched

bool dx::object::launched

inherited

model

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

struct dx::stream::desc::name_id dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::model

inherited

monitor

dx::stream::device::monitor dx::stream::device< dx::stream::control< dx::device< std::string, dx::preference > >, desc, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::monitor

inherited

notify

std::deque<std::function<void(control&)> > dx::stream::control< object_t >::notify

inherited

persistence

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

bool dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::persistence

inherited

device has capability to store persistent settings (i.e. sample rate; clock source; etc.)

pipe

dx::service::client::_device::chain dx::service::client::_device< desc, dx::preference, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::pipe

protectedinherited

preference

dx::preference dx::device< std::string, dx::preference >::preference

inherited

puid

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

inherited

persistent UID - system unique - could change with location

puuid

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

inherited

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

safety_offset

dx::service::client::_device::chain dx::service::client::_device< desc, dx::preference, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::safety_offset

protectedinherited

safety_offset_in

dx::service::client::_device::chain dx::service::client::_device< desc, dx::preference, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::safety_offset_in[dx::stream::direction::in]

protectedinherited

safety_offset_out

dx::service::client::_device::chain dx::service::client::_device< desc, dx::preference, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::safety_offset_out[dx::stream::direction::out]

protectedinherited

samplerate

dx::service::client::_device::chain dx::service::client::_device< desc, dx::preference, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::samplerate

protectedinherited

start_stop_in_progress

std::recursive_mutex dx::stream::control< object_t >::start_stop_in_progress

protectedinherited

start/stop operation in progress

start_stop_order

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

direction::direction dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::start_stop_order = direction::any

inherited

started

std::atomic<unsigned int> dx::stream::control< object_t >::started

inherited

stream

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

struct dx::stream::desc::stream dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::stream[max_streams]

inherited

streams

std::map<decltype(desc::stream::target.idx()), std::weak_ptr<dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > >> > dx::stream::device< dx::stream::control< dx::device< std::string, dx::preference > >, desc, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::streams

inherited

sync_cycle_ticks

promoted<uint32_t>::preference<decltype(dx::stream::control< dx::device< std::string, dx::preference > >::preference)> dx::stream::device< dx::stream::control< dx::device< std::string, dx::preference > >, desc, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::sync_cycle_ticks

inherited

sync_reference

promoted<structdesc_t::stream*>::template preference<decltype(dx::stream::control< dx::device< std::string, dx::preference > >::preference), uint32_t> dx::stream::device< dx::stream::control< dx::device< std::string, dx::preference > >, desc, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::sync_reference

inherited

vendor

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

struct dx::stream::desc::name_id dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::vendor

inherited

version

dx::stream::device::monitor dx::stream::device< dx::stream::control< dx::device< std::string, dx::preference > >, desc, dx::stream::shared::stream< device< desc, dx::preference, dx::stream::shared::stream > > >::version

inherited

---

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

• dx_service_client_device.h