Diarkis::DiarkisSessionInfoEventArgs 構造体

セッション情報を受信したときにコールバックイベントが呼び出される際の引数 [詳解]

#include <eventArgs.h>

公開メンバ関数
bool	IsSuccess () const
	コマンドの成功または失敗を取得します。 [詳解]
uint8_t	GetSessionType () const
	セッションのタイプを取得する [詳解]
const StdString &	GetSessionID () const
	セッションIDを取得する [詳解]
uint16_t	GetCurrentMembers () const
	セッションに参加しているメンバーの数を取得する [詳解]
uint16_t	GetMaxMembers () const
	セッションに参加を許可されている最大ユーザー数を取得します [詳解]
const StdVector< StdString > &	GetMemberIDs () const
	セッションに参加しているメンバーのユーザーIDを取得する [詳解]
const StdString &	GetOwnerID () const
	セッションオーナーのユーザーIDを取得する [詳解]
uint16_t	GetErrorCode () const
	エラーコードを取得します。 [詳解]
const StdString &	GetErrorMessage () const
	エラーの内容を取得します。 [詳解]
	DiarkisSessionInfoEventArgs (bool isSuccess, uint8_t sessionType, const StdString &sessionID, uint16_t currentMembers, uint16_t maxMembers, const StdVector< StdString > &memberIDs, const StdString &ownerID, uint16_t errorCode, const StdString &errorString)
	DiarkisSessionInfoEventArgs (DiarkisSessionInfoEventArgs &)=delete
	DiarkisSessionInfoEventArgs (DiarkisSessionInfoEventArgs &&)=delete

詳解

セッション情報を受信したときにコールバックイベントが呼び出される際の引数

構築子と解体子

DiarkisSessionInfoEventArgs() [1/3]

Diarkis::DiarkisSessionInfoEventArgs::DiarkisSessionInfoEventArgs	(	bool	isSuccess,
		uint8_t	sessionType,
		const StdString &	sessionID,
		uint16_t	currentMembers,
		uint16_t	maxMembers,
		const StdVector< StdString > &	memberIDs,
		const StdString &	ownerID,
		uint16_t	errorCode,
		const StdString &	errorString
	)

DiarkisSessionInfoEventArgs() [2/3]

Diarkis::DiarkisSessionInfoEventArgs::DiarkisSessionInfoEventArgs ( DiarkisSessionInfoEventArgs &  )

delete

DiarkisSessionInfoEventArgs() [3/3]

Diarkis::DiarkisSessionInfoEventArgs::DiarkisSessionInfoEventArgs ( DiarkisSessionInfoEventArgs &&  )

delete

関数詳解

IsSuccess()

bool Diarkis::DiarkisSessionInfoEventArgs::IsSuccess

(

)

const

コマンドの成功または失敗を取得します。

true=成功 false=失敗

被呼び出し関係図:

GetSessionType()

uint8_t Diarkis::DiarkisSessionInfoEventArgs::GetSessionType

(

)

const

セッションのタイプを取得する

被呼び出し関係図:

GetSessionID()

const StdString& Diarkis::DiarkisSessionInfoEventArgs::GetSessionID

(

)

const

セッションIDを取得する

被呼び出し関係図:

GetCurrentMembers()

uint16_t Diarkis::DiarkisSessionInfoEventArgs::GetCurrentMembers

(

)

const

セッションに参加しているメンバーの数を取得する

被呼び出し関係図:

GetMaxMembers()

uint16_t Diarkis::DiarkisSessionInfoEventArgs::GetMaxMembers

(

)

const

セッションに参加を許可されている最大ユーザー数を取得します

被呼び出し関係図:

GetMemberIDs()

const StdVector<StdString>& Diarkis::DiarkisSessionInfoEventArgs::GetMemberIDs

(

)

const

セッションに参加しているメンバーのユーザーIDを取得する

被呼び出し関係図:

GetOwnerID()

const StdString& Diarkis::DiarkisSessionInfoEventArgs::GetOwnerID

(

)

const

セッションオーナーのユーザーIDを取得する

被呼び出し関係図:

GetErrorCode()

uint16_t Diarkis::DiarkisSessionInfoEventArgs::GetErrorCode

(

)

const

エラーコードを取得します。

IsSuccess()=trueの場合、0を返します。

被呼び出し関係図:

GetErrorMessage()

const StdString& Diarkis::DiarkisSessionInfoEventArgs::GetErrorMessage

(

)

const

エラーの内容を取得します。

被呼び出し関係図:

---

この構造体詳解は次のファイルから抽出されました:

• client/cpp/libDiarkis/include/diarkis/network/eventArgs.h