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
typedef desc_t	desc_t
typedef stream_t	stream_t

Public Member Functions
void	conclude () noexcept override
	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.
	dx_catchall_handler (this,) void conclude() noexcept override
	dx_catchall_rethrow () virtual uint64_t frame() const
void	exception (const dx::exception &exception, bool filtered=false) const noexcept override
	notification exception handler
virtual bool	hw_clock () const noexcept
void	hw_clock (abstract::event *) override
void	info (std::ostream &os) noexcept override
	log object class information
void	launch () override
	launch notification: object mounted and ready to use
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)
void	wake () override

Public Attributes
dx::promoted< typename super::client_map >	clients
abstract::event *	clock
std::atomic< size_t >	counter
dx::promoted< desc_t >::template preference< preference_t, typename desc_t::value_t >	desc {this->preference}
dx::driver< decltype(id), preference_t > &	driver
struct {
abstract::event *   clock
std::atomic< size_t >   counter
uint32_t   iosize
}	hw
dx::promoted< std::string >::template preference< preference_t, const char * >	icon
const dx::guid	id
bool	launched {}
dx::stream::device::monitor	monitor
std::deque< std::function< void(control &)>	notify )
preference_t	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)
std::atomic< unsigned int >	started
std::map< decltype(_desc_t::stream::target.idx()), std::weak_ptr< stream_t > >	streams
promoted< uint32_t >::preference< decltype(super_device_t::preference)>	sync_cycle_ticks
promoted< structdesc_t::stream * >::template preference< decltype(super_device_t::preference), uint32_t >	sync_reference
dx::stream::device::monitor	version

Protected Types
typedef service::request< service::stream::data< desc_t > >	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 {this->id}
dx::service::client::_device::chain	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_t dx::stream::device< dx::stream::control< dx::device< dx::guid, preference_t > > , desc_t , stream_t >::desc_t

inherited

request

template<typename desc_t , typename preference_t , typename stream_t >

typedef service::request<service::stream::data<desc_t> > dx::service::client::_device< desc_t, preference_t, stream_t >::request

protectedinherited

stream_t

typedef stream_t dx::stream::device< dx::stream::control< dx::device< dx::guid, preference_t > > , desc_t , stream_t >::stream_t

inherited

Member Function Documentation

conclude()

template<typename desc_t , typename preference_t , typename stream_t >

void dx::service::client::_device< desc_t, preference_t, stream_t >::conclude ( )

inlineoverridevirtualnoexceptinherited

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.

Reimplemented from dx::object.

dx_catchall_handler()

dx::stream::control< dx::device< dx::guid, preference_t > >::dx_catchall_handler ( this )

inlineoverridenoexceptinherited

dx_catchall_rethrow()

template<typename desc_t , typename preference_t , typename stream_t >

dx::service::client::_device< desc_t, preference_t, stream_t >::dx_catchall_rethrow ( ) const

inlineinherited

exception()

template<typename desc_t , typename preference_t , typename stream_t >

void dx::service::client::_device< desc_t, preference_t, stream_t >::exception ( const dx::exception & exception, bool filtered = false ) const

inlineoverridevirtualnoexceptinherited

notification exception handler

Reimplemented from dx::device< dx::guid, preference_t >.

flush()

virtual void dx::stream::control< dx::device< dx::guid, preference_t > >::flush ( )

inlineprotectedvirtualinherited

halt()

virtual void dx::stream::control< dx::device< dx::guid, preference_t > >::halt ( )

inlineprotectedvirtualinherited

hw_clock() [1/2]

virtual bool dx::stream::device< dx::stream::control< dx::device< dx::guid, preference_t > > , desc_t , stream_t >::hw_clock ( ) const

inlinevirtualnoexceptinherited

hw_clock() [2/2]

template<typename desc_t , typename preference_t , typename stream_t >

void dx::service::client::_device< desc_t, preference_t, stream_t >::hw_clock ( abstract::event * )

inlineoverridevirtualinherited

Reimplemented from dx::stream::device< dx::stream::control< dx::device< dx::guid, preference_t > >, desc_t, stream_t >.

info()

template<typename desc_t , typename preference_t , typename stream_t >

void dx::service::client::_device< desc_t, preference_t, stream_t >::info ( std::ostream & os )

inlineoverridevirtualnoexceptinherited

log object class information

Reimplemented from dx::stream::device< dx::stream::control< dx::device< dx::guid, preference_t > >, desc_t, stream_t >.

launch()

template<typename desc_t , typename preference_t , typename stream_t >

void dx::service::client::_device< desc_t, preference_t, stream_t >::launch ( )

inlineoverridevirtualinherited

launch notification: object mounted and ready to use

Reimplemented from dx::object.

Here is the call graph for this function:

operator>>()

virtual device & dx::device< dx::guid , preference_t >::operator>> ( std::ostream & ) const

inlinevirtualinherited

reset()

template<typename desc_t , typename preference_t , typename stream_t >

_device & dx::service::client::_device< desc_t, preference_t, stream_t >::reset ( )

inlineinherited

sleep()

virtual void dx::device< dx::guid , preference_t >::sleep ( )

inlinevirtualinherited

notify system will sleep stub

start()

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

inlinevirtualinherited

result indicates if start changed the state.

stop()

virtual unsigned int dx::stream::control< dx::device< dx::guid, preference_t > >::stop ( bool force = false )

inlinevirtualnoexceptinherited

result indicates the amount of stopped start references

string()

template<typename desc_t , typename preference_t , typename stream_t >

std::string dx::service::client::_device< desc_t, preference_t, stream_t >::string ( uint8_t )

inlineinherited

wake()

void dx::stream::device< dx::stream::control< dx::device< dx::guid, preference_t > > , desc_t , stream_t >::wake ( )

inlineoverridevirtualinherited

Reimplemented from dx::device< dx::guid, preference_t >.

Member Data Documentation

clients

template<typename desc_t , typename preference_t , typename stream_t >

dx::promoted<typename super::client_map> dx::service::client::_device< desc_t, preference_t, stream_t >::clients

inherited

Initial value:

{
        [this](dx::promoted<typename super::client_map>::lock_t&& lock, const typename super::client_map& value, const typename super::client_map&){
            dx::promoted<uint32_t>::lock_t tmp(std::move(lock));
            if(clients.transient)
                clients.commit(std::move(tmp), value);
        }}

clock

abstract::event* dx::stream::device< dx::stream::control< dx::device< dx::guid, preference_t > > , desc_t , stream_t >::clock

inherited

clocksource

template<typename desc_t , typename preference_t , typename stream_t >

dx::service::client::_device::chain dx::service::client::_device< desc_t, preference_t, stream_t >::clocksource

protectedinherited

counter

std::atomic<size_t> dx::stream::device< dx::stream::control< dx::device< dx::guid, preference_t > > , desc_t , stream_t >::counter

inherited

desc

template<typename desc_t , typename preference_t , typename stream_t >

dx::promoted<desc_t>::template preference<preference_t, typename desc_t::value_t> dx::service::client::_device< desc_t, preference_t, stream_t >::desc {this->preference}

inherited

driver

dx::driver<decltype(id), preference_t>& dx::device< dx::guid , preference_t >::driver

inherited

[struct]

struct { ... } dx::stream::device< dx::stream::control< dx::device< dx::guid, preference_t > > , desc_t , stream_t >::hw

icon

template<typename desc_t , typename preference_t , typename stream_t >

dx::promoted<std::string>::template preference<preference_t, const char*> dx::service::client::_device< desc_t, preference_t, stream_t >::icon

inherited

Initial value:

{
        this->preference,
        []()->std::string{return {};},
        [](const std::string& value, const std::string&){return value;},
        [](const std::string& value){return value.c_str();},
    }

id

const dx::guid dx::device< dx::guid , preference_t >::id

inherited

iosize

template<typename desc_t , typename preference_t , typename stream_t >

dx::service::client::_device::chain dx::service::client::_device< desc_t, preference_t, stream_t >::iosize

protectedinherited

launched

bool dx::object::launched {}

inherited

monitor

dx::stream::device::monitor dx::stream::device< dx::stream::control< dx::device< dx::guid, preference_t > > , desc_t , stream_t >::monitor

inherited

notify

std::deque<std::function<void(control&)> dx::stream::control< dx::device< dx::guid, preference_t > >::notify)

inherited

pipe [1/2]

template<typename desc_t , typename preference_t , typename stream_t >

dx::service::client::_device::chain dx::service::client::_device< desc_t, preference_t, stream_t >::pipe {this->id}

protectedinherited

pipe [2/2]

template<typename desc_t , typename preference_t , typename stream_t >

dx::service::client::_device::chain dx::service::client::_device< desc_t, preference_t, stream_t >::pipe[dx::stream::direction::out]

protectedinherited

preference

preference_t dx::device< dx::guid , preference_t >::preference

inherited

puid

std::string dx::device< dx::guid , preference_t >::puid

inherited

persistent UID - system unique - could change with location

puuid

std::string dx::device< dx::guid , preference_t >::puuid

inherited

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

safety_offset

template<typename desc_t , typename preference_t , typename stream_t >

dx::service::client::_device::chain dx::service::client::_device< desc_t, preference_t, stream_t >::safety_offset

protectedinherited

safety_offset_in

template<typename desc_t , typename preference_t , typename stream_t >

dx::service::client::_device::chain dx::service::client::_device< desc_t, preference_t, stream_t >::safety_offset_in[dx::stream::direction::in]

protectedinherited

safety_offset_out

template<typename desc_t , typename preference_t , typename stream_t >

dx::service::client::_device::chain dx::service::client::_device< desc_t, preference_t, stream_t >::safety_offset_out[dx::stream::direction::out]

protectedinherited

samplerate

template<typename desc_t , typename preference_t , typename stream_t >

dx::service::client::_device::chain dx::service::client::_device< desc_t, preference_t, stream_t >::samplerate

protectedinherited

start_stop_in_progress

std::recursive_mutex dx::stream::control< dx::device< dx::guid, preference_t > >::start_stop_in_progress

protectedinherited

start/stop operation in progress

started

std::atomic<unsigned int> dx::stream::control< dx::device< dx::guid, preference_t > >::started

inherited

streams

std::map<decltype(_desc_t::stream::target.idx()), std::weak_ptr<stream_t> > dx::stream::device< dx::stream::control< dx::device< dx::guid, preference_t > > , desc_t , stream_t >::streams

inherited

sync_cycle_ticks

promoted<uint32_t>::preference<decltype(super_device_t::preference)> dx::stream::device< dx::stream::control< dx::device< dx::guid, preference_t > > , desc_t , stream_t >::sync_cycle_ticks

inherited

sync_reference

promoted<structdesc_t::stream*>::template preference<decltype(super_device_t::preference), uint32_t> dx::stream::device< dx::stream::control< dx::device< dx::guid, preference_t > > , desc_t , stream_t >::sync_reference

inherited

version

dx::stream::device::monitor dx::stream::device< dx::stream::control< dx::device< dx::guid, preference_t > > , desc_t , stream_t >::version

inherited

---

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

• dx_service_client_device.h