OS proxy streaming pin class. More...

#include <dx_proxy_stream_device.h>

Inheritance diagram for dx::proxy::stream::pin< desc_t, circular_t, device_t >:

Collaboration diagram for dx::proxy::stream::pin< desc_t, circular_t, device_t >:

Public Types
typedef _circular_t	circular_t

typedef _desc_t	desc_t

typedef _device_t	device_t

Public Member Functions
channel_t void	attach (channel_t **io[2], uint64_t channel_map[(channels+63)/64]) try

virtual void	callback ()

	catch (...)

	catch (...)

	catch (...)

	catch (...)

	catch (const dx::exception &__dx_exception)

	catch (const dx::exception &__dx_exception)

	catch (const dx::exception &__dx_exception)

	catch (const dx::exception &__dx_exception)

	catch (const std::exception &__std_exception)

	catch (const std::exception &__std_exception)

	catch (const std::exception &__std_exception)

	catch (const std::exception &__std_exception)

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.

	dx_catchall_rethrow () virtual pin &wait()

	dx_catchall_rethrow () virtual uint32_t samplerate() const

	dx_catchall_rethrow () void stop(bool force

virtual float	encoder (dx::stream::encoder::index::type type, int index) const

virtual void	info (std::ostream &os)
	log object class information

virtual pin &	initialize ()

virtual void	launch ()
	launch notification: object mounted and ready to use

virtual	operator circular_t * () const noexcept

	operator os_event () noexcept

virtual circular_t *	operator-> () const noexcept

	pin (device_t &device, const typename desc_t::stream::desc &stream_desc, const typename desc_t::stream::pin::desc &pin_desc)
	proxy::stream::pin constructor

event &	reset (uint64_t count=0) try

event &	signal (uint64_t count=1) try

uint64_t	signalled () const

void	start (uint64_t) override try

virtual void	stop (bool force=false) noexcept

event &	wait (bool reset=false) try

template<typename rep_t , typename period_t >
bool	wait (const std::chrono::duration< rep_t, period_t > &timeout, bool reset=false) try

virtual	~pin () noexcept
	closes the pin

Public Attributes
dx::stream::channel::control *	control = nullptr

bool	launched {}

stream_t &	stream

Static Public Attributes
static constexpr auto	scope = kernel

Protected Types
typedef decltype(desc_t::stream::target)	bus_t

Detailed Description

template<typename desc_t, typename circular_t = dx::circular, typename device_t = dx::proxy::stream::device<desc_t>>
class dx::proxy::stream::pin< desc_t, circular_t, device_t >

OS proxy streaming pin class.

example:

Exceptions

in	case of an error returned by the underlaying API the device class throws a dx::exception.

Member Typedef Documentation

◆ bus_t

template<typename desc_t , typename circular_t = dx::circular, typename device_t = dx::proxy::stream::device<desc_t>>

typedef decltype(desc_t::stream::target) dx::proxy::stream::pin< desc_t, circular_t, device_t >::bus_t

protected

◆ circular_t

template<typename _desc_t , typename _circular_t , typename _device_t >

typedef _circular_t dx::stream::pin< _desc_t, _circular_t, _device_t >::circular_t

inherited

◆ desc_t

template<typename _desc_t , typename _circular_t , typename _device_t >

typedef _desc_t dx::stream::pin< _desc_t, _circular_t, _device_t >::desc_t

inherited

◆ device_t

template<typename _desc_t , typename _circular_t , typename _device_t >

typedef _device_t dx::stream::pin< _desc_t, _circular_t, _device_t >::device_t

inherited

Constructor & Destructor Documentation

◆ pin()

template<typename desc_t , typename circular_t = dx::circular, typename device_t = dx::proxy::stream::device<desc_t>>

dx::proxy::stream::pin< desc_t, circular_t, device_t >::pin	(	device_t &	device,
		const typename desc_t::stream::desc &	stream_desc,
		const typename desc_t::stream::pin< desc_t, circular_t, device_t >::desc &	pin_desc )

inline

proxy::stream::pin constructor

Exceptions

n/a

◆ ~pin()

template<typename desc_t , typename circular_t = dx::circular, typename device_t = dx::proxy::stream::device<desc_t>>

virtual dx::proxy::stream::pin< desc_t, circular_t, device_t >::~pin ( )

inlinevirtualnoexcept

closes the pin

Member Function Documentation

◆ attach()

template<typename desc_t , typename circular_t = dx::circular, typename device_t = dx::proxy::stream::device<desc_t>>

channel_t void dx::proxy::stream::pin< desc_t, circular_t, device_t >::attach	(	channel_t **	io[2],
		uint64_t	channel_map[(channels+63)/64] )

inline

◆ callback()

virtual void dx::event< kernel >::callback ( )

inlinevirtualinherited

The default implementation is based on event<user> which is signalled when triggered via callback() from kernel. This is to achieve compatibility with Windows events. Its probably more adequate to overwrite callback() and do the work here if feasible.

◆ catch() [1/12]

dx::event< user >::catch ( ... )

inlineinherited

◆ catch() [2/12]

dx::event< user >::catch ( ... )

inlineinherited

◆ catch() [3/12]

dx::event< user >::catch ( ... )

inlineinherited

◆ catch() [4/12]

dx::event< user >::catch ( ... )

inlineinherited

◆ catch() [5/12]

dx::event< user >::catch ( const dx::exception & __dx_exception )

inlineinherited

◆ catch() [6/12]

dx::event< user >::catch ( const dx::exception & __dx_exception )

inlineinherited

◆ catch() [7/12]

dx::event< user >::catch ( const dx::exception & __dx_exception )

inlineinherited

◆ catch() [8/12]

dx::event< user >::catch ( const dx::exception & __dx_exception )

inlineinherited

◆ catch() [9/12]

dx::event< user >::catch ( const std::exception & __std_exception )

inlineinherited

◆ catch() [10/12]

dx::event< user >::catch ( const std::exception & __std_exception )

inlineinherited

◆ catch() [11/12]

dx::event< user >::catch ( const std::exception & __std_exception )

inlineinherited

◆ catch() [12/12]

dx::event< user >::catch ( const std::exception & __std_exception )

inlineinherited

◆ conclude()

virtual void dx::object::conclude ( )

inlinevirtualnoexceptinherited

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 in dx::proxy::device, dx::proxy::device, dx::map::driver< device >, and dx::map::driver< device_t >.

Here is the caller graph for this function:

◆ dx_catchall_rethrow() [1/3]

template<typename _desc_t , typename _circular_t , typename _device_t >

dx::stream::pin< _desc_t, _circular_t, _device_t >::dx_catchall_rethrow ( ) &

inlineinherited

Here is the call graph for this function:

◆ dx_catchall_rethrow() [2/3]

template<typename _desc_t , typename _circular_t , typename _device_t >

dx::stream::pin< _desc_t, _circular_t, _device_t >::dx_catchall_rethrow ( ) const

inlineinherited

Here is the call graph for this function:

◆ dx_catchall_rethrow() [3/3]

template<typename desc_t , typename circular_t = dx::circular, typename device_t = dx::proxy::stream::device<desc_t>>

dx::proxy::stream::pin< desc_t, circular_t, device_t >::dx_catchall_rethrow ( )

virtual

Implements dx::stream::pin< _desc_t, _circular_t, _device_t >.

◆ encoder()

template<typename _desc_t , typename _circular_t , typename _device_t >

virtual float dx::stream::pin< _desc_t, _circular_t, _device_t >::encoder	(	dx::stream::encoder::index::type	type,
		int	index ) const

inlinevirtualinherited

Here is the call graph for this function:

◆ info()

virtual void dx::object::info ( std::ostream & os )

inlinevirtualinherited

log object class information

Reimplemented in dx::device< std::string >, dx::device<::AudioObjectID >, dx::device<::io_service_t >, dx::device< id_t >, dx::virtuel::driver< dx::test::device< typename audio_pin_t::circular_t, super_device_t > >, dx::virtuel::driver< device_t >, dx::coreaudio::driver< device_t >, dx::proxy::device, dx::proxy::driver< device< pin_t > >, dx::proxy::driver< device< typename audio_pin_t::circular_t, super_device_t > >, dx::proxy::driver< device_t >, dx::proxy::driver< dx::test::midi::device< typename audio_pin_t::circular_t, super_device_t, typename midi_pin_t::circular_t > >, dx::proxy::driver< device_t >, and dx::proxy::device.

Here is the caller graph for this function:

◆ initialize()

template<typename _desc_t , typename _circular_t , typename _device_t >

virtual pin & dx::stream::pin< _desc_t, _circular_t, _device_t >::initialize ( )

inlinevirtualinherited

◆ launch()

virtual void dx::object::launch ( )

inlinevirtualinherited

launch notification: object mounted and ready to use

Here is the caller graph for this function:

◆ operator circular_t *()

template<typename _desc_t , typename _circular_t , typename _device_t >

virtual dx::stream::pin< _desc_t, _circular_t, _device_t >::operator circular_t * ( ) const

inlinevirtualnoexceptinherited

Reimplemented in dx::coreaudio::pin< desc_t, circular_t, device_t >.

◆ operator os_event()

dx::event< kernel >::operator os_event ( )

inlinenoexceptinherited

◆ operator->()

template<typename _desc_t , typename _circular_t , typename _device_t >

virtual circular_t * dx::stream::pin< _desc_t, _circular_t, _device_t >::operator-> ( ) const

inlinevirtualnoexceptinherited

Reimplemented in dx::coreaudio::pin< desc_t, circular_t, device_t >.

◆ reset()

event & dx::event< user >::reset ( uint64_t count = 0 )

inlineinherited

◆ signal()

event & dx::event< user >::signal ( uint64_t count = 1 )

inlineinherited

◆ signalled()

uint64_t dx::event< user >::signalled ( ) const

inlineinherited

◆ start()

template<typename desc_t , typename circular_t = dx::circular, typename device_t = dx::proxy::stream::device<desc_t>>

void dx::proxy::stream::pin< desc_t, circular_t, device_t >::start ( uint64_t )

inlineoverride

◆ stop()

template<typename _desc_t , typename _circular_t , typename _device_t >

virtual void dx::stream::pin< _desc_t, _circular_t, _device_t >::stop ( bool force = false )

inlinevirtualnoexceptinherited

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wait() [1/2]

event & dx::event< user >::wait ( bool reset = false )

inlineinherited

◆ wait() [2/2]

template<typename rep_t , typename period_t >

bool dx::event< user >::wait	(	const std::chrono::duration< rep_t, period_t > &	timeout,
		bool	reset = false )

inlineinherited

wait with duration timeout returns true: signalled false: timed out

Member Data Documentation

◆ control

template<typename desc_t , typename circular_t = dx::circular, typename device_t = dx::proxy::stream::device<desc_t>>

dx::stream::channel::control* dx::proxy::stream::pin< desc_t, circular_t, device_t >::control = nullptr

◆ launched

bool dx::object::launched {}

inherited

◆ scope

static constexpr auto dx::event< kernel >::scope = kernel

staticconstexprinherited

◆ stream

template<typename _desc_t , typename _circular_t , typename _device_t >

stream_t& dx::stream::pin< _desc_t, _circular_t, _device_t >::stream

inherited

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

dx_proxy_stream_device.h

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Detailed Description

Member Typedef Documentation

◆ bus_t

◆ circular_t

◆ desc_t

◆ device_t

Constructor & Destructor Documentation

◆ pin()

◆ ~pin()

Member Function Documentation

◆ attach()

◆ callback()

◆ catch() [1/12]

◆ catch() [2/12]

◆ catch() [3/12]

◆ catch() [4/12]

◆ catch() [5/12]

◆ catch() [6/12]

◆ catch() [7/12]

◆ catch() [8/12]

◆ catch() [9/12]

◆ catch() [10/12]

◆ catch() [11/12]

◆ catch() [12/12]

◆ conclude()

◆ dx_catchall_rethrow() [1/3]

◆ dx_catchall_rethrow() [2/3]

◆ dx_catchall_rethrow() [3/3]

◆ encoder()

◆ info()

◆ initialize()

◆ launch()

◆ operator circular_t *()

◆ operator os_event()

◆ operator->()

◆ reset()

◆ signal()

◆ signalled()

◆ start()

◆ stop()

◆ wait() [1/2]

◆ wait() [2/2]

Member Data Documentation

◆ control

◆ launched

◆ scope

◆ stream