Planeshift
psAuthRejectedMessage Class Reference

Message sent from server to client if login was not valid. More...

#include <messages.h>

Public Member Functions

 psAuthRejectedMessage (uint32_t clientToken, const char *reason)
 Create psMessageBytes struct for outbound use. More...
 
 psAuthRejectedMessage (MsgEntry *message)
 Crack incoming psMessageBytes struct for inbound use. More...
 
 PSF_DECLARE_MSG_FACTORY ()
 
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

csString msgReason
 This is something like "account not valid" or "password not valid. More...
 
- 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 if login was not valid.

Definition at line 750 of file messages.h.

Constructor & Destructor Documentation

psAuthRejectedMessage::psAuthRejectedMessage ( uint32_t  clientToken,
const char *  reason 
)

Create psMessageBytes struct for outbound use.

psAuthRejectedMessage::psAuthRejectedMessage ( MsgEntry message)

Crack incoming psMessageBytes struct for inbound use.

Member Function Documentation

psAuthRejectedMessage::PSF_DECLARE_MSG_FACTORY ( )
virtual csString psAuthRejectedMessage::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

csString psAuthRejectedMessage::msgReason

This is something like "account not valid" or "password not valid.

Definition at line 754 of file messages.h.


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