drumstick  1.0.2
ClientInfo Class Reference

Client information. More...

#include <alsaclient.h>

List of all members.

Public Member Functions

 ClientInfo ()
 Default constructor.
 ClientInfo (const ClientInfo &other)
 Copy constructor.
 ClientInfo (snd_seq_client_info_t *other)
 Copy constructor.
 ClientInfo (MidiClient *seq, int id)
 Constructor.
virtual ~ClientInfo ()
 Destructor.
ClientInfoclone ()
 Clone the client info object.
ClientInfooperator= (const ClientInfo &other)
 Assignment operator.
int getSizeOfInfo () const
 Gets the size of the internal object.
int getClientId ()
 Gets the client's numeric identifier.
snd_seq_client_type_t getClientType ()
 Gets the client's type.
QString getName ()
 Gets the client's name.
bool getBroadcastFilter ()
 Gets the client's broadcast filter.
bool getErrorBounce ()
 Gets the client's error bounce.
int getNumPorts ()
 Gets the client's port count.
int getEventLost ()
 Gets the number of lost events.
void setClient (int client)
 Sets the client identifier number.
void setName (QString name)
 Sets the client name.
void setBroadcastFilter (bool val)
 Sets the broadcast filter.
void setErrorBounce (bool val)
 Sets the error bounce.
PortInfoList getPorts () const
 Gets the ports list.

Protected Member Functions

void readPorts (MidiClient *seq)
 Read the client ports.
void freePorts ()
 Release the ports list.
const unsigned char * getEventFilter () __attribute__((deprecated))
 Gets the client's event filter.
void setEventFilter (unsigned char *filter) __attribute__((deprecated))
 Sets the event filter.

Detailed Description

Client information.

This class is used to retrieve, hold and set some data from sequencer clients, like the name or id.

Examples:
sysinfo.cpp.

Definition at line 50 of file alsaclient.h.


Constructor & Destructor Documentation

ClientInfo ( const ClientInfo other)

Copy constructor.

Parameters:
otherAnother ClientInfo reference to be copied

Definition at line 1975 of file alsaclient.cpp.

ClientInfo ( snd_seq_client_info_t *  other)

Copy constructor.

Parameters:
otherAn existing ALSA client info object

Definition at line 1986 of file alsaclient.cpp.

ClientInfo ( MidiClient seq,
int  id 
)

Constructor.

Parameters:
seqA MidiClient object
idA numeric client id

Definition at line 1997 of file alsaclient.cpp.

References MidiClient::getHandle().


Member Function Documentation

Clone the client info object.

Returns:
A pointer to the new object.

Definition at line 2017 of file alsaclient.cpp.

Gets the client's broadcast filter.

Returns:
The client's broadcast filter.

Definition at line 2070 of file alsaclient.cpp.

int getClientId ( )

Gets the client's numeric identifier.

Returns:
The client's numeric identifier.
Examples:
sysinfo.cpp.

Definition at line 2040 of file alsaclient.cpp.

Referenced by MidiClient::filterPorts(), and MidiClient::parseAddress().

snd_seq_client_type_t getClientType ( )

Gets the client's type.

Returns:
The client's type.
Examples:
sysinfo.cpp.

Definition at line 2050 of file alsaclient.cpp.

bool getErrorBounce ( )

Gets the client's error bounce.

Returns:
The client's error bounce.

Definition at line 2080 of file alsaclient.cpp.

const unsigned char * getEventFilter ( ) [protected]

Gets the client's event filter.

Returns:
The client's event filter.
Deprecated:

Definition at line 2091 of file alsaclient.cpp.

int getEventLost ( )

Gets the number of lost events.

Returns:
The number of lost events.

Definition at line 2111 of file alsaclient.cpp.

QString getName ( void  )

Gets the client's name.

Returns:
The client's name.
Examples:
sysinfo.cpp.

Definition at line 2060 of file alsaclient.cpp.

Referenced by MidiClient::parseAddress().

int getNumPorts ( )

Gets the client's port count.

Returns:
The client's port count.

Definition at line 2101 of file alsaclient.cpp.

PortInfoList getPorts ( ) const

Gets the ports list.

Returns:
The ports list.
Examples:
sysinfo.cpp.

Definition at line 2199 of file alsaclient.cpp.

Referenced by MidiClient::filterPorts().

int getSizeOfInfo ( ) const

Gets the size of the internal object.

Returns:
The size of the internal object.

Definition at line 2210 of file alsaclient.cpp.

ClientInfo & operator= ( const ClientInfo other)

Assignment operator.

Parameters:
otherAnother ClientInfo object
Returns:
This object

Definition at line 2028 of file alsaclient.cpp.

void readPorts ( MidiClient seq) [protected]

Read the client ports.

Parameters:
seqThe client instance.

Definition at line 2172 of file alsaclient.cpp.

References MidiClient::getClientId(), MidiClient::getHandle(), PortInfo::readSubscribers(), PortInfo::setClient(), PortInfo::setClientName(), and PortInfo::setPort().

Referenced by MidiClient::readClients().

void setBroadcastFilter ( bool  val)

Sets the broadcast filter.

Parameters:
valThe broadcast filter.

Definition at line 2141 of file alsaclient.cpp.

void setClient ( int  client)

Sets the client identifier number.

Parameters:
clientThe client identifier number.

Definition at line 2121 of file alsaclient.cpp.

Referenced by MidiClient::readClients().

void setErrorBounce ( bool  val)

Sets the error bounce.

Parameters:
valThe error bounce.

Definition at line 2151 of file alsaclient.cpp.

void setEventFilter ( unsigned char *  filter) [protected]

Sets the event filter.

Parameters:
filterThe event filter.
Deprecated:

Definition at line 2162 of file alsaclient.cpp.

void setName ( QString  name)

Sets the client name.

Parameters:
nameThe client name.

Definition at line 2131 of file alsaclient.cpp.


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