Planeshift
psMsgStringsMessage Class Reference

Message sent from server to client containing the message strings hash table. More...

#include <messages.h>

Public Member Functions

 PSF_DECLARE_MSG_FACTORY ()
 
 psMsgStringsMessage ()
 Create psMessageBytes struct for outbound use. More...
 
 psMsgStringsMessage (uint32_t clientnum, csMD5::Digest &digest)
 Create psMessageBytes struct for outbound use. More...
 
 psMsgStringsMessage (uint32_t clientnum, csMD5::Digest &digest, char *stringsdata, unsigned long size, uint32_t num_strings)
 Create psMessageBytes struct for outbound use. More...
 
 psMsgStringsMessage (MsgEntry *message)
 Crack incoming psMessageBytes struct for inbound use. More...
 
virtual csString ToString (NetBase::AccessPointers *accessPointers)
 Converts the message into human readable string. More...
 
- Public Member Functions inherited from psMessageCracker
void FireEvent ()
 Publishes the message to the local program. More...
 
virtual csString GetMessageTypeName () const =0
 Gets the name of the message type. More...
 
void Multicast (csArray< PublishDestination > &multi, uint32_t except, float range)
 Multicasts the message to all current connections. More...
 
 psMessageCracker ()
 
void SendMessage ()
 Sends the message to the client/server. More...
 
virtual ~psMessageCracker ()
 

Public Attributes

csMD5::Digest * digest
 
csStringHashReversible * msgstrings
 Message strings hash table pointer (null for outbound) This hash table will be allocated during message cracking, and must be deleted manually. More...
 
bool only_carrying_digest
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

Message sent from server to client containing the message strings hash table.

Definition at line 2586 of file messages.h.

Constructor & Destructor Documentation

psMsgStringsMessage::psMsgStringsMessage ( )

Create psMessageBytes struct for outbound use.

psMsgStringsMessage::psMsgStringsMessage ( uint32_t  clientnum,
csMD5::Digest &  digest 
)

Create psMessageBytes struct for outbound use.

psMsgStringsMessage::psMsgStringsMessage ( uint32_t  clientnum,
csMD5::Digest &  digest,
char *  stringsdata,
unsigned long  size,
uint32_t  num_strings 
)

Create psMessageBytes struct for outbound use.

psMsgStringsMessage::psMsgStringsMessage ( MsgEntry message)

Crack incoming psMessageBytes struct for inbound use.

Member Function Documentation

psMsgStringsMessage::PSF_DECLARE_MSG_FACTORY ( )
virtual csString psMsgStringsMessage::ToString ( NetBase::AccessPointers accessPointers)
virtual

Converts the message into human readable string.

Parameters
accessPointersA struct to a number of access pointers.
Returns
Return a human readable string for the message.

Implements psMessageCracker.

Member Data Documentation

csMD5::Digest* psMsgStringsMessage::digest

Definition at line 2618 of file messages.h.

csStringHashReversible* psMsgStringsMessage::msgstrings

Message strings hash table pointer (null for outbound) This hash table will be allocated during message cracking, and must be deleted manually.

Definition at line 2593 of file messages.h.

bool psMsgStringsMessage::only_carrying_digest

Definition at line 2619 of file messages.h.


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