dx::coreaudio::pod::group< device_t > Class Template Reference

a pod client's own streaming group: the HAL I/O proc's session like any client's - it is what keeps the counterpart's process scheduled tightly, the pod's own I/O proc moves nothing - on the counterpart's hw clock, a shared event the device's hw_clock() opens by name More...

#include <dx_coreaudio_pod_device.h>

Inheritance diagram for dx::coreaudio::pod::group< device_t >:

Collaboration diagram for dx::coreaudio::pod::group< device_t >:

Public Types
typedef settings< device_t >::client	client
typedef dx::clock< dx::source<> >	clock
	the one clock of this group, its source freely selectable
typedef dx::source<>::clock_t	clock_t
typedef device_t	device_t
typedef dx::source<>::event_t	event_t
typedef settings_promoted< device_t, store >::type	promoted
typedef settings_promoted< device_t, store >::type	promoted
typedef device_t::stream_t	stream_t
typedef settings< device_t >::transport	transport
	the group's two sides, reached as transport::/client:: members

Public Member Functions
void	conclude () noexcept
virtual void	halt () noexcept
	stop and remove clock thread
virtual void	info (std::ostream &os) noexcept
realtime &	initialize (const std::chrono::high_resolution_clock::duration &resolution)
void	initialize (const typename clock_t::duration &duration)
	operator event_t & () noexcept
	operator event_t * () noexcept
void	run () override
	the session starts on the registered streams, held until its thread ends
virtual void	sync (const typename clock_t::time_point &now)
virtual source &	wait (bool reset=false)

Static Public Member Functions
static std::string	key (direction::direction direction, uint32_t strategy)
static std::string	key (direction::direction direction, uint32_t)
static std::string	key (direction::direction direction, uint32_t)
static std::string	key (direction::direction direction, uint32_t strategy)

Public Attributes
listener< dx::listen< std::function< void(const uint32_t &)> > >	iosize_listener
	a margin defaulted by the device's iosize (a host's tick is its buffer) reloads with it
promoted	safety_offset [direction::directions]
promoted	safety_offset [direction::directions]
promoted< uint32_t >	start
promoted< bool >	started
std::map< decltype(stream_t::target.idx()), std::weak_ptr< stream_t > >	streams
	shared stream ownership: central weak reference per stream, guarded by device
promoted	sync_strategy
promoted	sync_strategy

Protected Member Functions
void	discharge () noexcept override
	the thread's last act: the session's streams are released on the thread that visited them
virtual void	notify () noexcept
	notify change from device requiring streaming reset
void	tick () override
	the plain container has no transport of its own: a bus whose group moves the data overrides this, a group fed from outside (service, kernel, SDK callback) has nothing to do here

Protected Attributes
std::condition_variable	condition_variable
device_t &	device
	also the mutex serializing membership
_event_t	event
std::function< void()>	flush_hook
std::function< void()>	halt_hook
std::vector< std::shared_ptr< stream_t > >	members
	the session's streams: taken before the thread starts, released at its end - the tick visits them without a lock
std::mutex	mutex
_clock_t::time_point	objective
std::function< void()>	run_hook
std::atomic< bool >	running
os_result	status
const struct device_t::desc_t::stream *	sync_reference
	device.sync_reference cached: the tick never reads the promoted

Detailed Description

template<typename device_t>
class dx::coreaudio::pod::group< device_t >

a pod client's own streaming group: the HAL I/O proc's session like any client's - it is what keeps the counterpart's process scheduled tightly, the pod's own I/O proc moves nothing - on the counterpart's hw clock, a shared event the device's hw_clock() opens by name

Member Typedef Documentation

client

typedef settings<device_t>::client dx::stream::group< device_t, dx::source<> >::client

inherited

clock

typedef dx::clock<dx::source<>> dx::stream::group< device_t, dx::source<> >::clock

inherited

the one clock of this group, its source freely selectable

clock_t

typedef dx::source<>::clock_t dx::clock< dx::source<> >::clock_t

inherited

device_t

typedef device_t dx::stream::group< device_t, dx::source<> >::device_t

inherited

event_t

typedef dx::source<>::event_t dx::clock< dx::source<> >::event_t

inherited

promoted [1/2]

typedef settings_promoted<device_t,store>::type dx::stream::settings< device_t, store >::promoted

inherited

promoted [2/2]

typedef settings_promoted<device_t,store>::type dx::stream::settings< device_t, store >::promoted

inherited

stream_t

typedef device_t::stream_t dx::stream::group< device_t, dx::source<> >::stream_t

inherited

transport

typedef settings<device_t>::transport dx::stream::group< device_t, dx::source<> >::transport

inherited

the group's two sides, reached as transport::/client:: members

Member Function Documentation

conclude()

void dx::stream::control< dx::clock< dx::source<> > >::conclude ( )

inlinenoexceptinherited

discharge()

void dx::stream::group< device_t, dx::source<> >::discharge ( )

inlineoverrideprotectednoexceptinherited

the thread's last act: the session's streams are released on the thread that visited them

halt()

virtual void dx::clock< dx::source<> >::halt ( )

inlinevirtualnoexceptinherited

stop and remove clock thread

<halting from its own tick: the loop ends once the tick returns, nobody can join here

<elect the single caller allowed to join() - concurrent halt() callers (e.g. async surprise vs. the main test thread) would otherwise both reach join() on the same thread, undefined behavior

info()

virtual void dx::clock< dx::source<> >::info ( std::ostream & os )

inlinevirtualnoexceptinherited

initialize() [1/2]

realtime & dx::thread::prio::realtime::initialize ( const std::chrono::high_resolution_clock::duration & resolution )

inlineinherited

Todo

dx::thread::prio: replace experimental hardcoded preemption limit with real limit obtained from machine

initialize() [2/2]

void dx::clock< dx::source<> >::initialize ( const typename clock_t::duration & duration )

inlineinherited

key() [1/4]

std::string dx::stream::settings< device_t, store >::transport::key ( direction::direction direction, uint32_t strategy )

inlinestaticinherited

key() [2/4]

std::string dx::stream::settings< device_t, store >::client::key ( direction::direction direction, uint32_t  )

inlinestaticinherited

key() [3/4]

template<typename device_t, bool store = true>

std::string dx::stream::settings< device_t, store >::client::key ( direction::direction direction, uint32_t  )

inlinestaticinherited

Here is the caller graph for this function:

key() [4/4]

template<typename device_t, bool store = true>

std::string dx::stream::settings< device_t, store >::transport::key ( direction::direction direction, uint32_t strategy )

inlinestaticinherited

Here is the caller graph for this function:

notify()

virtual void dx::clock< dx::source<> >::notify ( )

inlineprotectedvirtualnoexceptinherited

notify change from device requiring streaming reset

operator event_t &()

dx::clock< dx::source<> >::operator event_t & ( )

inlinenoexceptinherited

operator event_t *()

dx::clock< dx::source<> >::operator event_t * ( )

inlinenoexceptinherited

run()

void dx::stream::group< device_t, dx::source<> >::run ( )

inlineoverrideinherited

the session starts on the registered streams, held until its thread ends

sync()

virtual void dx::source< _event_t, _clock_t >::sync ( const typename clock_t::time_point & now )

inlinevirtualinherited

tick()

void dx::stream::group< device_t, dx::source<> >::tick ( )

inlineoverrideprotectedinherited

the plain container has no transport of its own: a bus whose group moves the data overrides this, a group fed from outside (service, kernel, SDK callback) has nothing to do here

wait()

virtual source & dx::source< _event_t, _clock_t >::wait ( bool reset = false )

inlinevirtualinherited

Member Data Documentation

condition_variable

std::condition_variable dx::source< _event_t, _clock_t >::condition_variable

protectedinherited

device

device_t& dx::stream::group< device_t, dx::source<> >::device

protectedinherited

also the mutex serializing membership

event

_event_t dx::source< _event_t, _clock_t >::event

protectedinherited

Todo

evaluate clock::status replacement (exception?)

flush_hook

std::function<void()> dx::stream::control< dx::clock< dx::source<> > >::flush_hook

protectedinherited

halt_hook

std::function<void()> dx::stream::control< dx::clock< dx::source<> > >::halt_hook

protectedinherited

iosize_listener

listener<dx::listen<std::function<void(const uint32_t&)> > > dx::stream::settings< device_t, store >::client::iosize_listener

inherited

a margin defaulted by the device's iosize (a host's tick is its buffer) reloads with it

members

std::vector<std::shared_ptr<stream_t> > dx::stream::group< device_t, dx::source<> >::members

protectedinherited

the session's streams: taken before the thread starts, released at its end - the tick visits them without a lock

mutex

std::mutex dx::source< _event_t, _clock_t >::mutex

protectedinherited

objective

_clock_t::time_point dx::source< _event_t, _clock_t >::objective

protectedinherited

run_hook

std::function<void()> dx::stream::control< dx::clock< dx::source<> > >::run_hook

protectedinherited

running

std::atomic<bool> dx::source< _event_t, _clock_t >::running

protectedinherited

safety_offset [1/2]

promoted dx::stream::settings< device_t, store >::safety_offset[direction::directions]

inherited

safety_offset [2/2]

promoted dx::stream::settings< device_t, store >::safety_offset[direction::directions]

inherited

start

promoted<uint32_t> dx::stream::control< dx::clock< dx::source<> > >::start

inherited

started

promoted<bool> dx::stream::control< dx::clock< dx::source<> > >::started

inherited

status

os_result dx::source< _event_t, _clock_t >::status

protectedinherited

streams

std::map<decltype(stream_t::target.idx()), std::weak_ptr<stream_t> > dx::stream::group< device_t, dx::source<> >::streams

inherited

shared stream ownership: central weak reference per stream, guarded by device

sync_reference

const struct device_t::desc_t::stream* dx::stream::group< device_t, dx::source<> >::sync_reference

protectedinherited

device.sync_reference cached: the tick never reads the promoted

sync_strategy [1/2]

promoted dx::stream::settings< device_t, store >::sync_strategy

inherited

sync_strategy [2/2]

promoted dx::stream::settings< device_t, store >::sync_strategy

inherited

---

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

• dx_coreaudio_pod_device.h