Diarkis::DiarkisSessionInfoEventArgs Struct Reference

Arguments of the callback event called when received Session Info. More...

#include <eventArgs.h>

Public Member Functions
bool	IsSuccess () const
	Get whether the command was successful or not. More...
uint8_t	GetSessionType () const
	Get the session type. More...
const StdString &	GetSessionID () const
	Get the session ID. More...
uint16_t	GetCurrentMembers () const
	Get the number of members joining the session. More...
uint16_t	GetMaxMembers () const
	Get the maximum number of users allowed to join a session. More...
const StdVector< StdString > &	GetMemberIDs () const
	Get the user IDs of members participating in a session. More...
const StdString &	GetOwnerID () const
	Get the session owner's user ID. More...
uint16_t	GetErrorCode () const
	Get error code. More...
const StdString &	GetErrorMessage () const
	Gets the contents of the error. More...
	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

Detailed Description

Arguments of the callback event called when received Session Info.

Constructor & Destructor Documentation

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

Member Function Documentation

IsSuccess()

bool Diarkis::DiarkisSessionInfoEventArgs::IsSuccess

(

)

const

Get whether the command was successful or not.

true=success false=failure

Here is the caller graph for this function:

GetSessionType()

uint8_t Diarkis::DiarkisSessionInfoEventArgs::GetSessionType

(

)

const

Get the session type.

Here is the caller graph for this function:

GetSessionID()

const StdString& Diarkis::DiarkisSessionInfoEventArgs::GetSessionID

(

)

const

Get the session ID.

Here is the caller graph for this function:

GetCurrentMembers()

uint16_t Diarkis::DiarkisSessionInfoEventArgs::GetCurrentMembers

(

)

const

Get the number of members joining the session.

Here is the caller graph for this function:

GetMaxMembers()

uint16_t Diarkis::DiarkisSessionInfoEventArgs::GetMaxMembers

(

)

const

Get the maximum number of users allowed to join a session.

Here is the caller graph for this function:

GetMemberIDs()

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

(

)

const

Get the user IDs of members participating in a session.

Here is the caller graph for this function:

GetOwnerID()

const StdString& Diarkis::DiarkisSessionInfoEventArgs::GetOwnerID

(

)

const

Get the session owner's user ID.

Here is the caller graph for this function:

GetErrorCode()

uint16_t Diarkis::DiarkisSessionInfoEventArgs::GetErrorCode

(

)

const

Get error code.

Return 0 if IsSuccess()=true.

Here is the caller graph for this function:

GetErrorMessage()

const StdString& Diarkis::DiarkisSessionInfoEventArgs::GetErrorMessage

(

)

const

Gets the contents of the error.

Here is the caller graph for this function:

---

The documentation for this struct was generated from the following file:

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