libHSPlasma
Public Types | Public Member Functions | List of all members
plNetMsgStreamHelper Class Reference

#include <plNetMsgStream.h>

Inheritance diagram for plNetMsgStreamHelper:
plCreatable

Public Types

enum  CompressionType { kCompressionNone, kCompressionFailed, kCompressionZlib, kCompressionDont }

Public Member Functions

 plNetMsgStreamHelper ()
 ~plNetMsgStreamHelper ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
const unsigned char * getStream () const
unsigned int getStreamLength () const
unsigned int getUncompressedSize () const
unsigned char getCompressionType () const
void setStream (const unsigned char *stream, unsigned int length)
void setUncompressedSize (unsigned int size)
void setCompressionType (unsigned char type)
- Public Member Functions inherited from plCreatable
 plCreatable ()
virtual ~plCreatable ()
virtual short ClassIndex () const =0
short ClassIndex (PlasmaVer ver) const
virtual const char * ClassName () const
virtual bool ClassInstance (short) const
virtual bool isStub () const
virtual void prcWrite (pfPrcHelper *prc)
virtual void prcParse (const pfPrcTag *tag, plResManager *mgr)

Additional Inherited Members

- Protected Member Functions inherited from plCreatable
virtual void IPrcWrite (pfPrcHelper *prc)=0
virtual void IPrcParse (const pfPrcTag *tag, plResManager *mgr)

Member Enumeration Documentation

Enumerator:
kCompressionNone 
kCompressionFailed 
kCompressionZlib 
kCompressionDont 

Constructor & Destructor Documentation

plNetMsgStreamHelper::plNetMsgStreamHelper ( )
plNetMsgStreamHelper::~plNetMsgStreamHelper ( )

Member Function Documentation

unsigned char plNetMsgStreamHelper::getCompressionType ( ) const
const unsigned char* plNetMsgStreamHelper::getStream ( ) const
unsigned int plNetMsgStreamHelper::getStreamLength ( ) const
unsigned int plNetMsgStreamHelper::getUncompressedSize ( ) const
virtual void plNetMsgStreamHelper::read ( hsStream ,
plResManager  
)
virtual

Reads this creatable directly from the stream. If any keys are read, they will be added to the plResManager automatically.

Reimplemented from plCreatable.

void plNetMsgStreamHelper::setCompressionType ( unsigned char  type)
void plNetMsgStreamHelper::setStream ( const unsigned char *  stream,
unsigned int  length 
)
void plNetMsgStreamHelper::setUncompressedSize ( unsigned int  size)
virtual void plNetMsgStreamHelper::write ( hsStream ,
plResManager  
)
virtual

Writes this creatable directly to the stream. The plResManager is used to manage any key references written by this creatable.

Reimplemented from plCreatable.


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