Planeshift
psNPCAuthenticationMessage Class Reference

The message sent from superclient to server on login. More...

#include <npcmessages.h>

Public Member Functions

bool NetVersionOk ()
 
 PSF_DECLARE_MSG_FACTORY ()
 
 psNPCAuthenticationMessage (uint32_t clientnum, const char *userid, const char *password)
 This function creates a PS Message struct given a userid and password to send out. More...
 
 psNPCAuthenticationMessage (MsgEntry *message)
 This constructor receives a PS Message struct and cracks it apart to provide more easily usable fields. More...
 
- Public Member Functions inherited from psAuthenticationMessage
bool NetVersionOk ()
 
 psAuthenticationMessage (uint32_t clientnum, const char *userid, const char *password, const char *os, uint16 os_ver_major, uint16 os_ver_minor, const char *os_platform, const char *machine_type, const char *gfxcard, const char *gfxversion, const char *sPassword256="", uint32_t version=PS_NETVERSION)
 This function creates a PS Message struct given a userid and password to send out. More...
 
 psAuthenticationMessage (MsgEntry *message)
 This constructor receives a PS Message struct and cracks it apart to provide more easily usable fields. 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 ()
 

Additional Inherited Members

- Public Attributes inherited from psAuthenticationMessage
csString gfxcard_
 
csString gfxversion_
 
csString machine_type
 
uint32_t netversion
 
csString os_
 
csString os_platform
 
uint16 os_ver_major
 
uint16 os_ver_minor
 
csString sAddr
 
csString sPassword
 
csString sPassword256
 
csString sUser
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 
- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

The message sent from superclient to server on login.

Definition at line 46 of file npcmessages.h.

Constructor & Destructor Documentation

psNPCAuthenticationMessage::psNPCAuthenticationMessage ( uint32_t  clientnum,
const char *  userid,
const char *  password 
)

This function creates a PS Message struct given a userid and password to send out.

This would be used for outgoing, new message creation when a superclient wants to log in.

psNPCAuthenticationMessage::psNPCAuthenticationMessage ( 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 psNPCAuthenticationMessage::NetVersionOk ( )
psNPCAuthenticationMessage::PSF_DECLARE_MSG_FACTORY ( )

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