POBoxListMsg Class Reference

#include <POBoxListMsg.h>

Inheritance diagram for POBoxListMsg:

List of all members.

Public Types
enum	BOXCMD { NEWBOXES, CLOSEBOXES }
Public Member Functions
	POBoxListMsg (int cmd=NEWBOXES)
	POBoxListMsg (const POBoxListMsg &cpy)
virtual	~POBoxListMsg ()
string	messageType () const
void	addBox (const string &box)
vector< string >	getBoxes () const
int	getCommand () const
POMessage *	clone () const
int	packsize () const
int	pack (char *buffer) const
int	unpack (char *buffer)

---

Member Enumeration Documentation

enum POBoxListMsg::BOXCMD

Enumeration values: NEWBOXES  CLOSEBOXES

---

Constructor & Destructor Documentation

POBoxListMsg::POBoxListMsg (  int  cmd = NEWBOXES  )

POBoxListMsg::POBoxListMsg (  const POBoxListMsg &  cpy  )

virtual POBoxListMsg::~POBoxListMsg (   )  [inline, virtual]

---

Member Function Documentation

void POBoxListMsg::addBox (  const string &  box  )

POMessage * POBoxListMsg::clone (   )  const [virtual]

Creates an identical copy of this message. This function must be overloaded in derived classes. Returns: a copy of this message Reimplemented from POMessage.

vector<string> POBoxListMsg::getBoxes (   )  const [inline]

int POBoxListMsg::getCommand (   )  const [inline]

string POBoxListMsg::messageType (   )  const [inline, virtual]

Reimplemented from POMessage.

int POBoxListMsg::pack (  char *  buffer  )  const

packs the message into a pre-alocated buffer of size >= packsize() Parameters: buffer  - the buffer to pack into Returns: the number of bytes packed Reimplemented from POMessage.

int POBoxListMsg::packsize (   )  const

calculates the number of bytes needed to pack this message Returns: size in bytes Reimplemented from POMessage.

int POBoxListMsg::unpack (  char *  buffer  )

unpacks the message, setting source, destination, and derived type Parameters: buffer  the buffer to unpack, must be valid, no error checking Returns: the number of bytes unpacked Reimplemented from POMessage.

---

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

• POBoxListMsg.h
• POBoxListMsg.cpp

---