Diarkis C++Client Library API Document
Diarkis 名前空間

名前空間

 Commands
 
 Exceptions
 
 Modules
 
 Network
 
 Results
 
 System
 

クラス

struct  DiarkisAllocatorDeleter
 
struct  DiarkisAllocatorDeleter< T[]>
 
struct  DiarkisCheckNATTypeEventArgs
 Diarkis::Modules::IDiarkisRoom::SendCheckNATType() の応答を受け取ったときに呼び出されるコールバックイベントの引数。 [詳解]
 
struct  DiarkisConnectionEventArgs
 サーバーへの接続時のコールバックイベントの引数 [詳解]
 
class  DiarkisDefaultAllocator
 Diarkisランタイムのデフォルトアロケーター。 [詳解]
 
struct  DiarkisDirectMessageEventArgs
 DMを受信した際にコールバックイベントが呼ばれる際の引数 [詳解]
 
struct  DiarkisExceptionEventArgs
 P2Pで送受信が失敗した際に呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisFailEventArgs
 P2P接続が失敗したときにコールバックイベントが呼び出されるときの引数 [詳解]
 
struct  DiarkisGroupEventArgs
 グループが作成されたときにコールバックイベントが呼び出される際の引数 [詳解]
 
struct  DiarkisMessageEventArgs
 P2Pでメッセージを受信したときに呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisMMHostEventArgs
 
struct  DiarkisMMJoinResponseEventArgs
 MatchMaker Joinのレスポンスを受信したときに呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisMMResponseEventArgs
 MatchMakerの応答が受信されたときに呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisMMResultEventArgs
 MatchMakerのSearchまたはTeamSearchが実行された時に呼び出されるコールバックイベントの引数。 [詳解]
 
struct  DiarkisMMStringEventArgs
 MatchMakerホストが変更されたときにコールバックイベントが呼び出される際の引数。 [詳解]
 
struct  DiarkisMMSyncEventArgs
 MatchMaker push 受信時に呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisMMTicketTypeEventArgs
 TicketCancelプッシュを受信した際にコールバックイベントで呼び出される引数 [詳解]
 
struct  DiarkisP2PDisconnectEventArgs
 P2Pが切断されたときにコールバックイベントが呼び出される際の引数 [詳解]
 
struct  DiarkisP2PEventArgs
 
struct  DiarkisPayloadEventArgs
 ペイロードが送受信されたときに呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisPushEventArgs
 UDPまたはTCP Pushを受信した際に呼び出されるコールバックイベントの引数。 [詳解]
 
struct  DiarkisRawPayloadEventArgs
 
struct  DiarkisReadyEventArgs
 P2P接続が完了した際に呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisResponseEventArgs
 UDPまたはTCPのレスポンスを受信したときにコールバックイベントが呼び出される際の引数。 [詳解]
 
struct  DiarkisRoomChatEventArgs
 Diarkis::Modules::IDiarkisRoom::SendChatMessage によってチャットメッセージを受信したときに呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisRoomChatLogEventArgs
 Diarkis::Modules::IDiarkisRoom::GetChatLog()の結果を受信した際に呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisRoomCreationEventArgs
 ルームが作成されたときに呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisRoomFindByTypeEventArgs
 Diarkis::Modules::IDiarkisRoom::FindRoomsByType()の結果を受け取った際に呼ばれるコールバックイベントの引数 [詳解]
 
struct  DiarkisRoomGetOwnerIDEventArgs
 Room OwnerのユーザーIDが取得されたときに呼び出されるコールバックイベントの引数。 [詳解]
 
struct  DiarkisRoomIncrementPropertyEventArgs
 Roomプロパティの値が増加または減少したときに呼び出されるコールバックイベントの引数。 [詳解]
 
struct  DiarkisRoomIncrementPropertySyncEventArgs
 Roomプロパティの値を同期する際に呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisRoomJoinEventArgs
 ルームに参加したときに呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisRoomMemberIDsEventArgs
 Roomの参加メンバーリストを取得する際に呼び出されるコールバックイベントの引数。 [詳解]
 
struct  DiarkisRoomMigrateCompleteEventArgs
 Roomの移行が完了した際に呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisRoomNumberOfMembersEventArgs
 Roomのメンバー数を取得した際に呼び出されるコールバックイベントの引数。 [詳解]
 
struct  DiarkisRoomObjectUpdateEventArgs
 Diarkis::Modules::IDiarkisRoom::UpdateObject() によってオブジェクトを更新する際に呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisRoomObjectUpdateResponseEventArgs
 Diarkis::Modules::IDiarkisRoom::UpdateObject() の応答を受信した際にコールバックイベントが呼び出される際の引数 [詳解]
 
struct  DiarkisRoomPayloadEventArgs
 Room Regiser、Reserveなどを実行する際にコールバックイベントが呼び出される際の引数。 [詳解]
 
struct  DiarkisRoomPropertiesEventArgs
 Room プロパティが取得されたときに呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisRoomSuccessEventArgs
 Roomを退出したり、Roomのプロパティを更新する際のコールバックイベント用の引数 [詳解]
 
struct  DiarkisSessionCreateResponseEventArgs
 セッション作成応答を受信したときに呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisSessionInfoEventArgs
 セッション情報を受信したときにコールバックイベントが呼び出される際の引数 [詳解]
 
struct  DiarkisSessionInviteEventArgs
 セッション招待を受信したときに呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisSessionNotificationEventArgs
 セッション通知を受信したときに呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisSessionResponseEventArgs
 Sessionの応答を受信した時に呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisStdAllocator
 
struct  DiarkisSuccessEventArgs
 フィールドに参加または退出する際に呼び出されるコールバックイベントの引数。 [詳解]
 
struct  DiarkisTcpConnectionStateChangedEventArgs
 
struct  DiarkisUdpEchoEventArgs
 UDPエコーを受信したときに呼び出されるコールバックイベントの引数 [詳解]
 
struct  DiarkisUdpPingEventArgs
 UDP Pingを受信した際に呼び出されるコールバックイベントの引数 [詳解]
 
class  ICustomAllocator
 カスタムメモリアロケータを実装するための基本クラス。 [詳解]
 
class  IDiarkisComponent
 このインターフェースを実装して、定期的な更新のためにスケジューラーに登録できるようにします。 [詳解]
 
class  IDiarkisEvent
 マルチキャストイベントを表す汎用インターフェース。 イベントが発生すると、登録されたすべてのラムダ式が呼び出されます。 [詳解]
 
class  IDiarkisEventRpcID
 
class  IDiarkisLogger
 ロギング機能を操作するためのインターフェースクラス。 [詳解]
 
class  IDiarkisLoggerFactory
 
class  IFixedAreaMemoryAllocator
 
struct  MatchMakerResultItem
 マッチメイカーの検索結果を含む構造体 [詳解]
 
struct  P2PClientAddr
 
struct  RoomChatData
 チャットメッセージデータを、送信者のユーザーIDおよびタイムスタンプ(ミリ秒単位)とともに表します。 [詳解]
 
struct  RoomListItem
 FindRoomsByType検索の結果を格納するための構造体。 [詳解]
 
class  StdString
 
struct  StdStringHash
 
struct  StdStringHash< StdString >
 
class  StdVector
 

型定義

template<class T >
using StdUniquePtr = std::unique_ptr< T, Diarkis::DiarkisAllocatorDeleter< T > >
 
template<class T >
using StdBasicStringBuf = std::basic_stringbuf< T, std::char_traits< T >, DiarkisStdAllocator< T > >
 
template<class T >
using StdBasicIStringStream = std::basic_istringstream< T, std::char_traits< T >, DiarkisStdAllocator< T > >
 
template<class T >
using StdBasicOStringStream = std::basic_ostringstream< T, std::char_traits< T >, DiarkisStdAllocator< T > >
 
template<class T >
using StdBasicStringStream = std::basic_stringstream< T, std::char_traits< T >, DiarkisStdAllocator< T > >
 
using StdStringBuf = StdBasicStringBuf< char >
 
using StdIStringStream = StdBasicIStringStream< char >
 
using StdOStringStream = StdBasicOStringStream< char >
 
using StdStringStream = StdBasicStringStream< char >
 
template<class T >
using StdDeque = std::deque< T, Diarkis::DiarkisStdAllocator< T > >
 
template<class T >
using StdQueue = std::queue< T, StdDeque< T > >
 
template<class Key , class Value >
using StdMap = std::map< Key, Value, std::less< Key >, Diarkis::DiarkisStdAllocator< std::pair< const Key, Value > >>
 
template<class Key , class Value >
using StdUnorderedMap = std::unordered_map< Key, Value, StdStringHash< Key >, std::equal_to< Key >, Diarkis::DiarkisStdAllocator< std::pair< const Key, Value > >>
 

列挙型

enum  DiarkisLoggerSeverity : std::uint8_t {
  DiarkisLoggerSeverity::Trace = 0, DiarkisLoggerSeverity::Verbose, DiarkisLoggerSeverity::Debug, DiarkisLoggerSeverity::Info,
  DiarkisLoggerSeverity::Warning, DiarkisLoggerSeverity::Error, DiarkisLoggerSeverity::Fatal, DiarkisLoggerSeverity::None
}
 ログの重要度レベル [詳解]
 
enum  RoomObjectMode : std::uint8_t { RoomObjectMode::OBJ_INC_MODE = 1, RoomObjectMode::OBJ_SET_MODE, RoomObjectMode::OBJ_DEL_MODE }
 ルームオブジェクトを更新する方法を表す列挙型。 [詳解]
 
enum  DiarkisConnectStatus : std::int32_t { DiarkisConnectStatus::DCS_Success = 0, DiarkisConnectStatus::DCS_Timeout = -1 }
 サーバーとの接続状態 [詳解]
 

関数

const char * GetVersion ()
 
DIARKIS_EXPORT ICustomAllocatorSetCustomAllocator (ICustomAllocator *pAllocator)
 カスタムのアロケータを指定します。 [詳解]
 
DIARKIS_EXPORT DiarkisDefaultAllocatorGetDefaultAllocator ()
 Diarkisのデフォルトアロケーターポインターを取得します [詳解]
 
DIARKIS_EXPORT IFixedAreaMemoryAllocatorGetFixedAreaMemoryAllocator ()
 FixedAreaMemoryAllocatorのインスタンスのポインタを取得する [詳解]
 
DIARKIS_EXPORT void * DiarkisAlloc (size_t size, int flag=0)
 
DIARKIS_EXPORT void * DiarkisAlignedAlloc (size_t size, size_t align, int flag=0)
 
DIARKIS_EXPORT void DiarkisFree (void *ptr)
 
template<class T , class... _Types>
T * DiarkisNew (_Types &&... _Args)
 
template<class T , typename std::enable_if< std::is_array< T >::value, int >::type = 0>
std::remove_extent< T >::type * DiarkisNew (const size_t N)
 
template<class T >
void DiarkisDelete (T *ptr)
 
template<class T , class U >
bool operator== (const DiarkisStdAllocator< T > &, const DiarkisStdAllocator< U > &)
 
template<class T , class U >
bool operator!= (const DiarkisStdAllocator< T > &, const DiarkisStdAllocator< U > &)
 
template<class T , class... _Types, typename std::enable_if<!std::is_array< T >::value, int >::type = 0>
StdUniquePtr< T > DiarkisAllocUnique (_Types &&... _Args)
 
template<class T , typename std::enable_if< std::is_array< T >::value, int >::type = 0>
StdUniquePtr< T > DiarkisAllocUnique (const size_t N)
 
template<class T , class... _Types>
std::shared_ptr< T > DiarkisAllocShared (_Types &&... _Args)
 
StdString operator+ (const StdString &lhs, const StdString &rhs)
 
StdString operator+ (const StdString &lhs, const char *rhs)
 
StdString operator+ (const char *lhs, const StdString &rhs)
 
StdString operator+ (const StdString &lhs, const char rhs)
 
StdString operator+ (const char lhs, const StdString &rhs)
 
StdString to_string (int value)
 
StdString to_string (long value)
 
StdString to_string (long long value)
 
StdString to_string (unsigned value)
 
StdString to_string (unsigned long value)
 
StdString to_string (unsigned long long value)
 
StdString to_string (float value)
 
StdString to_string (double value)
 
StdString to_string (long double value)
 
bool DIARKIS_EXPORT ParseErrStruct (uint8_t status, const Diarkis::StdVector< uint8_t > &payload, uint16_t &errCode, Diarkis::StdString &errString)
 レスポンスハンドラーで受信したエラー構造体データのペイロードを解析します。 [詳解]
 

型定義詳解

◆ StdUniquePtr

template<class T >
using Diarkis::StdUniquePtr = typedef std::unique_ptr<T, Diarkis::DiarkisAllocatorDeleter<T> >

◆ StdBasicStringBuf

template<class T >
using Diarkis::StdBasicStringBuf = typedef std::basic_stringbuf<T, std::char_traits<T>, DiarkisStdAllocator<T> >

◆ StdBasicIStringStream

template<class T >
using Diarkis::StdBasicIStringStream = typedef std::basic_istringstream<T, std::char_traits<T>, DiarkisStdAllocator<T> >

◆ StdBasicOStringStream

template<class T >
using Diarkis::StdBasicOStringStream = typedef std::basic_ostringstream<T, std::char_traits<T>, DiarkisStdAllocator<T> >

◆ StdBasicStringStream

template<class T >
using Diarkis::StdBasicStringStream = typedef std::basic_stringstream<T, std::char_traits<T>, DiarkisStdAllocator<T> >

◆ StdStringBuf

◆ StdIStringStream

◆ StdOStringStream

◆ StdStringStream

◆ StdDeque

template<class T >
using Diarkis::StdDeque = typedef std::deque<T, Diarkis::DiarkisStdAllocator<T> >

◆ StdQueue

template<class T >
using Diarkis::StdQueue = typedef std::queue<T, StdDeque<T> >

◆ StdMap

template<class Key , class Value >
using Diarkis::StdMap = typedef std::map<Key, Value, std::less<Key>, Diarkis::DiarkisStdAllocator<std::pair<const Key, Value> >>

◆ StdUnorderedMap

template<class Key , class Value >
using Diarkis::StdUnorderedMap = typedef std::unordered_map<Key, Value, StdStringHash<Key>, std::equal_to<Key>, Diarkis::DiarkisStdAllocator<std::pair<const Key, Value> >>

列挙型詳解

◆ DiarkisLoggerSeverity

enum Diarkis::DiarkisLoggerSeverity : std::uint8_t
strong

ログの重要度レベル

列挙値
Trace 

Displays all levels. The send and receive payload will be dumped.
Note that the log file will be large in size.

Verbose 

Displays verbose, debug, info, warning, error, and fatal level

Debug 

Displays debug, info, warning, error, and fatal level

Info 

Displays info, warning, error, and fatal level

Warning 

Displays warning, error, and fatal level

Error 

Displays fatal and error level

Fatal 

Displays only fatal level

None 

No log

◆ RoomObjectMode

enum Diarkis::RoomObjectMode : std::uint8_t
strong

ルームオブジェクトを更新する方法を表す列挙型。

列挙値
OBJ_INC_MODE 

Increments the value of object.

OBJ_SET_MODE 

Add or replace object.

OBJ_DEL_MODE 

Delete object.

◆ DiarkisConnectStatus

enum Diarkis::DiarkisConnectStatus : std::int32_t
strong

サーバーとの接続状態

列挙値
DCS_Success 

Connection succeeded

DCS_Timeout 

Connection timeout

関数詳解

◆ GetVersion()

const char* Diarkis::GetVersion ( )
inline
被呼び出し関係図:

◆ SetCustomAllocator()

DIARKIS_EXPORT ICustomAllocator* Diarkis::SetCustomAllocator ( ICustomAllocator pAllocator)

カスタムのアロケータを指定します。

◆ GetDefaultAllocator()

DIARKIS_EXPORT DiarkisDefaultAllocator* Diarkis::GetDefaultAllocator ( )

Diarkisのデフォルトアロケーターポインターを取得します

戻り値
Diarkisのデフォルトアロケーターへのポインター

◆ GetFixedAreaMemoryAllocator()

DIARKIS_EXPORT IFixedAreaMemoryAllocator* Diarkis::GetFixedAreaMemoryAllocator ( )

FixedAreaMemoryAllocatorのインスタンスのポインタを取得する

戻り値
FixedAreaMemoryAllocatorへのポインタ

◆ DiarkisAlloc()

DIARKIS_EXPORT void* Diarkis::DiarkisAlloc ( size_t  size,
int  flag = 0 
)
被呼び出し関係図:

◆ DiarkisAlignedAlloc()

DIARKIS_EXPORT void* Diarkis::DiarkisAlignedAlloc ( size_t  size,
size_t  align,
int  flag = 0 
)

◆ DiarkisFree()

DIARKIS_EXPORT void Diarkis::DiarkisFree ( void *  ptr)
被呼び出し関係図:

◆ DiarkisNew() [1/2]

template<class T , class... _Types>
T* Diarkis::DiarkisNew ( _Types &&...  _Args)
inline
呼び出し関係図:

◆ DiarkisNew() [2/2]

template<class T , typename std::enable_if< std::is_array< T >::value, int >::type = 0>
std::remove_extent<T>::type* Diarkis::DiarkisNew ( const size_t  N)
inline
呼び出し関係図:

◆ DiarkisDelete()

template<class T >
void Diarkis::DiarkisDelete ( T *  ptr)
inline
呼び出し関係図:
被呼び出し関係図:

◆ operator==()

template<class T , class U >
bool Diarkis::operator== ( const DiarkisStdAllocator< T > &  ,
const DiarkisStdAllocator< U > &   
)

◆ operator!=()

template<class T , class U >
bool Diarkis::operator!= ( const DiarkisStdAllocator< T > &  ,
const DiarkisStdAllocator< U > &   
)

◆ DiarkisAllocUnique() [1/2]

template<class T , class... _Types, typename std::enable_if<!std::is_array< T >::value, int >::type = 0>
StdUniquePtr<T> Diarkis::DiarkisAllocUnique ( _Types &&...  _Args)
inline

◆ DiarkisAllocUnique() [2/2]

template<class T , typename std::enable_if< std::is_array< T >::value, int >::type = 0>
StdUniquePtr<T> Diarkis::DiarkisAllocUnique ( const size_t  N)
inline

◆ DiarkisAllocShared()

template<class T , class... _Types>
std::shared_ptr<T> Diarkis::DiarkisAllocShared ( _Types &&...  _Args)
inline

◆ operator+() [1/5]

StdString Diarkis::operator+ ( const StdString lhs,
const StdString rhs 
)
inline
被呼び出し関係図:

◆ operator+() [2/5]

StdString Diarkis::operator+ ( const StdString lhs,
const char *  rhs 
)
inline
呼び出し関係図:

◆ operator+() [3/5]

StdString Diarkis::operator+ ( const char *  lhs,
const StdString rhs 
)
inline
呼び出し関係図:

◆ operator+() [4/5]

StdString Diarkis::operator+ ( const StdString lhs,
const char  rhs 
)
inline
呼び出し関係図:

◆ operator+() [5/5]

StdString Diarkis::operator+ ( const char  lhs,
const StdString rhs 
)
inline
呼び出し関係図:

◆ to_string() [1/9]

StdString Diarkis::to_string ( int  value)
inline

◆ to_string() [2/9]

StdString Diarkis::to_string ( long  value)
inline

◆ to_string() [3/9]

StdString Diarkis::to_string ( long long  value)
inline

◆ to_string() [4/9]

StdString Diarkis::to_string ( unsigned  value)
inline

◆ to_string() [5/9]

StdString Diarkis::to_string ( unsigned long  value)
inline

◆ to_string() [6/9]

StdString Diarkis::to_string ( unsigned long long  value)
inline

◆ to_string() [7/9]

StdString Diarkis::to_string ( float  value)
inline

◆ to_string() [8/9]

StdString Diarkis::to_string ( double  value)
inline

◆ to_string() [9/9]

StdString Diarkis::to_string ( long double  value)
inline

◆ ParseErrStruct()

bool DIARKIS_EXPORT Diarkis::ParseErrStruct ( uint8_t  status,
const Diarkis::StdVector< uint8_t > &  payload,
uint16_t &  errCode,
Diarkis::StdString errString 
)

レスポンスハンドラーで受信したエラー構造体データのペイロードを解析します。