Diarkis C++Client Library API Document
commands.h
Go to the documentation of this file.
1 // © 2019-2024 Diarkis Inc. All rights reserved.
2 
3 #pragma once
4 
5 #include <stdint.h>
6 #include "diarkis/diarkis_export.h"
7 
8  // ADD NAMESPACE NAME TAG
9 namespace Diarkis { namespace Commands
10 {
11  // Field
13  constexpr uint16_t FieldJoin = 120;
15  constexpr uint16_t FieldSync = 121;
17  constexpr uint16_t FieldDisappear = 123;
19  constexpr uint16_t FieldLeave = 124;
20 
21  // Room
23  constexpr uint16_t RoomIncrementProperty = 10;
25  constexpr uint16_t RoomGetMembers = 11;
27  constexpr uint16_t RoomMigrate = 12;
29  constexpr uint16_t RoomGetNumOfMembers = 13;
31  constexpr uint16_t RoomOwnerChange = 14;
33  constexpr uint16_t RoomCreate = 100;
35  constexpr uint16_t RoomJoin = 101;
37  constexpr uint16_t RoomLeave = 102;
39  constexpr uint16_t RoomBroadcast = 103;
41  constexpr uint16_t RoomMessage = 104;
43  constexpr uint16_t RoomJoinRandom = 106;
45  constexpr uint16_t RoomUpdateProperties = 107;
47  constexpr uint16_t RoomGetProperties = 108;
49  constexpr uint16_t RoomGetOwner = 109;
51  constexpr uint16_t RoomRegister = 115;
53  constexpr uint16_t RoomFindByType = 116;
55  constexpr uint16_t RoomReserve = 117;
57  constexpr uint16_t RoomCancelReserve = 118;
59  constexpr uint16_t RoomChat = 125;
61  constexpr uint16_t RoomChatLog = 126;
63  constexpr uint16_t RoomP2PInit = 127;
65  constexpr uint16_t RoomNotifyP2PConnectCompleted = 301;
67  constexpr uint16_t RoomObjectUpdate = 129;
69  constexpr uint16_t RoomRelay = 18;
71  constexpr uint16_t RoomRelayProfile = 19;
73  constexpr uint16_t RoomMigrateComplete = 20;
75  constexpr uint16_t RoomRelayTo = 23;
77  constexpr uint16_t RoomRelayToProfile = 24;
78 
79  // Group
81  constexpr uint16_t GroupCreate = 110;
83  constexpr uint16_t GroupJoin = 111;
85  constexpr uint16_t GroupLeave = 112;
87  constexpr uint16_t GroupBroadcast = 113;
88  // 参加できる Group があればその Group に参加、無ければ新規の Group を作成する。
89  constexpr uint16_t GroupJoinRandom = 114;
90 
91  // MatchMaker
93  constexpr uint16_t MatchMakerHost = 200;
95  constexpr uint16_t MatchMakerSearch = 201;
97  constexpr uint16_t MatchMakerRemove = 202;
99  constexpr uint16_t MatchMakerLeave = 203;
101  constexpr uint16_t MatchMakerSync = 204;
103  constexpr uint16_t MatchMakerClaim = 205;
105  constexpr uint16_t MatchMakerComplete = 206;
107  constexpr uint16_t MatchMakerResults = 207;
109  constexpr uint16_t MatchMakerP2P = 208;
111  constexpr uint16_t MatchMakerBackfill = 211;
113  constexpr uint16_t MatchMakerKick = 217;
115  constexpr uint16_t MatchMakerTicket = 218;
117  constexpr uint16_t MatchMakerTicketErr = 219;
119  constexpr uint16_t MatchMakerTicketComp = 220;
121  constexpr uint16_t MatchMakerHostChange = 221;
123  constexpr uint16_t MatchMakerTicketCancel = 222;
125  constexpr uint16_t MatchMakerTicketMatch = 223;
127  constexpr uint16_t MatchMakerTicketBroadcast = 224;
129  constexpr uint16_t MatchMakerTicketLeave = 225;
130 
131  // TeamMatchMaker
133  constexpr uint16_t TeamMatchMakerNew = 209;
135  constexpr uint16_t TeamMatchMakerSearch = 214;
138  constexpr uint16_t TeamMatchMakerCommit = 215;
140  constexpr uint16_t TeamMatchMakerCompCommit = 216;
141 
143  constexpr uint16_t UdpRequestHolePunch = 303;
145  constexpr uint16_t UdpNotifyHolePunchDone = 304;
147  constexpr uint16_t UdpCheckNATType = 305;
148 
149  // DirectMessage
156  constexpr uint16_t DirectMessageDisconnect = 700;
163  constexpr uint16_t DirectMessageSend = 701;
164 
166  constexpr uint16_t DirectMessageConnect = 702;
167 
168  // Session
170  constexpr uint16_t SessionBroadcast = 800;
172  constexpr uint16_t SessionCreate = 801;
174  constexpr uint16_t SessionInvite = 802;
176  constexpr uint16_t SessionAcceptInvite = 803;
178  constexpr uint16_t SessionJoin = 804;
180  constexpr uint16_t SessionLeave = 805;
182  constexpr uint16_t SessionKick = 806;
184  constexpr uint16_t SessionMessageTo = 807;
186  constexpr uint16_t SessionInfoBySessionType = 808;
189  constexpr uint16_t SessionInfoBySessionID= 809;
190 
191  // TCP
193  constexpr uint16_t TcpHeartbeat = 1;
194 
195  // UDP
197  constexpr uint16_t UdpEcho = 1;
199  constexpr uint16_t UdpPing = 3;
200 
202  constexpr uint16_t Notification = 400;
203 
204  // Network
206  constexpr uint16_t Reconnect = 2;
208  constexpr uint16_t ClientKey = 4;
209 
210 extern "C"
211 {
212  DIARKIS_EXPORT const char* DiarkisTranslateCommand(uint16_t command);
213 }
214 
215 } }
216 // ADD NAMESPACE } TAG
Diarkis::Commands::RoomGetMembers
constexpr uint16_t RoomGetMembers
Room 参加メンバーのリストを取得する。
Definition: commands.h:25
Diarkis::Commands::DirectMessageDisconnect
constexpr uint16_t DirectMessageDisconnect
DirectMessage message notification disconnect.
Definition: commands.h:156
Diarkis::Commands::RoomIncrementProperty
constexpr uint16_t RoomIncrementProperty
Room 任意のプロパティの増減値を送信する。
Definition: commands.h:23
Diarkis::Commands::UdpCheckNATType
constexpr uint16_t UdpCheckNATType
NAT タイプを確認するコマンド
Definition: commands.h:147
Diarkis::Commands::SessionInfoBySessionType
constexpr uint16_t SessionInfoBySessionType
Session type を指定し現在参加中の Session の情報を取得する。
Definition: commands.h:186
Diarkis::Commands::RoomNotifyP2PConnectCompleted
constexpr uint16_t RoomNotifyP2PConnectCompleted
サーバーへ P2P 接続が完了したことを通知する
Definition: commands.h:65
Diarkis::Commands::TeamMatchMakerNew
constexpr uint16_t TeamMatchMakerNew
TeamMatchMaker の ホストとして、チームのマッチングを待ち受け開始する。(ホスト用)
Definition: commands.h:133
Diarkis::Commands::TeamMatchMakerSearch
constexpr uint16_t TeamMatchMakerSearch
TeamMatchMaker の ゲストとして、チームのマッチング検索を行う。(ゲスト用)
Definition: commands.h:135
Diarkis::Commands::MatchMakerHost
constexpr uint16_t MatchMakerHost
MatchMaker の ホストとして、マッチングの待ち受け開始。(ホスト用)
Definition: commands.h:93
Diarkis::Commands::FieldSync
constexpr uint16_t FieldSync
Field を移動した際に他のメンバーに通知する。
Definition: commands.h:15
Diarkis::Commands::MatchMakerSearch
constexpr uint16_t MatchMakerSearch
MatchMaker の ゲストとして、マッチングの探索を行う。(ゲスト用)
Definition: commands.h:95
Diarkis::Commands::MatchMakerTicketMatch
constexpr uint16_t MatchMakerTicketMatch
MatchMaker の Ticket で Room に入室した際に通知される。
Definition: commands.h:125
Diarkis::Commands::FieldJoin
constexpr uint16_t FieldJoin
Field に参加する。自分の位置をサーバに通知して自分の近くのメンバーに通知する。
Definition: commands.h:13
Diarkis::Commands::SessionAcceptInvite
constexpr uint16_t SessionAcceptInvite
最後のSession招待を受け入れる
Definition: commands.h:176
Diarkis::Commands::RoomMessage
constexpr uint16_t RoomMessage
Room 参加者する特定の複数メンバーにメッセージを送信する。
Definition: commands.h:41
Diarkis::Commands::MatchMakerTicket
constexpr uint16_t MatchMakerTicket
MatchMaker の Ticket リクエスト。
Definition: commands.h:115
Diarkis::Commands::MatchMakerResults
constexpr uint16_t MatchMakerResults
MatchMaker の MatchMaking のメンバー数がフルになった時通知する。
Definition: commands.h:107
Diarkis::Commands::SessionInfoBySessionID
constexpr uint16_t SessionInfoBySessionID
Definition: commands.h:189
Diarkis::Commands::MatchMakerTicketCancel
constexpr uint16_t MatchMakerTicketCancel
MatchMaker の Ticket リクエストをキャンセル。
Definition: commands.h:123
Diarkis::Commands::ClientKey
constexpr uint16_t ClientKey
クラアントキーを設定する
Definition: commands.h:208
Diarkis::Commands::DirectMessageSend
constexpr uint16_t DirectMessageSend
DirectMessage メッセージ送信
Definition: commands.h:163
Diarkis::Commands::MatchMakerKick
constexpr uint16_t MatchMakerKick
MatchMaker の 特定のメンバーを退出させる。(ホスト用)
Definition: commands.h:113
Diarkis::Commands::MatchMakerP2P
constexpr uint16_t MatchMakerP2P
MatchMaker の P2P接続の初期化
Definition: commands.h:109
Diarkis::Commands::TeamMatchMakerCompCommit
constexpr uint16_t TeamMatchMakerCompCommit
TeamMatchMaker ゲストが TeamMatchMaking に移行する。Commitの内部処理で呼び出される。
Definition: commands.h:140
Diarkis::Commands::MatchMakerTicketErr
constexpr uint16_t MatchMakerTicketErr
MatchMaker の Ticket リクエストの失敗。
Definition: commands.h:117
Diarkis::Commands::MatchMakerBackfill
constexpr uint16_t MatchMakerBackfill
MatchMaker の 追加でメンバーを待ち受けを行う。(ホスト用)
Definition: commands.h:111
Diarkis::Commands::Reconnect
constexpr uint16_t Reconnect
サーバの再接続を試みる。
Definition: commands.h:206
Diarkis::Commands::GroupLeave
constexpr uint16_t GroupLeave
Group から退室する。
Definition: commands.h:85
Diarkis::Commands::DirectMessageConnect
constexpr uint16_t DirectMessageConnect
This command is deprecated because the connect event of the DirectMessage is no longer used.
Definition: commands.h:166
Diarkis::Commands::RoomFindByType
constexpr uint16_t RoomFindByType
同じタイプの Room を検索する。
Definition: commands.h:53
Diarkis::Commands::MatchMakerTicketComp
constexpr uint16_t MatchMakerTicketComp
MatchMaker の Ticket リクエストの成功。
Definition: commands.h:119
Diarkis::Commands::Notification
constexpr uint16_t Notification
通知
Definition: commands.h:202
Diarkis::Commands::RoomCancelReserve
constexpr uint16_t RoomCancelReserve
Room の予約をキャンセルする。
Definition: commands.h:57
Diarkis::Commands::MatchMakerLeave
constexpr uint16_t MatchMakerLeave
MatchMaker の 待機状態から退出する。 (ゲスト用)
Definition: commands.h:99
Diarkis::Commands::MatchMakerTicketBroadcast
constexpr uint16_t MatchMakerTicketBroadcast
MatchMaker の Ticket で マッチングした相手に全員にメッセージを送信する。
Definition: commands.h:127
Diarkis::Commands::SessionJoin
constexpr uint16_t SessionJoin
Session に参加する。
Definition: commands.h:178
Diarkis::Commands::RoomLeave
constexpr uint16_t RoomLeave
Room から退室する。
Definition: commands.h:37
Diarkis::Commands::TeamMatchMakerCommit
constexpr uint16_t TeamMatchMakerCommit
Definition: commands.h:138
Diarkis::Commands::RoomGetProperties
constexpr uint16_t RoomGetProperties
Room プロパティを取得する。
Definition: commands.h:47
Diarkis::Commands::GroupCreate
constexpr uint16_t GroupCreate
新規に Group を作成する。
Definition: commands.h:81
Diarkis::Commands::SessionLeave
constexpr uint16_t SessionLeave
Session から退室する。
Definition: commands.h:180
Diarkis::Commands::SessionBroadcast
constexpr uint16_t SessionBroadcast
Session の 相手に全員にメッセージを送信する。
Definition: commands.h:170
Diarkis::Commands::RoomRelayToProfile
constexpr uint16_t RoomRelayToProfile
Room 指定したメンバーとリレーでプロファイル同期する
Definition: commands.h:77
Diarkis::Commands::RoomJoin
constexpr uint16_t RoomJoin
Room に参加する。
Definition: commands.h:35
Diarkis::Commands::UdpPing
constexpr uint16_t UdpPing
UDP サーバに、Ping送信。
Definition: commands.h:199
Diarkis::Commands::MatchMakerSync
constexpr uint16_t MatchMakerSync
MatchMaker の マッチングした他のメンバーにメッセージ送信する。(待機時)
Definition: commands.h:101
Diarkis
Definition: commands.h:9
Diarkis::Commands::MatchMakerRemove
constexpr uint16_t MatchMakerRemove
MatchMaker の マッチングの検索対象から離脱(Abort) / 解散する。(ホスト用)
Definition: commands.h:97
Diarkis::Commands::GroupBroadcast
constexpr uint16_t GroupBroadcast
Group 参加者全員に一斉にメッセージを送信する。
Definition: commands.h:87
Diarkis::Commands::SessionInvite
constexpr uint16_t SessionInvite
Sessionへの招待
Definition: commands.h:174
Diarkis::Commands::DiarkisTranslateCommand
const DIARKIS_EXPORT char * DiarkisTranslateCommand(uint16_t command)
Diarkis::Commands::RoomReserve
constexpr uint16_t RoomReserve
参加中の Room 他メンバー分の予約をする。
Definition: commands.h:55
Diarkis::Commands::RoomChat
constexpr uint16_t RoomChat
Room チャットッセージを送信する。
Definition: commands.h:59
Diarkis::Commands::MatchMakerHostChange
constexpr uint16_t MatchMakerHostChange
MatchMaker の ホストが変更に通知される。
Definition: commands.h:121
Diarkis::Commands::UdpEcho
constexpr uint16_t UdpEcho
UDP サーバに、クライアントから定期的に生存確認を送信する。
Definition: commands.h:197
Diarkis::Commands::FieldDisappear
constexpr uint16_t FieldDisappear
Field から 抜ける際に呼び出す。
Definition: commands.h:17
Diarkis::Commands::GroupJoinRandom
constexpr uint16_t GroupJoinRandom
Definition: commands.h:89
Diarkis::Commands::SessionKick
constexpr uint16_t SessionKick
Sessionのメンバーをキックする
Definition: commands.h:182
Diarkis::Commands::RoomRelayProfile
constexpr uint16_t RoomRelayProfile
Room リレーでプロファイル同期する
Definition: commands.h:71
Diarkis::Commands::RoomJoinRandom
constexpr uint16_t RoomJoinRandom
参加できる Room があればその Room に参加、無ければ新規の Room を作成する。
Definition: commands.h:43
Diarkis::Commands::SessionMessageTo
constexpr uint16_t SessionMessageTo
Session の特定のメンバーにメッセージを送信する。
Definition: commands.h:184
Diarkis::Commands::RoomChatLog
constexpr uint16_t RoomChatLog
Room チャットメッセージのログを取得する。
Definition: commands.h:61
Diarkis::Commands::RoomRegister
constexpr uint16_t RoomRegister
Roomに付加する情報の登録、FindRoomsByTypeと一緒に使用する。
Definition: commands.h:51
Diarkis::Commands::MatchMakerClaim
constexpr uint16_t MatchMakerClaim
MatchMaker の MatchMaking の予約する。
Definition: commands.h:103
Diarkis::Commands::MatchMakerTicketLeave
constexpr uint16_t MatchMakerTicketLeave
Ticket リクエストが成功 (Complete) したことによって作成された Room から退出する。
Definition: commands.h:129
Diarkis::Commands::RoomUpdateProperties
constexpr uint16_t RoomUpdateProperties
Room プロパティを更新する。
Definition: commands.h:45
Diarkis::Commands::RoomOwnerChange
constexpr uint16_t RoomOwnerChange
Room オーナーが変更した時に通知される。
Definition: commands.h:31
Diarkis::Commands::SessionCreate
constexpr uint16_t SessionCreate
新規に Session を作成する。
Definition: commands.h:172
Diarkis::Commands::TcpHeartbeat
constexpr uint16_t TcpHeartbeat
TCP サーバに、クライアントから定期的に生存確認を送信する。
Definition: commands.h:193
Diarkis::Commands::RoomObjectUpdate
constexpr uint16_t RoomObjectUpdate
Room オブジェクトをアップデートする。
Definition: commands.h:67
Diarkis::Commands::RoomP2PInit
constexpr uint16_t RoomP2PInit
Room 参加メンバーに P2P 開始の通知と接続先にアドレスリストを取得する。
Definition: commands.h:63
Diarkis::Commands::RoomMigrate
constexpr uint16_t RoomMigrate
Room の移動を通知する。
Definition: commands.h:27
Diarkis::Commands::RoomGetOwner
constexpr uint16_t RoomGetOwner
Room オーナーのIDを取得する。
Definition: commands.h:49
Diarkis::Commands::RoomRelayTo
constexpr uint16_t RoomRelayTo
Room 指定したメンバーとリレーで同期する
Definition: commands.h:75
Diarkis::Commands::RoomMigrateComplete
constexpr uint16_t RoomMigrateComplete
Room Migrate が完了した場合にサーバから送信される push 通知
Definition: commands.h:73
Diarkis::Commands::GroupJoin
constexpr uint16_t GroupJoin
Group に参加する。
Definition: commands.h:83
Diarkis::Commands::FieldLeave
constexpr uint16_t FieldLeave
Field から 抜ける際に呼び出す。
Definition: commands.h:19
Diarkis::Commands::UdpNotifyHolePunchDone
constexpr uint16_t UdpNotifyHolePunchDone
UdpRequestHolePunch によって指定されたエンドポイントに PingTry パケットを送信したことを通知するコマンド
Definition: commands.h:145
Diarkis::Commands::RoomBroadcast
constexpr uint16_t RoomBroadcast
Room 参加者全員に一斉にメッセージを送信する。
Definition: commands.h:39
Diarkis::Commands::RoomGetNumOfMembers
constexpr uint16_t RoomGetNumOfMembers
Room に参加している人数を取得する。
Definition: commands.h:29
Diarkis::Commands::RoomCreate
constexpr uint16_t RoomCreate
新規に Room を作成する。
Definition: commands.h:33
Diarkis::Commands::RoomRelay
constexpr uint16_t RoomRelay
Room リレーで同期する
Definition: commands.h:69
Diarkis::Commands::UdpRequestHolePunch
constexpr uint16_t UdpRequestHolePunch
指定されたエンドポイントに PingTry パケットを送信するように通知するコマンド
Definition: commands.h:143
Diarkis::Commands::MatchMakerComplete
constexpr uint16_t MatchMakerComplete
MatchMaker の MatchMaking のメンバー数がフルになった時通知する。(ホスト用)
Definition: commands.h:105