Inheritance diagram for zeus::BufferParameter:
zeus::Buffer zeus::BufferAnswer zeus::BufferCall

Public Member Functions

template<class ZEUS_TYPE_DATA >
ZEUS_TYPE_DATA getParameter (int32_t _id) const
 
zeus::ParamType getParameterType (int32_t _id) const
 
const uint8_t * getParameterPointer (int32_t _id) const
 
uint32_t getParameterSize (int32_t _id) const
 
uint16_t getNumberParameter () const
 
void addParameterEmptyVector ()
 
void addParameter ()
 
std::string simpleStringParam (uint32_t _id) const
 
void composeWith (const uint8_t *_buffer, uint32_t _lenght) override
 
bool writeOn (enet::WebSocket &_interface) override
 
template<class ZEUS_TYPE_DATA >
void addParameter (const ZEUS_TYPE_DATA &_value)
 
void parameterAppendBufferData (ememory::SharedPtr< zeus::BufferData > _obj)
 
- Public Member Functions inherited from zeus::Buffer
virtual ~Buffer ()=default
 
bool haveAsync () const
 
std::vector< zeus::ActionAsyncClient > moveAsync ()
 
void appendBuffer (ememory::SharedPtr< zeus::Buffer > _obj)
 
virtual void appendBufferData (ememory::SharedPtr< zeus::BufferData > _obj)
 
void clear ()
 
uint32_t getTransactionId () const
 
void setTransactionId (uint32_t _value)
 
uint32_t getClientId () const
 
void setClientId (uint32_t _value)
 
uint32_t getServiceId () const
 
void setServiceId (uint32_t _value)
 
bool getPartFinish () const
 
void setPartFinish (bool _value)
 
virtual enum typeMessage getType () const
 
virtual void generateDisplay (std::ostream &_os) const
 

Protected Member Functions

template<class ZEUS_TYPE_DATA >
void addParameter (uint16_t _paramId, const ZEUS_TYPE_DATA &_value)
 
- Protected Member Functions inherited from zeus::Buffer
 Buffer ()
 

Protected Attributes

std::vector< std::pair< int32_t, std::vector< uint8_t > > > m_parameter
 
- Protected Attributes inherited from zeus::Buffer
headerBin m_header
 
std::vector< zeus::ActionAsyncClient > m_multipleSend
 

Additional Inherited Members

- Public Types inherited from zeus::Buffer
enum  typeMessage {
  typeMessage::unknow = 0x0000, typeMessage::call = 0x0001, typeMessage::answer = 0x0002, typeMessage::data = 0x0003,
  typeMessage::event = 0x0004
}
 
- Static Public Member Functions inherited from zeus::Buffer
static ememory::SharedPtr< zeus::Buffercreate ()
 
static ememory::SharedPtr< zeus::Buffercreate (const std::vector< uint8_t > &_buffer)
 

Member Function Documentation

§ addParameter() [1/2]

void zeus::BufferParameter::addParameter ( )

Add parameter (or not.. this is the end of an auto resursive add parameter)

§ addParameter() [2/2]

template<class ZEUS_TYPE_DATA >
void zeus::BufferParameter::addParameter ( uint16_t  _paramId,
const ZEUS_TYPE_DATA &  _value 
)
protected

Add a parameter at a specific position.

Parameters
[in]_paramIdId of the parameter (needed for the multiple packet sending)
[in]_valueValue to add in parameter

§ addParameterEmptyVector()

void zeus::BufferParameter::addParameterEmptyVector ( )

Add an empty vector with no type.

§ composeWith()

void zeus::BufferParameter::composeWith ( const uint8_t *  _buffer,
uint32_t  _lenght 
)
overridevirtual

When receive new data form websocket, it might be added by this input (set all the frame ...)

Parameters
[in]_bufferPointer on the data to add.
[in]_lenghtnumber of octet to add.

Reimplemented from zeus::Buffer.

§ getNumberParameter()

uint16_t zeus::BufferParameter::getNumberParameter ( ) const

Get the number of parameter availlable.

Returns
number of parameter

§ getParameter()

template<class ZEUS_TYPE_DATA >
ZEUS_TYPE_DATA zeus::BufferParameter::getParameter ( int32_t  _id) const

Template to get a parameter with a specific type.

Parameters
[in]_idNumber of the parameter
Returns
Converted type of the parameter (or empty value)

§ getParameterPointer()

const uint8_t* zeus::BufferParameter::getParameterPointer ( int32_t  _id) const

Get the start pointer of the parameter.

Parameters
[in]_idNumber of the parameter
Returns
pointer of the parameter or nullptr

§ getParameterSize()

uint32_t zeus::BufferParameter::getParameterSize ( int32_t  _id) const

Get the size of the parameter availlable in the parameter pointer.

Parameters
[in]_idNumber of the parameter
Returns
size of the parameter buffer

§ getParameterType()

zeus::ParamType zeus::BufferParameter::getParameterType ( int32_t  _id) const

Get the type of a parameter.

Parameters
[in]_idNumber of the parameter
Returns
type of the parameter

§ simpleStringParam()

std::string zeus::BufferParameter::simpleStringParam ( uint32_t  _id) const

Convert the parameter in a simple human readable string.

Parameters
[in]_idNumber of the parameter
Returns
readable string

§ writeOn()

bool zeus::BufferParameter::writeOn ( enet::WebSocket _interface)
overridevirtual

Write the buffer on a specific interface.

Parameters
[in]_interfacesocket to write data
Returns
true of no error appear

Reimplemented from zeus::Buffer.

Member Data Documentation

§ m_parameter

std::vector<std::pair<int32_t,std::vector<uint8_t> > > zeus::BufferParameter::m_parameter
mutableprotected

list of the parameter (offset of start data and buffer of data (subprotocol...)


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