RakNet::Client_PerTitleBinaryStorage Struct Reference
[Lobby2Commands]
For each combination of user and title, structures can be stored.
More...
#include <Lobby2Message.h>
Public Types | |
| enum | PTIS_Operation |
Public Member Functions | |
| virtual bool | RequiresAdmin (void) const |
| virtual bool | RequiresRankingPermission (void) const |
| virtual bool | CancelOnDisconnect (void) const |
| virtual bool | RequiresLogin (void) const |
| virtual void | Serialize (bool writeToBitstream, bool serializeOutput, RakNet::BitStream *bitStream) |
| Overridable serialization of the contents of this message. Defaults to SerializeBase(). | |
| virtual bool | PrevalidateInput (void) |
Public Attributes | |
| RakNet::RakString | titleName |
| [in] Name of a created title | |
| unsigned int | slotIndex |
| [in] Slot index can be any value, and just lets you store more than one 64 bit integer | |
| RakNetSmartPtr< BinaryDataBlock > | binaryData |
| enum RakNet::Client_PerTitleBinaryStorage::PTIS_Operation | operationToPerform |
Detailed Description
For each combination of user and title, structures can be stored.Member Enumeration Documentation
[in] What to do. Write will overwrite the existing value with binaryData Read will return the existing value in binaryData
Member Function Documentation
| virtual bool RakNet::Client_PerTitleBinaryStorage::CancelOnDisconnect | ( | void | ) | const [inline, virtual] |
Should this message not be processed on the server if the requesting user disconnects before it completes? This should be true for functions that only return data. False for functions that affect other users, or change the database
Implements RakNet::Lobby2Message.
| virtual bool RakNet::Client_PerTitleBinaryStorage::PrevalidateInput | ( | void | ) | [virtual] |
If data members can be validated for correctness in the server's main thread, override this function and do those checks here.
- Returns:
- True for input OK. False if the input is bad and does not need to be further processed in the database threads.
Reimplemented from RakNet::Lobby2Message.
| virtual bool RakNet::Client_PerTitleBinaryStorage::RequiresAdmin | ( | void | ) | const [inline, virtual] |
Is this message something that should only be run by a system with admin privileges? Set admin privileges with Lobby2Server::AddAdminAddress()
Implements RakNet::Lobby2Message.
| virtual bool RakNet::Client_PerTitleBinaryStorage::RequiresLogin | ( | void | ) | const [inline, virtual] |
Does this function require logging into the server before it can be executed? If true, the user id and user handle will be automatically inferred by the last login by looking up the sender's system address. If false, the message should include the username so the database query can lookup which user is performing this operation.
Implements RakNet::Lobby2Message.
| virtual bool RakNet::Client_PerTitleBinaryStorage::RequiresRankingPermission | ( | void | ) | const [inline, virtual] |
Is this message something that should only be run by a system with ranking upload priviledges? Set ranking privileges with Lobby2Server::AddRankingAddress()
Implements RakNet::Lobby2Message.
Member Data Documentation
| RakNetSmartPtr<BinaryDataBlock> RakNet::Client_PerTitleBinaryStorage::binaryData |
[in/out] Binary data. On Write, will be written to the row. On Read, will be filled in with the value of the row. Unused for delete Max length of binaryData is 256K
| enum RakNet::Client_PerTitleBinaryStorage::PTIS_Operation RakNet::Client_PerTitleBinaryStorage::operationToPerform |
[in] What to do. Write will overwrite the existing value with binaryData Read will return the existing value in binaryData
The documentation for this struct was generated from the following file:
- d:/temp/RakNet_PC/DependentExtensions/Lobby2/Lobby2Message.h
