ELClientResponse Class Reference

#include <ELClientResponse.h>

Public Member Functions
	ELClientResponse (ELClientPacket *packet)
	Constructor for ELClientResponse with ELClientPacket packet.
	ELClientResponse (void *packet)
	Constructor for ELClientResponse with void packet.
uint16_t	argc ()
uint16_t	cmd ()
uint32_t	value ()
uint16_t	argLen ()
int16_t	popArg (void *data, uint16_t maxLen)
	Extract an argument from the response packet.
int16_t	popArgPtr (void **data)
	Extract pointer to an argument from the response packet.
void	popChar (char *buffer)
	Extract a character from the response packet.
String	popString ()
	Extract a string from the response packet.
void	popString (String *data)
	Extract the pointer to a string from the response packet.

Detailed Description

Definition at line 26 of file ELClientResponse.h.

Constructor & Destructor Documentation

ELClientResponse() [1/2]

ELClientResponse::ELClientResponse

(

ELClientPacket *

packet

)

Constructor for ELClientResponse with ELClientPacket packet.

ELClientResponse(ELClientPacket* packet)

Parameters

packet

Pointer to packet for response

Example

no example code yet

Definition at line 15 of file ELClientResponse.cpp.

ELClientResponse() [2/2]

ELClientResponse::ELClientResponse

(

void *

packet

)

Constructor for ELClientResponse with void packet.

ELClientResponse(void* packet)

Parameters

packet

Pointer to packet for response

Example

no example code yet

Definition at line 30 of file ELClientResponse.cpp.

Member Function Documentation

argc()

uint16_t ELClientResponse::argc ( )

inline

Get number of arguments

Definition at line 33 of file ELClientResponse.h.

Here is the caller graph for this function:

argLen()

uint16_t ELClientResponse::argLen ( )

inline

Get length of argument

Definition at line 38 of file ELClientResponse.h.

cmd()

uint16_t ELClientResponse::cmd ( )

inline

Get command

Definition at line 34 of file ELClientResponse.h.

popArg()

int16_t ELClientResponse::popArg	(	void *	d,
		uint16_t	maxLen
	)

Extract an argument from the response packet.

popArg(void* d, uint16_t maxLen)

Parameters

d	Pointer to buffer for the argument
maxLen	Size of the buffer for the argument

Returns

int16_t Size of argument

Example

no example code yet

Definition at line 73 of file ELClientResponse.cpp.

Here is the caller graph for this function:

popArgPtr()

int16_t ELClientResponse::popArgPtr

(

void **

data

)

Extract pointer to an argument from the response packet.

popArgPtr(void **data)

Parameters

data	Pointer to buffer for the argument pointer

Returns

int16_t Size of argument

Example

no example code yet

Definition at line 47 of file ELClientResponse.cpp.

popChar()

void ELClientResponse::popChar

(

char *

buffer

)

Extract a character from the response packet.

popChar(char* buffer)

Parameters

buffer

Pointer to buffer for the character

Example

no example code yet

Definition at line 100 of file ELClientResponse.cpp.

popString() [1/2]

String ELClientResponse::popString

(

)

Extract a string from the response packet.

popString()

Returns

String String extracted from the response packet

Example

no example code yet

Definition at line 124 of file ELClientResponse.cpp.

Here is the caller graph for this function:

popString() [2/2]

void ELClientResponse::popString

(

String *

data

)

Extract the pointer to a string from the response packet.

popString(String* data)

Parameters

data	Pointer to be set to the string in the response packet

Example

no example code yet

Definition at line 147 of file ELClientResponse.cpp.

value()

uint32_t ELClientResponse::value ( )

inline

Get returned value

Definition at line 35 of file ELClientResponse.h.

---

The documentation for this class was generated from the following files:

• Gbox420_Mega_Main/ELClient/ELClientResponse.h
• Gbox420_Mega_Main/ELClient/ELClientResponse.cpp