zeus::BufferData Class Reference

Inheritance diagram for zeus::BufferData:

Public Member Functions
enum zeus::Buffer::typeMessage	getType () const override
uint16_t	getParameterId () const
uint32_t	getPartId () const
void	setPartId (uint32_t _value)
void	addData (uint16_t _parameterId, void *_data, uint32_t _size)
const std::vector< uint8_t > &	getData () const
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)

Static Public Member Functions
static ememory::SharedPtr< zeus::BufferData >	create ()
Static Public Member Functions inherited from zeus::Buffer
static ememory::SharedPtr< zeus::Buffer >	create ()
static ememory::SharedPtr< zeus::Buffer >	create (const std::vector< uint8_t > &_buffer)

Protected Member Functions
	BufferData ()
void	composeWith (const uint8_t *_buffer, uint32_t _lenght) override
bool	writeOn (enet::WebSocket &_interface) override
void	generateDisplay (std::ostream &_os) const override
Protected Member Functions inherited from zeus::Buffer
	Buffer ()

Protected Attributes
uint32_t	m_partId
uint16_t	m_parameterId
std::vector< uint8_t >	m_data
Protected Attributes inherited from zeus::Buffer
headerBin	m_header
std::vector< zeus::ActionAsyncClient >	m_multipleSend

Friends
class	zeus::Buffer

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 }

Constructor & Destructor Documentation

BufferData()

zeus::BufferData::BufferData ( )

inlineprotected

basic constructor (hidden to force the use of ememory::SharedPtr) zeus::BufferData::create

Member Function Documentation

addData()

void zeus::BufferData::addData	(	uint16_t	_parameterId,
		void *	_data,
		uint32_t	_size
	)

add a raw data on the buffer

Parameters

[in]	_parameterId	Parameter id of the destination of the data
[in]	_data	Pointer on the data
[in]	_size	size of the data to add

composeWith()

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

overrideprotectedvirtual

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

Parameters

[in]	_buffer	Pointer on the data to add.
[in]	_lenght	number of octet to add.

Reimplemented from zeus::Buffer.

create()

static ememory::SharedPtr<zeus::BufferData> zeus::BufferData::create ( )

static

Create a shared pointer on the BufferData.

Returns

Allocated Buffer.

getData()

const std::vector<uint8_t>& zeus::BufferData::getData ( ) const

inline

Get data reference.

getParameterId()

uint16_t zeus::BufferData::getParameterId ( ) const

inline

Get the parameter Id of the buffer.

Returns

Part Identifier

getPartId()

uint32_t zeus::BufferData::getPartId

(

)

const

Get the part Id of the buffer.

Returns

Part Identifier

getType()

enum zeus::Buffer::typeMessage zeus::BufferData::getType ( ) const

inlineoverridevirtual

Get the type of the buffer.

Returns

the current type of the buffer

Reimplemented from zeus::Buffer.

setPartId()

void zeus::BufferData::setPartId

(

uint32_t

_value

)

Set the part Id of the buffer.

Parameters

[in]

_value

New Part ID

writeOn()

bool zeus::BufferData::writeOn ( enet::WebSocket &  _interface )

overrideprotectedvirtual

Write the buffer on a specific interface.

Parameters

[in]

_interface

socket to write data

Returns

true of no error appear

Reimplemented from zeus::Buffer.

---

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

• framework/atria-soft/zeus/zeus/BufferData.hpp