 |
Diarkis C++Client Library API Document
|
Go to the documentation of this file.
19 using namespace Network;
53 : _id(id), _name(name), _metadata(metadata)
79 maxMembers_ = maxMembers;
169 bool GetReconnect()
const;
209 bool IsSuccess()
const;
225 uint16_t GetErrorCode()
const;
239 const bool isSuccess;
242 const uint16_t errCode;
278 const uint8_t* GetPayload()
const;
279 size_t GetPayloadSize()
const;
287 const uint8_t* payload;
288 const size_t payloadSize;
327 uint16_t GetPort()
const;
334 uint64_t GetHolePunchTime()
const;
345 const uint64_t holePunchTime;
383 uint16_t GetPort()
const;
431 uint16_t GetPort()
const;
472 uint16_t GetPort()
const;
509 uint32_t GetErrorCode()
const;
523 const uint32_t errorCode;
543 bool IsSuccess()
const;
557 uint32_t GetCreationTime()
const;
566 uint16_t GetErrorCode()
const;
580 const bool isSuccess;
582 const uint32_t creationTime;
584 const uint16_t errCode;
604 bool IsSuccess()
const;
611 uint32_t GetCreatedAt()
const;
620 uint16_t GetErrorCode()
const;
634 const bool isSuccess;
635 const uint32_t createdAt;
637 const uint16_t errCode;
657 bool IsSuccess()
const;
673 uint16_t GetErrorCode()
const;
687 const bool isSuccess;
689 const uint16_t errCode;
709 bool IsSuccess()
const;
718 uint16_t GetErrorCode()
const;
732 const bool isSuccess;
733 const uint16_t errCode;
777 bool IsSuccess()
const;
784 int64_t GetDelta()
const;
800 uint16_t GetErrorCode()
const;
814 const bool isSuccess;
817 const uint16_t errCode;
835 int64_t GetDelta()
const;
869 bool IsSuccess()
const;
885 uint16_t GetErrorCode()
const;
899 const bool isSuccess;
901 const uint16_t errCode;
921 bool IsSuccess()
const;
944 uint16_t GetErrorCode()
const;
958 const bool isSuccess;
961 const uint16_t errCode;
981 bool IsSuccess()
const;
995 uint32_t GetNumber()
const;
1002 uint32_t GetMaxNumber()
const;
1011 uint16_t GetErrorCode()
const;
1025 const bool isSuccess;
1029 const uint16_t errCode;
1050 bool IsSuccess()
const;
1066 uint16_t GetErrorCode()
const;
1080 const bool isSuccess;
1082 const uint16_t errCode;
1102 bool IsSuccess()
const;
1118 uint16_t GetErrorCode()
const;
1132 const bool isSuccess;
1134 const uint16_t errCode;
1178 bool IsSuccess()
const;
1201 uint16_t GetErrorCode()
const;
1215 const bool isSuccess;
1218 const uint16_t errCode;
1280 bool IsSuccess()
const;
1290 uint16_t GetErrorCode()
const;
1305 const bool isSuccess_;
1306 const uint16_t errCode_;
1331 uint16_t GetCommand()
const;
1345 bool IsReliable()
const;
1353 const uint8_t version;
1354 const uint16_t command;
1356 const bool reliable;
1380 uint16_t GetCommand()
const;
1387 uint8_t GetStatus()
const;
1400 bool IsReliable()
const;
1408 const uint8_t version;
1409 const uint16_t command;
1410 const uint8_t status;
1412 const bool reliable;
1429 uint32_t GetRoundTripMs()
const;
1444 const uint32_t roundTripMs;
1462 uint32_t GetRoundTripMs()
const;
1477 const uint32_t roundTripMs;
1497 bool IsSuccess()
const;
1512 uint8_t GetNATType()
const;
1521 uint16_t GetErrorCode()
const;
1535 const bool isSuccess_;
1536 const uint8_t natType_;
1537 const uint16_t errCode_;
1556 bool IsSuccess()
const;
1572 uint16_t GetErrorCode()
const;
1588 const uint16_t errCode;
1608 bool IsSuccess()
const;
1624 uint16_t GetErrorCode()
const;
1633 const uint16_t errCode;
1674 uint8_t GetTicketType()
const;
1681 uint8_t ticketType_;
1700 bool IsSuccess()
const;
1723 uint16_t GetErrorCode()
const;
1733 const uint16_t errCode;
1752 bool IsSuccess()
const;
1775 uint16_t GetErrorCode()
const;
1785 const uint16_t errCode;
1827 bool IsSuccess()
const;
1836 bool IsEncryptionEnabled()
const;
1848 const bool bEncryption;
1902 bool IsSuccess()
const;
1909 uint8_t GetSessionType()
const;
1925 uint16_t GetErrorCode()
const;
1932 const StdString& GetErrorMessage()
const;
1939 const bool isSuccess_;
1940 const uint8_t sessionType_;
1942 const uint16_t errCode_;
1961 uint8_t GetSessionType()
const;
1970 uint8_t sessionType;
2002 uint8_t GetSessionType()
const;
2011 uint8_t sessionType_;
2032 bool IsSuccess()
const;
2040 uint8_t GetSessionType()
const;
2056 uint16_t GetCurrentMembers()
const;
2064 uint16_t GetMaxMembers()
const;
2090 uint16_t GetErrorCode()
const;
2097 const StdString& GetErrorMessage()
const;
2101 uint8_t sessionType,
2103 uint16_t currentMembers,
2104 uint16_t maxMembers,
2114 const bool isSuccess_;
2115 uint8_t sessionType_;
2117 uint16_t currentMembers_;
2118 uint16_t maxMembers_;
2121 const uint16_t errCode;
2141 bool IsSuccess()
const;
2150 uint16_t GetErrorCode()
const;
2164 const bool isSuccess;
2165 const uint16_t errCode;
2185 bool IsSuccess()
const;
2194 uint16_t GetErrorCode()
const;
2208 const bool isSuccess;
2209 const uint16_t errCode;
Argument of the callback event called when the value of the Room property is increased or decreased.
Definition: eventArgs.h:767
Arguments of the callback event called when an UDP Ping is received.
Definition: eventArgs.h:1454
Arguments of callback events called when received the response of Diarkis::Modules::IDiarkisRoom::Upd...
Definition: eventArgs.h:1270
Definition: eventArgs.h:113
@ OBJ_INC_MODE
Increments the value of object.
Diarkis::StdString message
Definition: eventArgs.h:130
Arguments of the callback event called when received Session response.
Definition: eventArgs.h:2131
Arguments of the callback event called when received Session Notification.
Definition: eventArgs.h:1952
Arguments of the callback event to be called when TicketCancel push is received.
Definition: eventArgs.h:1666
Arguments of the callback event called when joining or leaving a Field.
Definition: eventArgs.h:2175
Diarkis::StdString _id
Room ID.
Definition: eventArgs.h:46
Diarkis::StdString _name
Room display name.
Definition: eventArgs.h:48
Arguments of the callback event called when a payload is sent or received.
Definition: eventArgs.h:252
Argument of the callback event called when synchronizing the value of a Room property.
Definition: eventArgs.h:827
Arguments of callback events called when update objects by Diarkis::Modules::IDiarkisRoom::UpdateObje...
Definition: eventArgs.h:1228
Arguments of the callback event called when joined a room.
Definition: eventArgs.h:594
Arguments for callback events when exiting a Room or updating Room properties.
Definition: eventArgs.h:699
Represents a chat message data with its sender user ID and timestamp in milliseconds.
Definition: eventArgs.h:126
Argument of the callback event called when MatchMaker's Search or TeamSearch is executed.
Definition: eventArgs.h:1742
DiarkisConnectStatus
Connection status with a server.
Definition: eventArgs.h:139
Arguments of the callback event called when received Session Info.
Definition: eventArgs.h:2022
@ DCS_Success
Connection succeeded.
const Diarkis::StdString & GetRoomID(void)
Get the matchmaking room id.
Definition: eventArgs.h:97
Arguments of the callback event called when received Session Invite.
Definition: eventArgs.h:1980
MatchMakerResultItem(Diarkis::StdString &id, Diarkis::StdString &roomID, uint16_t maxMembers)
Definition: eventArgs.h:75
std::unordered_map< Key, Value, StdStringHash< Key >, std::equal_to< Key >, Diarkis::DiarkisStdAllocator< std::pair< const Key, Value > >> StdUnorderedMap
Definition: common.h:535
Arguments of the callback event called when MatchMaker response is received.
Definition: eventArgs.h:1598
Arguments of the callback event called when retrieving the number of members in the Room.
Definition: eventArgs.h:971
@ OBJ_SET_MODE
Add or replace object.
uint64_t timeStamp
Definition: eventArgs.h:129
@ OBJ_DEL_MODE
Delete object.
const Diarkis::StdString & GetID(void)
Get the matchmaking id.
Definition: eventArgs.h:87
Arguments of the callback event called when room migration competed.
Definition: eventArgs.h:647
Arguments of the callback event called when received Session Create response.
Definition: eventArgs.h:1892
Structure to contain the results of a FindRoomsByType search.
Definition: eventArgs.h:43
Arguments of the callback events when connecting to the server.
Definition: eventArgs.h:153
Arguments of callback events called when received the result of Diarkis::Modules::IDiarkisRoom::FindR...
Definition: eventArgs.h:1092
Arguments of the callback event called when created a room.
Definition: eventArgs.h:533
Arguments of the callback event called when MatchMaker push is received.
Definition: eventArgs.h:1642
Structure to contain MatchMaker search results.
Definition: eventArgs.h:64
Arguments of the callback event called when a P2P connection fails.
Definition: eventArgs.h:354
Argument of the callback event called when the Room Owner's User ID is retrieved.
Definition: eventArgs.h:859
StdVector< Diarkis::StdString > LocalAddrs
Definition: eventArgs.h:117
Argument of the callback event called when a UDP or TCP Response is received.
Definition: eventArgs.h:1365
const char * GetVersion()
Definition: common.h:75
Arguments of the callback event called when start P2P connection.
Definition: eventArgs.h:1817
@ DCS_Timeout
Connection timeout.
Arguments of the callback event called when MatchMaker Join response is received.
Definition: eventArgs.h:1690
Arguments of the callback event called when sending or receiving fails in P2P.
Definition: eventArgs.h:499
DiarkisTcpConnectionState
Definition: tcp.h:29
Arguments of the callback event called when MatchMaker host has changed.
Definition: eventArgs.h:1794
Arguments of callback events called when received the chat message by Diarkis::Modules::IDiarkisRoom:...
Definition: eventArgs.h:1144
Arguments of the callback event called when a P2P connection is completed.
Definition: eventArgs.h:298
Arguments of the callback event called when the group is created.
Definition: eventArgs.h:199
Arguments of the callback event called when a P2P is disconnected.
Definition: eventArgs.h:402
Arguments of the callback event called when an UDP Echo is received.
Definition: eventArgs.h:1421
Argument of the callback event called when MatchMaker's HostMatchmaking or TeamHostMatchmaking is exe...
Definition: eventArgs.h:1546
Diarkis::StdString _metadata
Room metadata.
Definition: eventArgs.h:50
Argument of the callback event called when the Room property is acquired.
Definition: eventArgs.h:743
uint16_t GetMaxMembers(void)
Maximum number of users that can be matched.
Definition: eventArgs.h:107
Definition: eventArgs.h:270
Arguments of the callback event called when a message is received by P2P.
Definition: eventArgs.h:450
RoomListItem(Diarkis::StdString id, Diarkis::StdString name, Diarkis::StdString metadata)
Definition: eventArgs.h:52
Diarkis::StdString GlobalAddr
Definition: eventArgs.h:116
Arguments of the callback event called when retrieving the list of participating members of the Room.
Definition: eventArgs.h:911
RoomObjectMode
An enumerated type that represents how to update a room object.
Definition: eventArgs.h:27
Arguments of the callback event called when DM received.
Definition: eventArgs.h:1860
Arguments of callback events called when executing Room Regiser, Reserve, etc.
Definition: eventArgs.h:1040
Diarkis::StdString UserID
Definition: eventArgs.h:115
Diarkis::StdString senderUID
Definition: eventArgs.h:128
Definition: eventArgs.h:180
Arguments of the callback event called when the response of Diarkis::Modules::IDiarkisRoom::SendCheck...
Definition: eventArgs.h:1487
Argument of the callback event called when a UDP or TCP Push is received.
Definition: eventArgs.h:1316
Arguments of callback events called when received the result of Diarkis::Modules::IDiarkisRoom::GetCh...
Definition: eventArgs.h:1168