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

#include <plNetMessage.h>

Inheritance diagram for plNetMessage:
plCreatable plNetMsgMembersListReq plNetMsgObject plNetMsgPlayerPage plNetMsgRelevanceRegions plNetMsgRoomsList plNetMsgServerToClient plNetMsgStream plNetMsgStreamedObject plNetMsgGameStateRequest plNetMsgPagingRoom plNetMsgGroupOwner plNetMsgInitialAgeStateSent plNetMsgMembersList plNetMsgMemberUpdate plNetMsgGameMessage

Public Types

enum  ContentFlags {
  kHasTimeSent = 0x1, kHasGameMsgRecvrs = 0x2, kEchoBackToSender = 0x4, kRequestP2P = 0x8,
  kAllowTimeOut = 0x10, kIndirectMember = 0x20, kPublicIPClient = 0x40, kHasContext = 0x80,
  kAskVaultForGameState = 0x100, kHasTransactionID = 0x200, kNewSDLState = 0x400, kInitialAgeStateRequest = 0x800,
  kHasPlayerID = 0x1000, kUseRelevanceRegions = 0x2000, kHasAcctUuid = 0x4000, kInterAgeRouting = 0x8000,
  kHasVersion = 0x10000, kIsSystemMessage = 0x20000, kNeedsReliableSend = 0x40000, kRouteToAllPlayers = 0x80000
}

Public Member Functions

 plNetMessage ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
unsigned int getFlags () const
unsigned char getProtocolVerMaj () const
unsigned char getProtocolVerMin () const
plUnifiedTime getTimeSent () const
unsigned int getContext () const
unsigned int getTransID () const
unsigned int getPlayerID () const
plUuid getAcctUuid () const
void setFlags (unsigned int flags)
void setTimeSent (const plUnifiedTime &timeSent)
void setContext (unsigned int context)
void setTransID (unsigned int transID)
void setPlayerID (unsigned int playerID)
void setAcctUuid (const plUuid &acctUuid)
void setProtocolVer (unsigned char maj, unsigned char min)
- 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)

Protected Member Functions

virtual void IPrcWrite (pfPrcHelper *prc)
virtual void IPrcParse (const pfPrcTag *tag, plResManager *mgr)

Member Enumeration Documentation

Enumerator:
kHasTimeSent 
kHasGameMsgRecvrs 
kEchoBackToSender 
kRequestP2P 
kAllowTimeOut 
kIndirectMember 
kPublicIPClient 
kHasContext 
kAskVaultForGameState 
kHasTransactionID 
kNewSDLState 
kInitialAgeStateRequest 
kHasPlayerID 
kUseRelevanceRegions 
kHasAcctUuid 
kInterAgeRouting 
kHasVersion 
kIsSystemMessage 
kNeedsReliableSend 
kRouteToAllPlayers 

Constructor & Destructor Documentation

plNetMessage::plNetMessage ( )

Member Function Documentation

plUuid plNetMessage::getAcctUuid ( ) const
unsigned int plNetMessage::getContext ( ) const
unsigned int plNetMessage::getFlags ( ) const
unsigned int plNetMessage::getPlayerID ( ) const
unsigned char plNetMessage::getProtocolVerMaj ( ) const
unsigned char plNetMessage::getProtocolVerMin ( ) const
plUnifiedTime plNetMessage::getTimeSent ( ) const
unsigned int plNetMessage::getTransID ( ) const
virtual void plNetMessage::IPrcParse ( const pfPrcTag tag,
plResManager mgr 
)
protectedvirtual

This must be overloaded by subclasses to parse PRC data specific to the class from the PRC document. It is called once for each tag that is a child to the Creatable tag itself, so subclasses should check for each supported tag and handle it accordingly if it matches. If the tag is not recognized, it should be passed along to the parent class.

Reimplemented from plCreatable.

Reimplemented in plNetMsgMemberUpdate, plNetMsgPagingRoom, plNetMsgMembersList, plNetMsgGameMessageDirected, plNetMsgSDLState, plNetMsgGroupOwner, plNetMsgGameMessage, plNetMsgRoomsList, plNetMsgLoadClone, plNetMsgStreamedObject, plNetMsgInitialAgeStateSent, plNetMsgRelevanceRegions, and plNetMsgObject.

virtual void plNetMessage::IPrcWrite ( pfPrcHelper prc)
protectedvirtual

This must be overloaded by subclasses to write PRC data specific to the class to the PRC document. Do not write the top-level creatable tag, that is handled by prcWrite().

Implements plCreatable.

Reimplemented in plNetMsgMemberUpdate, plNetMsgPagingRoom, plNetMsgMembersList, plNetMsgGameMessageDirected, plNetMsgSDLState, plNetMsgGroupOwner, plNetMsgGameMessage, plNetMsgRoomsList, plNetMsgLoadClone, plNetMsgStreamedObject, plNetMsgInitialAgeStateSent, plNetMsgRelevanceRegions, and plNetMsgObject.

virtual void plNetMessage::read ( hsStream ,
plResManager  
)
virtual
void plNetMessage::setAcctUuid ( const plUuid acctUuid)
void plNetMessage::setContext ( unsigned int  context)
void plNetMessage::setFlags ( unsigned int  flags)
void plNetMessage::setPlayerID ( unsigned int  playerID)
void plNetMessage::setProtocolVer ( unsigned char  maj,
unsigned char  min 
)
void plNetMessage::setTimeSent ( const plUnifiedTime timeSent)
void plNetMessage::setTransID ( unsigned int  transID)
virtual void plNetMessage::write ( hsStream ,
plResManager  
)
virtual

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