drumstick  1.1.0
PoolInfo Class Reference

Sequencer Pool information. More...

#include <alsaclient.h>

Public Member Functions

 PoolInfo ()
 Default constructor.
 
 PoolInfo (const PoolInfo &other)
 Copy constructor. More...
 
 PoolInfo (snd_seq_client_pool_t *other)
 Copy constructor. More...
 
 PoolInfo (MidiClient *seq)
 Constructor. More...
 
virtual ~PoolInfo ()
 Destructor.
 
PoolInfoclone ()
 Clone the pool info obeject. More...
 
PoolInfooperator= (const PoolInfo &other)
 Assignment operator. More...
 
int getSizeOfInfo () const
 Gets the size of the client pool object. More...
 
int getClientId ()
 Gets the client ID for this object. More...
 
int getInputFree ()
 Gets the available size on input pool. More...
 
int getInputPool ()
 Gets the input pool size. More...
 
int getOutputFree ()
 Gets the available size on output pool. More...
 
int getOutputPool ()
 Gets the output pool size. More...
 
int getOutputRoom ()
 Gets the output room size. More...
 
void setInputPool (int size)
 Set the input pool size. More...
 
void setOutputPool (int size)
 Sets the output pool size. More...
 
void setOutputRoom (int size)
 Sets the output room size. More...
 

Detailed Description

Sequencer Pool information.

This class is used to get and set the size of the input and output pool buffers for a sequencer client.

Definition at line 138 of file alsaclient.h.

Constructor & Destructor Documentation

PoolInfo ( const PoolInfo other)

Copy constructor.

Parameters
otherAnother PoolInfo object reference to be copied

Definition at line 2258 of file alsaclient.cpp.

PoolInfo ( snd_seq_client_pool_t *  other)

Copy constructor.

Parameters
otherAn ALSA pool info object to be copied

Definition at line 2268 of file alsaclient.cpp.

PoolInfo ( MidiClient seq)

Constructor.

Parameters
seqA MidiClient object

Definition at line 2278 of file alsaclient.cpp.

References MidiClient::getHandle().

Member Function Documentation

PoolInfo * clone ( )

Clone the pool info obeject.

Returns
A pointer to the new object

Definition at line 2297 of file alsaclient.cpp.

int getClientId ( )

Gets the client ID for this object.

Returns
The client ID.

Definition at line 2318 of file alsaclient.cpp.

int getInputFree ( )

Gets the available size on input pool.

Returns
The available size on input pool.

Definition at line 2328 of file alsaclient.cpp.

int getInputPool ( )

Gets the input pool size.

Returns
The input pool size.

Definition at line 2338 of file alsaclient.cpp.

int getOutputFree ( )

Gets the available size on output pool.

Returns
The available size on output pool.

Definition at line 2348 of file alsaclient.cpp.

int getOutputPool ( )

Gets the output pool size.

Returns
The output pool size.

Definition at line 2358 of file alsaclient.cpp.

int getOutputRoom ( )

Gets the output room size.

The output room is the minimum pool size for select/blocking mode.

Returns
The output room size.

Definition at line 2369 of file alsaclient.cpp.

int getSizeOfInfo ( ) const

Gets the size of the client pool object.

Returns
The size of the client pool object.

Definition at line 2411 of file alsaclient.cpp.

PoolInfo & operator= ( const PoolInfo other)

Assignment operator.

Parameters
otherAnother PoolInfo object reference to be copied
Returns
This object

Definition at line 2307 of file alsaclient.cpp.

void setInputPool ( int  size)

Set the input pool size.

Parameters
sizeThe input pool size.

Definition at line 2379 of file alsaclient.cpp.

void setOutputPool ( int  size)

Sets the output pool size.

Parameters
sizeThe output pool size.

Definition at line 2389 of file alsaclient.cpp.

void setOutputRoom ( int  size)

Sets the output room size.

The output room is the minimum pool size for select/blocking mode.

Parameters
sizeOutput room size

Definition at line 2401 of file alsaclient.cpp.


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