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.

Friends

class MidiClient


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 (  ) 

Default constructor.

Definition at line 1741 of file alsaclient.cpp.

Referenced by ClientInfo::clone().

ClientInfo ( const ClientInfo other  ) 

Copy constructor.

Parameters:
other Another ClientInfo reference to be copied

Definition at line 1750 of file alsaclient.cpp.

ClientInfo ( snd_seq_client_info_t *  other  ) 

Copy constructor.

Parameters:
other An existing ALSA client info object

Definition at line 1761 of file alsaclient.cpp.

ClientInfo ( MidiClient seq,
int  id 
)

Constructor.

Parameters:
seq A MidiClient object
id A numeric client id

Definition at line 1772 of file alsaclient.cpp.

References MidiClient::getHandle().

~ClientInfo (  )  [virtual]

Destructor.

Definition at line 1781 of file alsaclient.cpp.

References ClientInfo::freePorts().


Member Function Documentation

ClientInfo * clone (  ) 

Clone the client info object.

Returns:
A pointer to the new object.

Definition at line 1792 of file alsaclient.cpp.

References ClientInfo::ClientInfo().

void freePorts (  )  [protected]

Release the ports list.

Definition at line 1964 of file alsaclient.cpp.

Referenced by ClientInfo::readPorts(), and ClientInfo::~ClientInfo().

bool getBroadcastFilter (  ) 

Gets the client's broadcast filter.

Returns:
The client's broadcast filter.

Definition at line 1845 of file alsaclient.cpp.

Referenced by MidiClient::getBroadcastFilter().

int getClientId (  ) 

Gets the client's numeric identifier.

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

Definition at line 1815 of file alsaclient.cpp.

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

snd_seq_client_type_t getClientType (  ) 

Gets the client's type.

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

Definition at line 1825 of file alsaclient.cpp.

bool getErrorBounce (  ) 

Gets the client's error bounce.

Returns:
The client's error bounce.

Definition at line 1855 of file alsaclient.cpp.

Referenced by MidiClient::getErrorBounce().

const unsigned char * getEventFilter (  )  [protected]

Gets the client's event filter.

Returns:
The client's event filter.
Deprecated:

Definition at line 1866 of file alsaclient.cpp.

int getEventLost (  ) 

Gets the number of lost events.

Returns:
The number of lost events.

Definition at line 1886 of file alsaclient.cpp.

QString getName (  ) 

Gets the client's name.

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

Definition at line 1835 of file alsaclient.cpp.

Referenced by MidiClient::getClientName(), MidiClient::parseAddress(), ClientInfo::readPorts(), and MidiClient::setClientName().

int getNumPorts (  ) 

Gets the client's port count.

Returns:
The client's port count.

Definition at line 1876 of file alsaclient.cpp.

PortInfoList getPorts (  )  const

Gets the ports list.

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

Definition at line 1974 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 1985 of file alsaclient.cpp.

ClientInfo & operator= ( const ClientInfo other  ) 

Assignment operator.

Parameters:
other Another ClientInfo object
Returns:
This object

Definition at line 1803 of file alsaclient.cpp.

void readPorts ( MidiClient seq  )  [protected]

void setBroadcastFilter ( bool  val  ) 

Sets the broadcast filter.

Parameters:
val The broadcast filter.

Definition at line 1916 of file alsaclient.cpp.

Referenced by MidiClient::setBroadcastFilter().

void setClient ( int  client  ) 

Sets the client identifier number.

Parameters:
client The client identifier number.

Definition at line 1896 of file alsaclient.cpp.

Referenced by MidiClient::readClients().

void setErrorBounce ( bool  val  ) 

Sets the error bounce.

Parameters:
val The error bounce.

Definition at line 1926 of file alsaclient.cpp.

Referenced by MidiClient::setErrorBounce().

void setEventFilter ( unsigned char *  filter  )  [protected]

Sets the event filter.

Parameters:
filter The event filter.
Deprecated:

Definition at line 1937 of file alsaclient.cpp.

void setName ( QString  name  ) 

Sets the client name.

Parameters:
name The client name.

Definition at line 1906 of file alsaclient.cpp.

Referenced by MidiClient::setClientName().


Friends And Related Function Documentation

friend class MidiClient [friend]

Definition at line 52 of file alsaclient.h.


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

Generated on Wed Sep 8 10:12:37 2010 for drumstick by  doxygen 1.5.9