dx::coremidi::_device< desc_t, preference_t, stream_t > Class Template Reference

CoreMIDI client device. More...

#include <dx_coremidi_device.h>

Inheritance diagram for dx::coremidi::_device< desc_t, preference_t, stream_t >:

Collaboration diagram for dx::coremidi::_device< desc_t, preference_t, stream_t >:

Public Types
typedef desc_t	desc_t

Public Member Functions
	_device (decltype(super::driver)&driver, decltype(super::id)&id)
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_handler (this,) void conclude() noexcept override
void	exception (const dx::exception &exception, bool filtered=false) noexcept override
	notification exception handler
virtual uint64_t	frame () const
virtual bool	hw_clock () const noexcept
virtual void	hw_clock (dx::event< user > &hw_clock)
void	info (std::ostream &os) noexcept override
	log object class information
virtual void	launch ()
	launch notification: object mounted and ready to use
virtual _device &	reset ()
virtual bool	start (uint64_t=0, unsigned int starting=1)
virtual unsigned int	stop (bool force=false) noexcept
	~_device () noexcept override

Public Attributes
::MIDIClientRef	client {}
dx::event< user > *	clock
promoted< uint32_t >::preference< decltype(super_device_t::preference)>	clocksource
std::atomic< size_t >	counter
dx::driver< decltype(id), preference_t > &	driver
struct {
dx::event< user > *   clock
std::atomic< size_t >   counter
uint32_t   iosize
}	hw
const ::MIDIDeviceRef	id
uint32_t	iosize
promoted< uint32_t >::preference< decltype(super_device_t::preference)>	iosize
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)
promoted< uint32_t >::preference< decltype(super_device_t::preference)>	safety_offset [direction::directions]
promoted< uint32_t >::preference< decltype(super_device_t::preference)>	samplerate
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 Member Functions
virtual void	flush ()
virtual void	halt ()

Protected Attributes
std::recursive_mutex	start_stop_in_progress
	start/stop operation in progress

Detailed Description

template<typename desc_t, typename preference_t, typename stream_t>
class dx::coremidi::_device< desc_t, preference_t, stream_t >

CoreMIDI client device.

Member Typedef Documentation

desc_t

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

inherited

Constructor & Destructor Documentation

_device()

template<typename desc_t , typename preference_t , typename stream_t >

dx::coremidi::_device< desc_t, preference_t, stream_t >::_device ( decltype(super::driver)& driver, decltype(super::id)& id )

inline

Here is the call graph for this function:

~_device()

template<typename desc_t , typename preference_t , typename stream_t >

dx::coremidi::_device< desc_t, preference_t, stream_t >::~_device ( )

inlineoverridenoexcept

Member Function Documentation

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::stream::_device< desc_t, preference_t, stream_t >, dx::usb::pipe< device_t >, dx::virtuel::stream::_device< desc_t, preference_t, stream_t >, dx::coreaudio::stream::device< desc_t, preference_t, stream_t >, dx::proxy::device< dx::preference >, dx::proxy::device<>, dx::proxy::device< preference_t >, dx::map::driver< device<> >, and dx::map::driver< device_t >.

Here is the caller graph for this function:

dx_catchall_handler()

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

inlineoverridenoexceptinherited

exception()

void dx::device< ::MIDIDeviceRef , preference_t >::exception ( const dx::exception & exception, bool filtered = false )

inlineoverridevirtualnoexceptinherited

notification exception handler

Implements dx::object.

flush()

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

inlineprotectedvirtualinherited

frame()

template<typename desc_t , typename preference_t , typename stream_t >

virtual uint64_t dx::coremidi::_device< desc_t, preference_t, stream_t >::frame ( ) const

inlinevirtual

Here is the call graph for this function:

halt()

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

inlineprotectedvirtualinherited

hw_clock() [1/2]

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

inlinevirtualnoexceptinherited

hw_clock() [2/2]

virtual void dx::stream::device< dx::stream::control< dx::device<::MIDIDeviceRef, preference_t > > , desc_t , stream_t >::hw_clock ( dx::event< user > & hw_clock )

inlinevirtualinherited

info()

template<typename desc_t , typename preference_t , typename stream_t >

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

inlineoverridevirtualnoexcept

log object class information

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

Here is the call graph for this function:

launch()

virtual void dx::object::launch ( )

inlinevirtualinherited

launch notification: object mounted and ready to use

Reimplemented in dx::asio::client::driver< device_t >, dx::map::driver< device<> >, dx::map::driver< device_t >, dx::usb::stream::_device< desc_t, preference_t, stream_t >, dx::virtuel::driver< device_t >, dx::coremidi::server::plugin< stream_pin_t, device_t, driver_t >, dx::proxy::driver< device< pin_t > >, dx::proxy::driver< device< stream_pin_t > >, dx::proxy::driver< device< super_device_t > >, dx::proxy::driver< device_t >, dx::proxy::driver< dx::test::device< super_device_t > >, dx::proxy::driver< dx::test::midi::device< super_device_t > >, dx::proxy::driver< device_t >, dx::asio::client::_device< desc_t, preference_t, stream_t >, dx::proxy::driver< device< pin_t > >, dx::proxy::driver< device< stream_pin_t > >, dx::proxy::driver< device< super_device_t > >, dx::proxy::driver< device_t >, dx::proxy::driver< dx::test::device< super_device_t > >, dx::proxy::driver< dx::test::midi::device< super_device_t > >, and dx::proxy::driver< device_t >.

Here is the caller graph for this function:

reset()

template<typename desc_t , typename preference_t , typename stream_t >

virtual _device & dx::coremidi::_device< desc_t, preference_t, stream_t >::reset ( )

inlinevirtual

start()

virtual bool dx::stream::control< dx::device<::MIDIDeviceRef, 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<::MIDIDeviceRef, preference_t > >::stop ( bool force = false )

inlinevirtualnoexceptinherited

result indicates the amount of stopped start references

Member Data Documentation

client

template<typename desc_t , typename preference_t , typename stream_t >

::MIDIClientRef dx::coremidi::_device< desc_t, preference_t, stream_t >::client {}

clock

dx::event<user>* dx::stream::device< dx::stream::control< dx::device<::MIDIDeviceRef, preference_t > > , desc_t , stream_t >::clock

inherited

clocksource

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

inherited

counter

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

inherited

driver

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

inherited

[struct]

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

id

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

inherited

iosize [1/2]

uint32_t dx::stream::device< dx::stream::control< dx::device<::MIDIDeviceRef, preference_t > > , desc_t , stream_t >::iosize

inherited

iosize [2/2]

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

inherited

launched

bool dx::object::launched {}

inherited

monitor

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

inherited

notify

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

inherited

preference

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

inherited

puid

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

inherited

persistent UID - system unique - could change with location

puuid

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

inherited

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

safety_offset

promoted<uint32_t>::preference<decltype(super_device_t::preference)> dx::stream::device< dx::stream::control< dx::device<::MIDIDeviceRef, preference_t > > , desc_t , stream_t >::safety_offset[direction::directions]

inherited

samplerate

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

inherited

start_stop_in_progress

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

protectedinherited

start/stop operation in progress

started

std::atomic<unsigned int> dx::stream::control< dx::device<::MIDIDeviceRef, 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<::MIDIDeviceRef, 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<::MIDIDeviceRef, 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<::MIDIDeviceRef, preference_t > > , desc_t , stream_t >::sync_reference

inherited

version

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

inherited

---

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

• dx_coremidi_device.h