Diarkis C++Client Library API Document
Diarkis::DiarkisSessionCreateResponseEventArgs Struct Reference

Arguments of the callback event called when received Session Create response. 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 Diarkis::StdStringGetSessionID () const
 Get the session ID. More...
 
uint16_t GetErrorCode () const
 Get error code. More...
 
const StdStringGetErrorMessage () const
 Gets the contents of the error. More...
 
 DiarkisSessionCreateResponseEventArgs (bool isSuccess, uint8_t sessionType, const Diarkis::StdString &sessionID, uint16_t errCode, const Diarkis::StdString &errString)
 
 DiarkisSessionCreateResponseEventArgs (DiarkisSessionCreateResponseEventArgs &)=delete
 
 DiarkisSessionCreateResponseEventArgs (DiarkisSessionCreateResponseEventArgs &&)=delete
 

Detailed Description

Arguments of the callback event called when received Session Create response.

Constructor & Destructor Documentation

◆ DiarkisSessionCreateResponseEventArgs() [1/3]

Diarkis::DiarkisSessionCreateResponseEventArgs::DiarkisSessionCreateResponseEventArgs ( bool  isSuccess,
uint8_t  sessionType,
const Diarkis::StdString sessionID,
uint16_t  errCode,
const Diarkis::StdString errString 
)

◆ DiarkisSessionCreateResponseEventArgs() [2/3]

Diarkis::DiarkisSessionCreateResponseEventArgs::DiarkisSessionCreateResponseEventArgs ( DiarkisSessionCreateResponseEventArgs )
delete

◆ DiarkisSessionCreateResponseEventArgs() [3/3]

Diarkis::DiarkisSessionCreateResponseEventArgs::DiarkisSessionCreateResponseEventArgs ( DiarkisSessionCreateResponseEventArgs &&  )
delete

Member Function Documentation

◆ IsSuccess()

bool Diarkis::DiarkisSessionCreateResponseEventArgs::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::DiarkisSessionCreateResponseEventArgs::GetSessionType ( ) const

Get the session type.

Here is the caller graph for this function:

◆ GetSessionID()

const Diarkis::StdString& Diarkis::DiarkisSessionCreateResponseEventArgs::GetSessionID ( ) const

Get the session ID.

Here is the caller graph for this function:

◆ GetErrorCode()

uint16_t Diarkis::DiarkisSessionCreateResponseEventArgs::GetErrorCode ( ) const

Get error code.

Return 0 if IsSuccess()=true.

Here is the caller graph for this function:

◆ GetErrorMessage()

const StdString& Diarkis::DiarkisSessionCreateResponseEventArgs::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: