You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
407 lines
15 KiB
407 lines
15 KiB
/*==LICENSE==* |
|
|
|
CyanWorlds.com Engine - MMOG client, server and tools |
|
Copyright (C) 2011 Cyan Worlds, Inc. |
|
|
|
This program is free software: you can redistribute it and/or modify |
|
it under the terms of the GNU General Public License as published by |
|
the Free Software Foundation, either version 3 of the License, or |
|
(at your option) any later version. |
|
|
|
This program is distributed in the hope that it will be useful, |
|
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
GNU General Public License for more details. |
|
|
|
You should have received a copy of the GNU General Public License |
|
along with this program. If not, see <http://www.gnu.org/licenses/>. |
|
|
|
Additional permissions under GNU GPL version 3 section 7 |
|
|
|
If you modify this Program, or any covered work, by linking or |
|
combining it with any of RAD Game Tools Bink SDK, Autodesk 3ds Max SDK, |
|
NVIDIA PhysX SDK, Microsoft DirectX SDK, OpenSSL library, Independent |
|
JPEG Group JPEG library, Microsoft Windows Media SDK, or Apple QuickTime SDK |
|
(or a modified version of those libraries), |
|
containing parts covered by the terms of the Bink SDK EULA, 3ds Max EULA, |
|
PhysX SDK EULA, DirectX SDK EULA, OpenSSL and SSLeay licenses, IJG |
|
JPEG Library README, Windows Media SDK EULA, or QuickTime SDK EULA, the |
|
licensors of this Program grant you additional |
|
permission to convey the resulting work. Corresponding Source for a |
|
non-source form of such a combination shall include the source code for |
|
the parts of OpenSSL and IJG JPEG Library used as well as that of the covered |
|
work. |
|
|
|
You can contact Cyan Worlds, Inc. by email legal@cyan.com |
|
or by snail mail at: |
|
Cyan Worlds, Inc. |
|
14617 N Newport Hwy |
|
Mead, WA 99021 |
|
|
|
*==LICENSE==*/ |
|
/***************************************************************************** |
|
* |
|
* $/Plasma20/Sources/Plasma/NucleusLib/pnNetProtocol/Private/pnNpCommon.h |
|
* |
|
***/ |
|
|
|
#ifdef PLASMA20_SOURCES_PLASMA_NUCLEUSLIB_PNNETPROTOCOL_PRIVATE_PNNPCOMMON_H |
|
#error "Header $/Plasma20/Sources/Plasma/NucleusLib/pnNetProtocol/Private/pnNpCommon.h included more than once" |
|
#endif |
|
#define PLASMA20_SOURCES_PLASMA_NUCLEUSLIB_PNNETPROTOCOL_PRIVATE_PNNPCOMMON_H |
|
|
|
#include "pnUUID/pnUUID.h" |
|
#include "hsRefCnt.h" |
|
|
|
|
|
/***************************************************************************** |
|
* |
|
* Client message field types |
|
* |
|
***/ |
|
|
|
#ifdef USES_NETCLI |
|
|
|
const NetMsgField kNetMsgFieldAccountName = NET_MSG_FIELD_STRING(kMaxAccountNameLength); |
|
const NetMsgField kNetMsgFieldPlayerName = NET_MSG_FIELD_STRING(kMaxPlayerNameLength); |
|
const NetMsgField kNetMsgFieldShaDigest = NET_MSG_FIELD_RAW_DATA(sizeof(ShaDigest)); |
|
const NetMsgField kNetMsgFieldUuid = NET_MSG_FIELD_DATA(sizeof(plUUID)); |
|
const NetMsgField kNetMsgFieldTransId = NET_MSG_FIELD_DWORD(); |
|
const NetMsgField kNetMsgFieldTimeMs = NET_MSG_FIELD_DWORD(); |
|
const NetMsgField kNetMsgFieldENetError = NET_MSG_FIELD_DWORD(); |
|
const NetMsgField kNetMsgFieldEAgeId = NET_MSG_FIELD_DWORD(); |
|
const NetMsgField kNetMsgFieldNetNode = NET_MSG_FIELD_DWORD(); |
|
const NetMsgField kNetMsgFieldBuildId = NET_MSG_FIELD_DWORD(); |
|
|
|
#endif |
|
|
|
|
|
/***************************************************************************** |
|
* |
|
* Player information structures |
|
* |
|
***/ |
|
|
|
#pragma pack(push,1) |
|
struct SrvPlayerInfo { |
|
unsigned playerInt; |
|
wchar_t playerName[kMaxPlayerNameLength]; |
|
wchar_t avatarShape[kMaxVaultNodeStringLength]; |
|
unsigned explorer; |
|
}; |
|
#pragma pack(pop) |
|
|
|
|
|
/***************************************************************************** |
|
* |
|
* NetAgeInfo |
|
* |
|
***/ |
|
|
|
struct NetAgeInfo { |
|
plUUID ageInstId; |
|
wchar_t ageFilename[kMaxAgeNameLength]; |
|
wchar_t ageInstName[kMaxAgeNameLength]; |
|
wchar_t ageUserName[kMaxAgeNameLength]; |
|
wchar_t ageDesc[1024]; |
|
uint32_t ageSequenceNumber; |
|
uint32_t ageLanguage; |
|
uint32_t population; // only used with GetPublicAgeList query results |
|
uint32_t currentPopulation; // only used with GetPublicAgeList query results |
|
}; |
|
|
|
/***************************************************************************** |
|
* |
|
* NetGameScore |
|
* |
|
***/ |
|
|
|
struct NetGameScore { |
|
unsigned scoreId; |
|
unsigned ownerId; |
|
uint32_t createdTime; |
|
wchar_t gameName[kMaxGameScoreNameLength]; |
|
unsigned gameType; |
|
int value; |
|
|
|
unsigned Read (const uint8_t inbuffer[], unsigned bufsz, uint8_t** end = nil); // returns number of bytes read |
|
unsigned Write (ARRAY(uint8_t) * buffer) const; // returns number of bytes written |
|
|
|
void CopyFrom (const NetGameScore & score); |
|
}; |
|
|
|
/***************************************************************************** |
|
* |
|
* NetGameRank |
|
* |
|
***/ |
|
|
|
struct NetGameRank { |
|
unsigned rank; |
|
int score; |
|
wchar_t name[kMaxPlayerNameLength]; |
|
|
|
unsigned Read (const uint8_t inbuffer[], unsigned bufsz, uint8_t** end = nil); // returns number of bytes read |
|
unsigned Write (ARRAY(uint8_t) * buffer) const; // returns number of bytes written |
|
|
|
void CopyFrom (const NetGameRank & fromRank); |
|
}; |
|
|
|
/***************************************************************************** |
|
* |
|
* Server vault structures |
|
* |
|
***/ |
|
|
|
class NetVaultNode : public hsRefCnt |
|
{ |
|
protected: |
|
enum NodeFields |
|
{ |
|
kNodeId = (1 << 0), |
|
kCreateTime = (1 << 1), |
|
kModifyTime = (1 << 2), |
|
kCreateAgeName = (1 << 3), |
|
kCreateAgeUuid = (1 << 4), |
|
kCreatorAcct = (1 << 5), |
|
kCreatorId = (1 << 6), |
|
kNodeType = (1 << 7), |
|
kInt32_1 = (1 << 8), |
|
kInt32_2 = (1 << 9), |
|
kInt32_3 = (1 << 10), |
|
kInt32_4 = (1 << 11), |
|
kUInt32_1 = (1 << 12), |
|
kUInt32_2 = (1 << 13), |
|
kUInt32_3 = (1 << 14), |
|
kUInt32_4 = (1 << 15), |
|
kUuid_1 = (1 << 16), |
|
kUuid_2 = (1 << 17), |
|
kUuid_3 = (1 << 18), |
|
kUuid_4 = (1 << 19), |
|
kString64_1 = (1 << 20), |
|
kString64_2 = (1 << 21), |
|
kString64_3 = (1 << 22), |
|
kString64_4 = (1 << 23), |
|
kString64_5 = (1 << 24), |
|
kString64_6 = (1 << 25), |
|
kIString64_1 = (1 << 26), |
|
kIString64_2 = (1 << 27), |
|
kText_1 = (1 << 28), |
|
kText_2 = (1 << 29), |
|
kBlob_1 = (1 << 30), |
|
kBlob_2 = (1 << 31), |
|
|
|
kValidFields = (kNodeId | kCreateTime | kModifyTime | kCreateAgeName | kCreateAgeUuid | |
|
kCreatorAcct | kCreatorId | kNodeType | kInt32_1 | kInt32_2 | kInt32_3 | |
|
kInt32_4 | kUInt32_1 | kUInt32_2 | kUInt32_3 | kUInt32_3 | kUInt32_4 | |
|
kUuid_1 | kUuid_2 | kUuid_3 | kUuid_4 | kString64_1 | kString64_2 | |
|
kString64_3 | kString64_4 | kString64_5 | kString64_6 | kIString64_1 | |
|
kIString64_2 | kText_1 | kText_2 | kBlob_1 | kBlob_2) |
|
}; |
|
|
|
public: |
|
/** |
|
* This is public only so that it may be referenced by anonymous functions. |
|
* Should not be used outside NetVaultNode. |
|
*/ |
|
struct Blob |
|
{ |
|
size_t size; |
|
uint8_t* buffer; |
|
|
|
Blob() : size(0), buffer(nullptr) { } |
|
Blob(const Blob &rhs); |
|
Blob(Blob &&rhs); |
|
~Blob() { delete[] buffer; } |
|
|
|
void operator =(const Blob& rhs); |
|
void operator =(Blob&& rhs); |
|
|
|
bool operator ==(const Blob& rhs) const; |
|
bool operator !=(const Blob& rhs) const { return !operator==(rhs); } |
|
}; |
|
|
|
private: |
|
|
|
uint64_t fUsedFields; |
|
uint64_t fDirtyFields; |
|
plUUID fRevision; |
|
|
|
uint32_t fNodeId; |
|
uint32_t fCreateTime; |
|
uint32_t fModifyTime; |
|
plString fCreateAgeName; |
|
plUUID fCreateAgeUuid; |
|
plUUID fCreatorAcct; |
|
uint32_t fCreatorId; |
|
uint32_t fNodeType; |
|
int32_t fInt32_1; |
|
int32_t fInt32_2; |
|
int32_t fInt32_3; |
|
int32_t fInt32_4; |
|
uint32_t fUInt32_1; |
|
uint32_t fUInt32_2; |
|
uint32_t fUInt32_3; |
|
uint32_t fUInt32_4; |
|
plUUID fUuid_1; |
|
plUUID fUuid_2; |
|
plUUID fUuid_3; |
|
plUUID fUuid_4; |
|
plString fString64_1; |
|
plString fString64_2; |
|
plString fString64_3; |
|
plString fString64_4; |
|
plString fString64_5; |
|
plString fString64_6; |
|
plString fIString64_1; |
|
plString fIString64_2; |
|
plString fText_1; |
|
plString fText_2; |
|
Blob fBlob_1; |
|
Blob fBlob_2; |
|
|
|
template<typename T> |
|
inline void ISetVaultField(uint64_t bits, T& field, T value) |
|
{ |
|
field = value; |
|
fUsedFields |= bits; |
|
fDirtyFields |= bits; |
|
} |
|
|
|
template<typename T> |
|
inline void ISetVaultField_NoDirty(uint64_t bits, T& field, T value) |
|
{ |
|
field = value; |
|
fUsedFields |= bits; |
|
} |
|
|
|
void ISetVaultBlob(uint64_t bits, Blob& blob, const uint8_t* buf, size_t size); |
|
|
|
public: |
|
enum IOFlags |
|
{ |
|
/** Only write fields marked dirty */ |
|
kDirtyOnly = (1 << 0), |
|
|
|
/** Clears the dirty flag on fields written to the stream */ |
|
kClearDirty = (1 << 1), |
|
|
|
/** Indicates that we should mark the NodeType fields as dirty before writing */ |
|
kDirtyNodeType = (1 << 2), |
|
|
|
/** Indicates that we should mark the String64_1 field as dirty before writing */ |
|
kDirtyString64_1 = (1 << 3), |
|
}; |
|
|
|
public: |
|
NetVaultNode() |
|
: fNodeId(0), fCreateTime(0), fModifyTime(0), fCreatorId(0), fNodeType(0), fInt32_1(0), |
|
fInt32_2(0), fInt32_3(0), fInt32_4(0), fUInt32_1(0), fUInt32_2(0), fUInt32_3(0), |
|
fUInt32_4(0), fUsedFields(0), fDirtyFields(0) |
|
{ } |
|
|
|
/** Clears this NetVaultNode for subsequent usage */ |
|
void Clear(); |
|
|
|
/** Copies data from \a node to this NetVaultNode */ |
|
void CopyFrom(const NetVaultNode* node); |
|
|
|
bool Matches(const NetVaultNode* rhs) const; |
|
|
|
void Read(const uint8_t* buf, size_t size); |
|
void Write(ARRAY(uint8_t)* buf, uint32_t ioFlags=0); |
|
|
|
protected: |
|
uint64_t GetFieldFlags() const { return fUsedFields; } |
|
|
|
public: |
|
bool IsDirty() const { return fDirtyFields != 0; } |
|
|
|
plUUID GetRevision() const { return fRevision; } |
|
void GenerateRevision() { fRevision = plUUID::Generate(); } |
|
|
|
uint32_t GetNodeId() const { return fNodeId; } |
|
uint32_t GetCreateTime() const { return fCreateTime; } |
|
uint32_t GetModifyTime() const { return fModifyTime; } |
|
plString GetCreateAgeName() const { return fCreateAgeName; } |
|
plUUID GetCreateAgeUuid() const { return fCreateAgeUuid; } |
|
plUUID GetCreatorAcct() const { return fCreatorAcct; } |
|
uint32_t GetCreatorId() const { return fCreatorId; } |
|
uint32_t GetNodeType() const { return fNodeType; } |
|
int32_t GetInt32_1() const { return fInt32_1; } |
|
int32_t GetInt32_2() const { return fInt32_2; } |
|
int32_t GetInt32_3() const { return fInt32_3; } |
|
int32_t GetInt32_4() const { return fInt32_4; } |
|
uint32_t GetUInt32_1() const { return fUInt32_1; } |
|
uint32_t GetUInt32_2() const { return fUInt32_2; } |
|
uint32_t GetUInt32_3() const { return fUInt32_3; } |
|
uint32_t GetUInt32_4() const { return fUInt32_4; } |
|
plUUID GetUuid_1() const { return fUuid_1; } |
|
plUUID GetUuid_2() const { return fUuid_2; } |
|
plUUID GetUuid_3() const { return fUuid_3; } |
|
plUUID GetUuid_4() const { return fUuid_4; } |
|
plString GetString64_1() const { return fString64_1; } |
|
plString GetString64_2() const { return fString64_2; } |
|
plString GetString64_3() const { return fString64_3; } |
|
plString GetString64_4() const { return fString64_4; } |
|
plString GetString64_5() const { return fString64_5; } |
|
plString GetString64_6() const { return fString64_6; } |
|
plString GetIString64_1() const { return fIString64_1; } |
|
plString GetIString64_2() const { return fIString64_2; } |
|
plString GetText_1() const { return fText_1; } |
|
plString GetText_2() const { return fText_2; } |
|
|
|
const uint8_t* GetBlob_1() const { return fBlob_1.buffer; } |
|
size_t GetBlob_1Length() const { return fBlob_1.size; } |
|
|
|
const uint8_t* GetBlob_2() const { return fBlob_2.buffer; } |
|
size_t GetBlob_2Length() const { return fBlob_2.size; } |
|
|
|
public: |
|
void SetNodeId(uint32_t value) { ISetVaultField(kNodeId, fNodeId, value); } |
|
void SetNodeId_NoDirty(uint32_t value) { ISetVaultField_NoDirty(kNodeId, fNodeId, value); } |
|
void SetCreateTime(uint32_t value) { ISetVaultField(kCreateTime, fCreateTime, value); } |
|
void SetModifyTime(uint32_t value) { ISetVaultField(kModifyTime, fModifyTime, value); } |
|
void SetCreateAgeName(plString value) { ISetVaultField(kCreateAgeName, fCreateAgeName, value); } |
|
void SetCreateAgeUuid(plUUID value) { ISetVaultField(kCreateAgeUuid, fCreateAgeUuid, value); } |
|
void SetCreatorAcct(plUUID value) { ISetVaultField(kCreatorAcct, fCreatorAcct, value); } |
|
void SetCreatorId(uint32_t value) { ISetVaultField(kCreatorId, fCreatorId, value); } |
|
void SetNodeType(uint32_t value) { ISetVaultField(kNodeType, fNodeType, value); } |
|
void SetInt32_1(int32_t value) { ISetVaultField(kInt32_1, fInt32_1, value); } |
|
void SetInt32_2(int32_t value) { ISetVaultField(kInt32_2, fInt32_2, value); } |
|
void SetInt32_3(int32_t value) { ISetVaultField(kInt32_3, fInt32_3, value); } |
|
void SetInt32_4(int32_t value) { ISetVaultField(kInt32_4, fInt32_4, value); } |
|
void SetUInt32_1(uint32_t value) { ISetVaultField(kUInt32_1, fUInt32_1, value); } |
|
void SetUInt32_2(uint32_t value) { ISetVaultField(kUInt32_2, fUInt32_2, value); } |
|
void SetUInt32_3(uint32_t value) { ISetVaultField(kUInt32_3, fUInt32_3, value); } |
|
void SetUInt32_4(uint32_t value) { ISetVaultField(kUInt32_4, fUInt32_4, value); } |
|
void SetUuid_1(const plUUID& value) { ISetVaultField(kUuid_1, fUuid_1, value); } |
|
void SetUuid_2(const plUUID& value) { ISetVaultField(kUuid_2, fUuid_2, value); } |
|
void SetUuid_3(const plUUID& value) { ISetVaultField(kUuid_3, fUuid_3, value); } |
|
void SetUuid_4(const plUUID& value) { ISetVaultField(kUuid_4, fUuid_4, value); } |
|
void SetString64_1(const plString& value) { ISetVaultField(kString64_1, fString64_1, value); } |
|
void SetString64_2(const plString& value) { ISetVaultField(kString64_2, fString64_2, value); } |
|
void SetString64_3(const plString& value) { ISetVaultField(kString64_3, fString64_3, value); } |
|
void SetString64_4(const plString& value) { ISetVaultField(kString64_4, fString64_4, value); } |
|
void SetString64_5(const plString& value) { ISetVaultField(kString64_5, fString64_5, value); } |
|
void SetString64_6(const plString& value) { ISetVaultField(kString64_6, fString64_6, value); } |
|
void SetIString64_1(const plString& value) { ISetVaultField(kIString64_1, fIString64_1, value); } |
|
void SetIString64_2(const plString& value) { ISetVaultField(kIString64_2, fIString64_2, value); } |
|
void SetText_1(const plString& value) { ISetVaultField(kText_1, fText_1, value); } |
|
void SetText_2(const plString& value) { ISetVaultField(kText_2, fText_2, value); } |
|
|
|
void SetBlob_1(const uint8_t* buf, size_t size) { ISetVaultBlob(kBlob_1, fBlob_1, buf, size); } |
|
void SetBlob_2(const uint8_t* buf, size_t size) { ISetVaultBlob(kBlob_2, fBlob_2, buf, size); } |
|
}; |
|
|
|
//============================================================================ |
|
// NetVaultNodeRef (packed because is sent over wire directly) |
|
//============================================================================ |
|
#pragma pack(push,1) |
|
struct NetVaultNodeRef { |
|
unsigned parentId; |
|
unsigned childId; |
|
unsigned ownerId; |
|
bool seen; |
|
}; |
|
#pragma pack(pop)
|
|
|