Planeshift
psPreAuthenticationMessage Class Reference

The message sent from client to server before login. More...

#include <messages.h>

Public Member Functions

bool NetVersionOk ()
 
 PSF_DECLARE_MSG_FACTORY ()
 
 psPreAuthenticationMessage (uint32_t clientnum, uint32_t version=PS_NETVERSION)
 Creates a message for requesting auth from server. More...
 
 psPreAuthenticationMessage (MsgEntry *message)
 This constructor receives a PS Message struct and cracks it apart to provide more easily usable fields. 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

uint32_t netversion
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

The message sent from client to server before login.

It is just a request for a random number from the server for the client to encrypt against

Definition at line 555 of file messages.h.

Constructor & Destructor Documentation

psPreAuthenticationMessage::psPreAuthenticationMessage ( uint32_t  clientnum,
uint32_t  version = PS_NETVERSION 
)

Creates a message for requesting auth from server.

psPreAuthenticationMessage::psPreAuthenticationMessage ( MsgEntry message)

This constructor receives a PS Message struct and cracks it apart to provide more easily usable fields.

It is intended for use on incoming messages.

Member Function Documentation

bool psPreAuthenticationMessage::NetVersionOk ( )
psPreAuthenticationMessage::PSF_DECLARE_MSG_FACTORY ( )
virtual csString psPreAuthenticationMessage::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

uint32_t psPreAuthenticationMessage::netversion

Definition at line 558 of file messages.h.


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