Subscription management. More...

#include <subscription.h>

Public Member Functions
	Subscription ()
	Default constructor.

	Subscription (const Subscription &other)
	Copy constructor. More...

	Subscription (snd_seq_port_subscribe_t *other)
	Constructor. More...

	Subscription (MidiClient *seq)
	Constructor. More...

virtual	~Subscription ()
	Destructor. More...

Subscription *	clone ()
	Copy the current object. More...

int	getSizeOfInfo () const
	Gets the size of the ALSA subscription object. More...

void	setSender (unsigned char client, unsigned char port)
	Sets the Subscription's sender (MIDI OUT) port. More...

void	setDest (unsigned char client, unsigned char port)
	Sets the Subscription's destination (MIDI IN) port. More...

void	subscribe (MidiClient *seq)
	Performs the subscription in the ALSA sequencer subsystem. More...

void	unsubscribe (MidiClient *seq)
	Breaks the subscription in the ALSA sequencer subsystem. More...

const snd_seq_addr_t *	getSender ()
	Gets the sender address of the subscription (MIDI OUT port) More...

const snd_seq_addr_t *	getDest ()
	Gets the destination address of the subscription (MIDI IN port) More...

int	getQueue ()
	Gets the susbcription's queue number. More...

bool	getExclusive ()
	Gets the subscription's exclusive flag. More...

bool	getTimeUpdate ()
	Gets the susbcription's time-update flag. More...

bool	getTimeReal ()
	Gets the susbcription's time-real (time-stamping) flag. More...

void	setSender (const snd_seq_addr_t *addr)
	Sets the Subscription's sender (MIDI OUT) port. More...

void	setDest (const snd_seq_addr_t *addr)
	Sets the Subscription's destination (MIDI IN) port. More...

void	setQueue (int queue)
	Sets the Subscription's Queue number. More...

void	setExclusive (bool val)
	Sets the subscription's exclusive flag. More...

void	setTimeUpdate (bool val)
	Sets the susbcription's time-update flag. More...

void	setTimeReal (bool val)
	Sets the subscription's time real (time-stamping) flag. More...

Subscription &	operator= (const Subscription &other)
	Assignment operator. More...

Detailed Description

Subscription management.

This class represents a connection between two ports.

Examples:: dumpmid.cpp.

Definition at line 82 of file subscription.h.

Constructor & Destructor Documentation

◆ Subscription() [1/3]

Subscription ( const Subscription & other )

Copy constructor.

Parameters

other Existing Subscription object reference

Definition at line 296 of file subscription.cpp.

◆ Subscription() [2/3]

Subscription ( snd_seq_port_subscribe_t * other )

Constructor.

Parameters

other Pointer to an ALSA subscription object

Definition at line 306 of file subscription.cpp.

◆ Subscription() [3/3]

Subscription ( MidiClient * seq )

Constructor.

Parameters

seq	Pointer to a MIDI Client object

Definition at line 316 of file subscription.cpp.

References CHECK_WARNING, and MidiClient::getHandle().

◆ ~Subscription()

~Subscription ( )

virtual

Destructor.

Returns

Definition at line 326 of file subscription.cpp.

Member Function Documentation

◆ clone()

Subscription * clone ( )

Copy the current object.

Returns: Pointer to the new object

Definition at line 336 of file subscription.cpp.

◆ getDest()

const snd_seq_addr_t * getDest ( )

Gets the destination address of the subscription (MIDI IN port)

Returns: Pointer to the destination ALSA address record

Definition at line 368 of file subscription.cpp.

Referenced by MidiPort::unsubscribe().

◆ getExclusive()

bool getExclusive ( )

Gets the subscription's exclusive flag.

Returns: Exclusive flag

Definition at line 388 of file subscription.cpp.

◆ getQueue()

int getQueue ( )

Gets the susbcription's queue number.

Returns: Queue number

Definition at line 378 of file subscription.cpp.

◆ getSender()

const snd_seq_addr_t * getSender ( )

Gets the sender address of the subscription (MIDI OUT port)

Returns: Pointer to the sender ALSA address record

Definition at line 358 of file subscription.cpp.

Referenced by MidiPort::unsubscribe().

◆ getSizeOfInfo()

int getSizeOfInfo ( ) const

Gets the size of the ALSA subscription object.

Returns: Size of the ALSA object

Definition at line 538 of file subscription.cpp.

◆ getTimeReal()

bool getTimeReal ( )

Gets the susbcription's time-real (time-stamping) flag.

Returns: Time real flag

Definition at line 408 of file subscription.cpp.

◆ getTimeUpdate()

bool getTimeUpdate ( )

Gets the susbcription's time-update flag.

Returns: Time-update flag

Definition at line 398 of file subscription.cpp.

◆ operator=()

Subscription & operator= ( const Subscription & other )

Assignment operator.

Parameters

other Existing subscription object reference

Returns: This object

Definition at line 347 of file subscription.cpp.

◆ setDest() [1/2]

void setDest	(	unsigned char	client,
		unsigned char	port
	)

Sets the Subscription's destination (MIDI IN) port.

Parameters

client	Client number
port	Port number

Definition at line 493 of file subscription.cpp.

Referenced by MidiPort::subscribeFrom(), MidiPort::subscribeTo(), MidiPort::unsubscribeFrom(), and MidiPort::unsubscribeTo().

◆ setDest() [2/2]

void setDest ( const snd_seq_addr_t * addr )

Sets the Subscription's destination (MIDI IN) port.

Parameters

addr	Pointer to the destination ALSA address record

Definition at line 428 of file subscription.cpp.

◆ setExclusive()

void setExclusive ( bool val )

Sets the subscription's exclusive flag.

Parameters

val	Exclusive flag

Definition at line 448 of file subscription.cpp.

◆ setQueue()

void setQueue ( int q )

Sets the Subscription's Queue number.

Parameters

q	Queue number

Definition at line 438 of file subscription.cpp.

◆ setSender() [1/2]

void setSender	(	unsigned char	client,
		unsigned char	port
	)

Sets the Subscription's sender (MIDI OUT) port.

Parameters

client	Client number
port	Port number

Definition at line 479 of file subscription.cpp.

Referenced by MidiPort::subscribeFrom(), MidiPort::subscribeTo(), MidiPort::unsubscribeFrom(), and MidiPort::unsubscribeTo().

◆ setSender() [2/2]

void setSender ( const snd_seq_addr_t * addr )

Sets the Subscription's sender (MIDI OUT) port.

Parameters

addr	Pointer to the sender ALSA address record

Definition at line 418 of file subscription.cpp.

◆ setTimeReal()

void setTimeReal ( bool val )

Sets the subscription's time real (time-stamping) flag.

Parameters

val	Time real flag

Definition at line 468 of file subscription.cpp.

◆ setTimeUpdate()

void setTimeUpdate ( bool val )

Sets the susbcription's time-update flag.

Parameters

val	Time update flag

Definition at line 458 of file subscription.cpp.

◆ subscribe()

void subscribe ( MidiClient * seq )

Performs the subscription in the ALSA sequencer subsystem.

Neither the sender nor the destination ports need to belong to the same MidiClient instance performing the subscription.

Parameters

seq	MidiClient instance pointer

Definition at line 508 of file subscription.cpp.

References CHECK_WARNING, MidiClient::getHandle(), and MidiClient::isOpened().

Referenced by MidiPort::subscribe().

◆ unsubscribe()

void unsubscribe ( MidiClient * seq )

Breaks the subscription in the ALSA sequencer subsystem.

Neither the sender nor the destination ports need to belong to the same MidiClient instance breaking the subscription.

Parameters

seq	MidiClient instance pointer

Definition at line 524 of file subscription.cpp.

References CHECK_WARNING, MidiClient::getHandle(), and MidiClient::isOpened().

Referenced by MidiPort::unsubscribe(), and MidiPort::unsubscribeAll().

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Subscription() [1/3]

◆ Subscription() [2/3]

◆ Subscription() [3/3]

◆ ~Subscription()

Member Function Documentation

◆ clone()

◆ getDest()

◆ getExclusive()

◆ getQueue()

◆ getSender()

◆ getSizeOfInfo()

◆ getTimeReal()

◆ getTimeUpdate()

◆ operator=()

◆ setDest() [1/2]

◆ setDest() [2/2]

◆ setExclusive()

◆ setQueue()

◆ setSender() [1/2]

◆ setSender() [2/2]

◆ setTimeReal()

◆ setTimeUpdate()

◆ subscribe()

◆ unsubscribe()