universal_midi_packets::Input Class Reference

An input (from the JUCE project's perspective) that receives messages sent by an endpoint. More...

Public Member Functions
	Input ()
	Creates a disconnected input.
	~Input ()
	Input (Input &&) noexcept
Input &	operator= (Input &&) noexcept
	Input (const Input &)=delete
Input &	operator= (const Input &)=delete
EndpointId	getEndpointId () const
	Returns this connection's endpoint.
PacketProtocol	getProtocol () const
	Returns the protocol that was requested when creating this connection.
void	addConsumer (Consumer &r)
	Attaches a receiver that will receive MIDI messages from this input.
void	removeConsumer (Consumer &r)
	Detaches the receiver so that it will no longer receive MIDI messages from this Input.
void	addDisconnectionListener (DisconnectionListener &r)
	Attaches a listener that will be notified when this endpoint is disconnected.
void	removeDisconnectionListener (DisconnectionListener &r)
	Removes a disconnection listener.
bool	isAlive () const
	True if this connection is currently active.
	operator bool () const

Detailed Description

An input (from the JUCE project's perspective) that receives messages sent by an endpoint.

An Input is conceptually similar to a unique_ptr, in that it's a nullable move-only type. You can check the null state of an instance by calling isAlive(). isAlive() will return true for an Input that's currently connected, or false otherwise. In particular, isAlive() will return false for a default-constructed Input. If isAlive() returns false, you should avoid calling other member functions: although this won't result in undefined behaviour, none of the functions will produce useful results in this state.

In the case that the device connected to the Input becomes unavailable (e.g. it is unplugged or the bluetooth connection is dropped), the Input will null itself, and calls to isAlive() will return false. You can register a callback to handle this event by calling addDisconnectionListener().

A particular pitfall to watch out for is calling addConsumer(), removeConsumer(), addDisconnectionListener(), and removeDisconnectionListener() on a default-constructed Input or other Input for which isAlive() returns false. This will have no effect. Instead, if you want to attach listeners to an Input, you should use Session::connectInput() to create an Input, and ensure that isAlive() returns true on that Input before attaching listeners.

Constructor & Destructor Documentation

Input() [1/3]

universal_midi_packets::Input::Input

(

)

Creates a disconnected input.

A default-constructed input will never receive any messages.

Referenced by Input(), Input(), operator=(), and operator=().

~Input()

universal_midi_packets::Input::~Input

(

)

Input() [2/3]

universal_midi_packets::Input::Input ( Input && )

noexcept

References Input().

Input() [3/3]

universal_midi_packets::Input::Input ( const Input & )

delete

References Input().

Member Function Documentation

operator=() [1/2]

Input & universal_midi_packets::Input::operator= ( Input && )

noexcept

References Input().

operator=() [2/2]

Input & universal_midi_packets::Input::operator= ( const Input & )

delete

References Input().

getEndpointId()

EndpointId universal_midi_packets::Input::getEndpointId

(

)

const

Returns this connection's endpoint.

References getEndpointId().

Referenced by getEndpointId().

getProtocol()

PacketProtocol universal_midi_packets::Input::getProtocol

(

)

const

Returns the protocol that was requested when creating this connection.

References getProtocol().

Referenced by getProtocol().

addConsumer()

void universal_midi_packets::Input::addConsumer

(

Consumer &

r

)

Attaches a receiver that will receive MIDI messages from this input.

Incoming messages will be converted to the protocol that was requested when opening the Input.

If isAlive() returns false at the point where this function is called, this function will have no effect. This can commonly happen when attempting to add listeners to a default-constructed Input, or if the input device got disconnected.

It is an error to add or remove a consumer from within the consumer callback. This will cause deadlocks, so be careful!

References addConsumer().

Referenced by addConsumer().

removeConsumer()

void universal_midi_packets::Input::removeConsumer

(

Consumer &

r

)

Detaches the receiver so that it will no longer receive MIDI messages from this Input.

It is an error to add or remove a consumer from within the consumer callback. This will cause deadlocks, so be careful!

References removeConsumer().

Referenced by removeConsumer().

addDisconnectionListener()

void universal_midi_packets::Input::addDisconnectionListener

(

DisconnectionListener &

r

)

Attaches a listener that will be notified when this endpoint is disconnected.

Calling this function on an instance for which isAlive() returns false has no effect.

References addDisconnectionListener().

Referenced by addDisconnectionListener().

removeDisconnectionListener()

void universal_midi_packets::Input::removeDisconnectionListener

(

DisconnectionListener &

r

)

Removes a disconnection listener.

References removeDisconnectionListener().

Referenced by removeDisconnectionListener().

isAlive()

bool universal_midi_packets::Input::isAlive

(

)

const

True if this connection is currently active.

This function returns false for a default-constructed instance.

References isAlive().

Referenced by isAlive(), and operator bool().

operator bool()

universal_midi_packets::Input::operator bool ( ) const

explicit

References isAlive().