The message sent from client to server on login. More...
#include <messages.h>
Public Member Functions | |
| 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 () |
Public Attributes | |
| 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< MsgEntry > | msg |
| bool | valid |
Additional Inherited Members | |
| Static Public Attributes inherited from psMessageCracker | |
| static MsgHandler * | msghandler |
Detailed Description
The message sent from client to server on login.
Definition at line 587 of file messages.h.
Constructor & Destructor Documentation
| psAuthenticationMessage::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.
This would be used for outgoing, new message creation when a user wants to log in.
| psAuthenticationMessage::psAuthenticationMessage | ( | 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 psAuthenticationMessage::NetVersionOk | ( | ) |
| psAuthenticationMessage::PSF_DECLARE_MSG_FACTORY | ( | ) |
|
virtual |
Converts the message into human readable string.
- Parameters
-
accessPointers A struct to a number of access pointers.
- Returns
- Return a human readable string for the message.
Implements psMessageCracker.
Member Data Documentation
| csString psAuthenticationMessage::gfxcard_ |
Definition at line 591 of file messages.h.
| csString psAuthenticationMessage::gfxversion_ |
Definition at line 591 of file messages.h.
| csString psAuthenticationMessage::machine_type |
Definition at line 591 of file messages.h.
| uint32_t psAuthenticationMessage::netversion |
Definition at line 590 of file messages.h.
| csString psAuthenticationMessage::os_ |
Definition at line 591 of file messages.h.
| csString psAuthenticationMessage::os_platform |
Definition at line 591 of file messages.h.
| uint16 psAuthenticationMessage::os_ver_major |
Definition at line 599 of file messages.h.
| uint16 psAuthenticationMessage::os_ver_minor |
Definition at line 599 of file messages.h.
| csString psAuthenticationMessage::sAddr |
Definition at line 591 of file messages.h.
| csString psAuthenticationMessage::sPassword |
Definition at line 591 of file messages.h.
| csString psAuthenticationMessage::sPassword256 |
Definition at line 591 of file messages.h.
| csString psAuthenticationMessage::sUser |
Definition at line 591 of file messages.h.
The documentation for this class was generated from the following file:
- common/net/messages.h
