class CMailbox

Mailbox server class implementation.

Public Methods

	CMailbox () Default constructor. Initializes data to empty values.
	Setup (int iSocket) Initializes a new mailbox. Associates an unused mailbox to a socket.
	~CMailbox () Default destructor.
	Close () Close the mailbox.
bool	IsUsed () Returns true if the mailbox is in use.
const char*	GetName () Returns the mailbox name.
const int	GetSocket () Returns the associated socket.
const char*	GetMsgDest () Returns the message recipient.
const int	GetMsgLen () Returns the message body length.
const char*	GetMsgBody () Returns the incoming message body text
void	Delivered (bool bSuccess) Indicates the delivery success.
bool	HasPendingOutput () Returns true if the socket has pending output.
void	EnqueueData (const char * strData, int iLen) Enqueue output data.
bool	WriteEnqueuedData () Write outgoing data.
bool	CharReceived (unsigned char ch) Notifies mailbox of a character arrival.

Protected Fields

bool	m_bIsUsed Use flag. Indicates whether the mailbox is in use or not.
char	m_strName [ID_BUF_SIZE+1] Malbox Name. Contains the name of the mailbox.
int	m_iSocket Socket file descriptor number. This is the file descriptor number of the socket associated to the mailbox.
int	m_iState Mailbox state. This is the current state of the finite state machine which implements the mailbox.
int	m_iPosition Current input buffer position. This is the current position in the input buffer of the mailbox, it is u
int	m_iMsgLen Input message length. This is the read lenght of the body of the message which is being read.
int	m_iOutBufferSize Output buffer size. This is the size of the allocated output data buffer
int	m_iOutBufferLen Used portion of the output data buffer
char	m_strDest [ID_BUF_SIZE+1] Recipient mailbox identifier.
char	m_strBody [TXT_BUF_SIZE+1] Text of the incoming message
char*	m_strOutBuffer Dynamically allocated pending output data buffer

bool m_bIsUsed

Use flag. Indicates whether the mailbox is in use or not.

char m_strName[ID_BUF_SIZE+1]

Malbox Name. Contains the name of the mailbox.

int m_iSocket

Socket file descriptor number. This is the file descriptor number of the socket associated to the mailbox.

int m_iState

Mailbox state. This is the current state of the finite state machine which implements the mailbox.

int m_iPosition

Current input buffer position. This is the current position in the input buffer of the mailbox, it is u

int m_iMsgLen

Input message length. This is the read lenght of the body of the message which is being read.

int m_iOutBufferSize

Output buffer size. This is the size of the allocated output data buffer

int m_iOutBufferLen

Used portion of the output data buffer

char m_strDest[ID_BUF_SIZE+1]

Recipient mailbox identifier.

char m_strBody[TXT_BUF_SIZE+1]

Text of the incoming message

char* m_strOutBuffer

Dynamically allocated pending output data buffer

CMailbox()

Default constructor. Initializes data to empty values.

Setup(int iSocket)

Initializes a new mailbox. Associates an unused mailbox to a socket.

~CMailbox()

Default destructor.

Close()

Close the mailbox. Resets the mailbox associated data and indicates that the mailbox is unused and can be set up for new mailboxes.

bool IsUsed()

Returns true if the mailbox is in use. The mailbox is defined to be in use when it has an associated socket and a remote process connected to it, even if the remote process has not yet indicatet its name.

const char* GetName()

Returns the mailbox name. Returns the name of the mailbox which has been chosen by the remote process connected to it.

const int GetSocket()

Returns the associated socket. Returns the file descriptor of the socket currently associated to the mailbox.

const char* GetMsgDest()

Returns the message recipient. Returns the destination mailbox of the incoming message, if any. When the mailbox is not receiving any message (i.e. it is in the STATE\_WAITING state), this is the destination of the last incoming message.

const int GetMsgLen()

Returns the message body length. Returns the length of the body (therefore not counting recipient mailbox identifier, string terminator, length bytes) of the incoming message, if any. When the mailbox is not receiving any message (i.e. it is in the STATE_WAITING state), this is the body length of the last incoming message.

const char* GetMsgBody()

Returns the incoming message body text

void Delivered(bool bSuccess)

Indicates the delivery success. Indicates to the mailbox that the last incoming message has been (or not) correctly delivered to destination mailbox. This method notifies the success (or insuccess) to the process owning the mailbox.

bool HasPendingOutput()

Returns true if the socket has pending output. Returns true when the output pending data buffer is not empty. This represent a sort of request for the caller to call the WriteEnqueuedData() member as soon as the associated socket is ready for writing.

void EnqueueData(const char * strData, int iLen)

Enqueue output data. Appends outgoing data to the the mailbox output buffer.

bool WriteEnqueuedData()

Write outgoing data. Tries to write to the socket the outgoing pending data, through a non-blocking write() call.

bool CharReceived(unsigned char ch)

Notifies mailbox of a character arrival. Updates the mailbox finite state machine with a new input

Alphabetic index HTML hierarchy of classes or Java