 |
Diarkis C++Client Library API Document
|
Go to the documentation of this file.
10 #include "logging/LoggerFactory.h"
55 virtual void SetupTcpRoom(
const std::shared_ptr<IDiarkisTcp>& tcp,
const std::shared_ptr<LoggerFactory>& loggerFactory,
bool bRetry);
73 virtual void SetupUdpRoom(
const std::shared_ptr<IDiarkisUdp>& udp,
74 const std::shared_ptr<LoggerFactory>& loggerFactory,
75 const std::shared_ptr<DiarkisP2PBase>& p2pBase,
84 std::shared_ptr<IDiarkisRoom> GetRoom();
94 void SetJoinRoomID(
const char* roomID);
102 void SetJoinRoomID(
const std::string& roomID);
132 virtual void SendCreateRoom(uint16_t maxMembers,
bool allowEmpty,
bool join, uint16_t ttl, uint32_t interval);
148 virtual void SendJoinRoom(
const char* uid);
156 virtual void SendJoinRoom(
const std::string& uid);
168 virtual void SendJoinRoom(
const char* roomID,
const char* uid);
176 virtual void SendJoinRoom(
const std::string& roomID,
const std::string& uid);
208 virtual void SendJoinRandomRoom(
const char* uid, uint32_t maxMembers, uint16_t ttl, uint32_t interval,
bool allowEmpty);
216 virtual void SendJoinRandomRoom(
const std::string& uid, uint32_t maxMembers, uint16_t ttl, uint32_t interval,
bool allowEmpty);
232 virtual void SendBroadcastToRoom(
const uint8_t* payload,
size_t payloadSize,
bool reliable);
240 virtual void SendBroadcastToRoom(
const std::vector<uint8_t>& payload,
bool reliable);
260 virtual void SendMessageToRoom(
const char** memberIDs,
size_t memberIDsCount,
const uint8_t* payload,
size_t payloadSize,
bool reliable);
268 virtual void SendMessageToRoom(
const std::vector<std::string>& memberIDs,
const std::vector<uint8_t>& payload,
bool reliable);
286 virtual void SendRelay(
const uint8_t* payload,
size_t payloadSize,
bool reliable);
294 virtual void SendRelay(
const std::vector<uint8_t>& payload,
bool reliable);
316 virtual void SendRelayTo(
const char** memberIDs,
size_t memberIDsCount,
const uint8_t* payload,
size_t payloadSize,
bool reliable);
324 virtual void SendRelayTo(
const std::vector<std::string>& memberIDs,
const std::vector<uint8_t>& payload,
bool reliable);
340 virtual void SendLeaveRoom(
const char* uid);
348 virtual void SendLeaveRoom(
const std::string& uid);
364 virtual void SendFindByTypeRoom(uint32_t roomType, uint32_t limit);
380 virtual void SendRegisterRoom(uint32_t roomType,
const char* roomName,
const char* roomMetadata);
388 virtual void SendRegisterRoom(uint32_t roomType,
const std::string& roomName,
const std::string& roomMetadata);
404 virtual void SendMigrateRoom(
void);
414 virtual void SendGetOwnerID(
void);
424 virtual void SendGetMemberIDs(
void);
434 virtual void SendGetNumberOfMembers(
void);
448 virtual void SendUpdateProperties(
const std::unordered_map<std::string, std::vector<uint8_t>>& properties,
bool sync =
false);
462 virtual void SendGetProperties(
const char** propertyNames,
size_t propertyNamesCount);
470 virtual void SendGetProperties(
const std::vector<std::string>& propertyNames);
488 virtual void SendIncrementProperty(
Diarkis::StdString propertyName, int64_t delta,
bool sync);
502 virtual void SendReserveRoom(
const char** userIDs,
size_t userIDsCount);
510 virtual void SendReserveRoom(
const std::vector<std::string>& userIDs);
526 virtual void SendCancelReservationRoom(
const char* cancelRoomID,
const char** userIDs,
size_t userIDsCount);
534 virtual void SendCancelReservationRoom(
const std::string& cancelRoomID,
const std::vector<std::string>& userIDs);
550 virtual void SendChatMessage(
const char* message);
558 virtual void SendChatMessage(
const std::string& message);
568 virtual void SendGetChatLog(
void);
588 virtual void SendStartP2PSync(uint8_t linkedClients = 0);
616 virtual void SendUpdateObject(
RoomObjectMode mode,
const std::string& name,
const std::unordered_map<std::string, double>& obj,
bool reliable =
true);
706 void SetOwnUID(
const char* uid);
714 void SetOwnUID(
const std::string& uid);
773 virtual void OnRoomMigrateStart(
void);
988 virtual void OnOffline();
996 std::shared_ptr<IDiarkisTcp>
tcp_;
Argument of the callback event called when the value of the Room property is increased or decreased.
Definition: eventArgs.h:767
Arguments of callback events called when received the response of Diarkis::Modules::IDiarkisRoom::Upd...
Definition: eventArgs.h:1270
std::shared_ptr< IDiarkisUdp > udp_
Pointer to IDiarkisUdp class.
Definition: DiarkisRoomBase.h:1004
std::shared_ptr< IDiarkisRoom > room_
Pointer to IDiarkisRoom class.
Definition: DiarkisRoomBase.h:1012
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
Diarkis::StdString roomID_
Room ID of the participating Room.
Definition: DiarkisRoomBase.h:1044
ConnectState roomConnect_
Room state.
Definition: DiarkisRoomBase.h:1052
std::shared_ptr< IDiarkisLogger > logger_
Pointer to IDiarkisLogger class.
Definition: DiarkisRoomBase.h:1028
Arguments of the callback event called when retrieving the number of members in the Room.
Definition: eventArgs.h:971
Definition: directMessage.h:16
Arguments of the callback event called when room migration competed.
Definition: eventArgs.h:647
bool bReserved_
Whether you reserved a Room or not.
Definition: DiarkisRoomBase.h:1100
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
Diarkis::StdString ownUID_
自分のユーザーID
Definition: DiarkisRoomBase.h:1076
ConnectState
connection state
Definition: protocol.h:40
Diarkis::StdVector< std::function< void()> > eventUnsubscriptions_
Lambda functions list.
Definition: DiarkisRoomBase.h:1036
Argument of the callback event called when the Room Owner's User ID is retrieved.
Definition: eventArgs.h:859
int64_t createAtServer_
The time the Room you are currently in was created on the server.
Definition: DiarkisRoomBase.h:1092
Arguments of the callback event called when start P2P connection.
Definition: eventArgs.h:1817
Diarkis::StdString ownerID_
User ID of the Room owner.
Definition: DiarkisRoomBase.h:1084
std::recursive_mutex list_mutex_
roomMemberIDs Mutex
Definition: DiarkisRoomBase.h:1060
Arguments of callback events called when received the chat message by Diarkis::Modules::IDiarkisRoom:...
Definition: eventArgs.h:1144
std::shared_ptr< DiarkisP2PBase > p2pBase_
Pointer to DiarkisP2PBase class.
Definition: DiarkisRoomBase.h:1020
Argument of the callback event called when the Room property is acquired.
Definition: eventArgs.h:743
#define DIARKIS_API
Definition: common.h:47
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
Base class that wraps the IDiarkisRoom class for easy use of Room functionality.
Definition: DiarkisRoomBase.h:22
std::shared_ptr< IDiarkisTcp > tcp_
Pointer to IDiarkisTcp class.
Definition: DiarkisRoomBase.h:996
Arguments of callback events called when executing Room Regiser, Reserve, etc.
Definition: eventArgs.h:1040
Diarkis::StdVector< Diarkis::StdString > roomMemberIDs_
List of Room members' user IDs.
Definition: DiarkisRoomBase.h:1068
Arguments of callback events called when received the result of Diarkis::Modules::IDiarkisRoom::GetCh...
Definition: eventArgs.h:1168