POPartialMsg Class Reference

Can only be used internally to send large messages in many parts. More...

#include <POPartialMsg.h>

Inheritance diagram for POPartialMsg:

List of all members.

Public Member Functions
	POPartialMsg (int num=0, int of=0, char *buffer=NULL, int size=0)
	POPartialMsg (const POPartialMsg &cpy)
virtual	~POPartialMsg ()
virtual string	messageType () const
virtual POMessage *	clone () const
int	getBufferSize () const
int	getNumber () const
int	getMaxNum () const
char *	getData () const
int	packsize () const
int	pack (char *buf) const
int	unpack (char *buf)

---

Detailed Description

Can only be used internally to send large messages in many parts.

---

Constructor & Destructor Documentation

POPartialMsg::POPartialMsg (  int  num = 0, int  of = 0, char *  data = NULL, int  size = 0 )

Parameters: num  - the number in series out of max of  - the number of segments in the series data  - the data to send size  - the size of the data

POPartialMsg::POPartialMsg (  const POPartialMsg &  cpy  )

POPartialMsg::~POPartialMsg (   )  [virtual]

---

Member Function Documentation

POMessage * POPartialMsg::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.

int POPartialMsg::getBufferSize (   )  const [inline]

char* POPartialMsg::getData (   )  const [inline]

int POPartialMsg::getMaxNum (   )  const [inline]

int POPartialMsg::getNumber (   )  const [inline]

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

Reimplemented from POMessage.

int POPartialMsg::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 POPartialMsg::packsize (   )  const

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

int POPartialMsg::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:

• POPartialMsg.h
• POPartialMsg.cpp

---