---

Buffer Class Reference

The Buffer System Class. More...

#include <buffer.h>

List of all members.

Public Methods
	Buffer ( int checkSleep = 10000 )
	Constructor (optional argument). More...
	~Buffer ()
	Deconstructor. More...
void	write (packet* pak)
	writes a packet into the buffer. More...
packet*	read ()
	reads a packet from the buffer. More...
bool	isEmpty ()
	checks if the buffer is empty. More...
Private Attributes
int	checkSleep
	the time it waits after realizing that the buffer is empty. More...
pthread_mutex_t	buf_lock
	The mutex lock to make the buffer threadsafe. More...
pthread_mutex_t	buf_waitlock
	not used/obsolete. More...
queue<packet*>	intBuffer
	internal queue. More...

---

Detailed Description

The Buffer System Class.

Author(s):

Stonedbones

Date:

310100

Definition at line 14 of file buffer.h.

{
    public:

    Buffer ( int checkSleep = 10000 );
    ~Buffer ();


    void    write (packet* pak);

    packet* read ();


    bool    isEmpty ();

    private:

    int checkSleep; 
    pthread_mutex_t buf_lock; 
    pthread_mutex_t buf_waitlock; 
    queue<packet*>  intBuffer; 
}

---

Constructor & Destructor Documentation

Buffer::Buffer ( int checkSleep = 10000)

Constructor (optional argument).

Parameters:

checkSleep

the time it waits to check the queue again (shall hopefully become obsolete very soon!)

Definition at line 31 of file buffer.cpp.

{
    checkSleep = cS;
}

Buffer::~Buffer ()

Deconstructor.

Definition at line 45 of file buffer.cpp.

{
    while (!intBuffer.empty ()) intBuffer.pop ();
}

---

Member Function Documentation

bool Buffer::isEmpty ()

checks if the buffer is empty.

Returns:

true when empty, false when filled

Definition at line 111 of file buffer.cpp.

{
    if (intBuffer.empty ())
        {
        usleep ( checkSleep );
        return true;
        }
    else
        {
        return false;
        };
    }

packet * Buffer::read ()

reads a packet from the buffer.

Returns:

the packet

Definition at line 80 of file buffer.cpp.

{
    packet* tmp;

    pthread_mutex_lock ( &buf_lock );

    if ( intBuffer.empty () )
        {
        tmp = 0;
        }
    else
        {
        tmp = intBuffer.front ();
        intBuffer.pop ();
        }

    pthread_mutex_unlock ( &buf_lock );

    return tmp;
}

void Buffer::write ( packet * pak)

writes a packet into the buffer.

Parameters:

pak	the packet

Definition at line 60 of file buffer.cpp.

{
    pthread_mutex_lock ( &buf_lock );

    intBuffer.push (pak);

    pthread_mutex_unlock ( &buf_lock );
    }

---

Member Data Documentation

pthread_mutex_t Buffer::buf_lock [private]

The mutex lock to make the buffer threadsafe.

Definition at line 44 of file buffer.h.

pthread_mutex_t Buffer::buf_waitlock [private]

not used/obsolete.

Definition at line 45 of file buffer.h.

int Buffer::checkSleep [private]

the time it waits after realizing that the buffer is empty.

Definition at line 43 of file buffer.h.

queue<packet *> Buffer::intBuffer [private]

internal queue.

Definition at line 46 of file buffer.h.

---

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

• buffer.h
• buffer.cpp

---