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

Argument of the callback event called when a UDP or TCP Response is received. More...

#include <eventArgs.h>

Public Member Functions

uint8_t GetVersion () const
 Get the command version. More...
 
uint16_t GetCommand () const
 Get the command id. More...
 
uint8_t GetStatus () const
 Get the result of the command. More...
 
const StdVector< uint8_t > & GetPayload () const
 Get the received payload. More...
 
bool IsReliable () const
 Whether or not the communication was RUDP. More...
 
 DiarkisResponseEventArgs (uint8_t version, uint16_t command, uint8_t status, const StdVector< uint8_t > &payload, const bool reliable)
 
 DiarkisResponseEventArgs (DiarkisResponseEventArgs &)=delete
 
 DiarkisResponseEventArgs (DiarkisResponseEventArgs &&)=delete
 
 ~DiarkisResponseEventArgs ()
 

Detailed Description

Argument of the callback event called when a UDP or TCP Response is received.

Constructor & Destructor Documentation

◆ DiarkisResponseEventArgs() [1/3]

Diarkis::DiarkisResponseEventArgs::DiarkisResponseEventArgs ( uint8_t  version,
uint16_t  command,
uint8_t  status,
const StdVector< uint8_t > &  payload,
const bool  reliable 
)

◆ DiarkisResponseEventArgs() [2/3]

Diarkis::DiarkisResponseEventArgs::DiarkisResponseEventArgs ( DiarkisResponseEventArgs )
delete

◆ DiarkisResponseEventArgs() [3/3]

Diarkis::DiarkisResponseEventArgs::DiarkisResponseEventArgs ( DiarkisResponseEventArgs &&  )
delete

◆ ~DiarkisResponseEventArgs()

Diarkis::DiarkisResponseEventArgs::~DiarkisResponseEventArgs ( )

Member Function Documentation

◆ GetVersion()

uint8_t Diarkis::DiarkisResponseEventArgs::GetVersion ( ) const

Get the command version.

Here is the caller graph for this function:

◆ GetCommand()

uint16_t Diarkis::DiarkisResponseEventArgs::GetCommand ( ) const

Get the command id.

Here is the caller graph for this function:

◆ GetStatus()

uint8_t Diarkis::DiarkisResponseEventArgs::GetStatus ( ) const

Get the result of the command.

Here is the caller graph for this function:

◆ GetPayload()

const StdVector<uint8_t>& Diarkis::DiarkisResponseEventArgs::GetPayload ( ) const

Get the received payload.

Here is the caller graph for this function:

◆ IsReliable()

bool Diarkis::DiarkisResponseEventArgs::IsReliable ( ) const

Whether or not the communication was RUDP.

Here is the caller graph for this function:

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