Simple binary serialization format. More...

#include <erpc_basic_codec.hpp>

Inheritance diagram for erpc::BasicCodec:

Collaboration diagram for erpc::BasicCodec:

Public Member Functions
	BasicCodec (void)
	Constructor.

virtual	~BasicCodec (void)
	CodecFactory destructor.

Encoding
virtual void	startWriteMessage (message_type_t type, uint32_t service, uint32_t request, uint32_t sequence) override
	Prototype for write header of message. More...

virtual void	writeData (uint32_t length, const void *value)
	Prototype for write data stream. More...

virtual void	write (bool value) override
	Prototype for write boolean value. More...

virtual void	write (int8_t value) override
	Prototype for write int8_t value. More...

virtual void	write (int16_t value) override
	Prototype for write int16_t value. More...

virtual void	write (int32_t value) override
	Prototype for write int32_t value. More...

virtual void	write (int64_t value) override
	Prototype for write int64_t value. More...

virtual void	write (uint8_t value) override
	Prototype for write uint8_t value. More...

virtual void	write (uint16_t value) override
	Prototype for write uint16_t value. More...

virtual void	write (uint32_t value) override
	Prototype for write uint32_t value. More...

virtual void	write (uint64_t value) override
	Prototype for write uint64_t value. More...

virtual void	write (float value) override
	Prototype for write float value. More...

virtual void	write (double value) override
	Prototype for write double value. More...

virtual void	writePtr (uintptr_t value) override
	Prototype for write uintptr value. More...

virtual void	writeString (uint32_t length, const char *value) override
	Prototype for write string value. More...

virtual void	writeBinary (uint32_t length, const uint8_t *value) override
	Prototype for write binary value. More...

virtual void	startWriteList (uint32_t length) override
	Prototype for start write list. More...

virtual void	startWriteUnion (int32_t discriminator) override
	Prototype for start write union. More...

virtual void	writeNullFlag (bool isNull) override
	Writes a flag indicating whether the next value is null. More...

Decoding
virtual void	startReadMessage (message_type_t &type, uint32_t &service, uint32_t &request, uint32_t &sequence) override
	Prototype for read header of message. More...

virtual void	readData (uint32_t length, void *value)
	Prototype for read data stream. More...

virtual void	read (bool &value) override
	Prototype for read boolean value. More...

virtual void	read (int8_t &value) override
	Prototype for read int8_t value. More...

virtual void	read (int16_t &value) override
	Prototype for read int16_t value. More...

virtual void	read (int32_t &value) override
	Prototype for read int32_t value. More...

virtual void	read (int64_t &value) override
	Prototype for read int64_t value. More...

virtual void	read (uint8_t &value) override
	Prototype for read uint8_t value. More...

virtual void	read (uint16_t &value) override
	Prototype for read uint16_t value. More...

virtual void	read (uint32_t &value) override
	Prototype for read uint32_t value. More...

virtual void	read (uint64_t &value) override
	Prototype for read uint64_t value. More...

virtual void	read (float &value) override
	Prototype for read float value. More...

virtual void	read (double &value) override
	Prototype for read double value. More...

virtual void	readPtr (uintptr_t &value) override
	Prototype for read uintptr value. More...

virtual void	readString (uint32_t &length, char **value) override
	Prototype for read string value. More...

virtual void	readBinary (uint32_t &length, uint8_t **value) override
	Prototype for read binary value. More...

virtual void	startReadList (uint32_t &length) override
	Prototype for start read list. More...

virtual void	startReadUnion (int32_t &discriminator) override
	Prototype for start read union. More...

virtual void	readNullFlag (bool &isNull) override
	Reads a flag indicating whether the next value is null. More...

Public Member Functions inherited from erpc::Codec
	Codec (void)
	Constructor. More...

virtual	~Codec (void)
	Codec destructor.

MessageBuffer	getBuffer (void)
	Return message buffer used for read and write data. More...

MessageBuffer &	getBufferRef (void)

virtual void	setBuffer (MessageBuffer &buf, uint8_t skip=0)
	Prototype for set message buffer used for read and write data. More...

virtual void	reset (uint8_t skip=0)
	Reset the codec to initial state. More...

erpc_status_t	getStatus (void)
	Return current status of eRPC message processing. More...

bool	isStatusOk (void)
	Return bool value representing current status. More...

void	updateStatus (erpc_status_t status)
	Set current status of eRPC message processing to given value. More...

Static Public Attributes
static const uint32_t	kBasicCodecVersion

Additional Inherited Members
Protected Attributes inherited from erpc::Codec
Cursor	m_cursor

erpc_status_t	m_status

Detailed Description

Simple binary serialization format.

Member Function Documentation

void BasicCodec::startWriteMessage	(	message_type_t	type,
		uint32_t	service,
		uint32_t	request,
		uint32_t	sequence
	)

overridevirtual

Prototype for write header of message.

Parameters

[in]	type	Type of message.
[in]	service	Which interface is requested.
[in]	request	Which function need be called.
[in]	sequence	Send sequence number to be sure that received message is reply for current request. or write function.

Implements erpc::Codec.

void BasicCodec::writeData	(	uint32_t	length,
		const void *	value
	)

virtual

Prototype for write data stream.

Parameters

[in]	length	Size of data stream in bytes.
[in]	value	Pointer to data stream.

void BasicCodec::write ( bool value )

overridevirtual

Prototype for write boolean value.

Parameters

[in] value Boolean typed value to write.

Implements erpc::Codec.

void BasicCodec::write ( int8_t value )

overridevirtual

Prototype for write int8_t value.

Parameters

[in] value int8_t typed value to write.

Implements erpc::Codec.

void BasicCodec::write ( int16_t value )

overridevirtual

Prototype for write int16_t value.

Parameters

[in] value int16_t typed value to write.

Implements erpc::Codec.

void BasicCodec::write ( int32_t value )

overridevirtual

Prototype for write int32_t value.

Parameters

[in] value int32_t typed value to write.

Implements erpc::Codec.

void BasicCodec::write ( int64_t value )

overridevirtual

Prototype for write int64_t value.

Parameters

[in] value int64_t typed value to write.

Implements erpc::Codec.

void BasicCodec::write ( uint8_t value )

overridevirtual

Prototype for write uint8_t value.

Parameters

[in] value uint8_t typed value to write.

Implements erpc::Codec.

void BasicCodec::write ( uint16_t value )

overridevirtual

Prototype for write uint16_t value.

Parameters

[in] value uint16_t typed value to write.

Implements erpc::Codec.

void BasicCodec::write ( uint32_t value )

overridevirtual

Prototype for write uint32_t value.

Parameters

[in] value uint32_t typed value to write.

Implements erpc::Codec.

void BasicCodec::write ( uint64_t value )

overridevirtual

Prototype for write uint64_t value.

Parameters

[in] value uint64_t typed value to write.

Implements erpc::Codec.

void BasicCodec::write ( float value )

overridevirtual

Prototype for write float value.

Parameters

[in] value float typed value to write.

Implements erpc::Codec.

void BasicCodec::write ( double value )

overridevirtual

Prototype for write double value.

Parameters

[in] value double typed value to write.

Implements erpc::Codec.

void BasicCodec::writePtr ( uintptr_t value )

overridevirtual

Prototype for write uintptr value.

Parameters

[in] value uintptr typed value to write.

Implements erpc::Codec.

void BasicCodec::writeString	(	uint32_t	length,
		const char *	value
	)

overridevirtual

Prototype for write string value.

Parameters

[in]	length	of string.
[in]	value	string value to write.

Implements erpc::Codec.

void BasicCodec::writeBinary	(	uint32_t	length,
		const uint8_t *	value
	)

overridevirtual

Prototype for write binary value.

Parameters

[in]	length	of binary.
[in]	value	Binary value to write.

Implements erpc::Codec.

void BasicCodec::startWriteList ( uint32_t length )

overridevirtual

Prototype for start write list.

Parameters

[in] length Length of list.

Implements erpc::Codec.

void BasicCodec::startWriteUnion ( int32_t discriminator )

overridevirtual

Prototype for start write union.

Parameters

[in] discriminator Discriminator of union.

Implements erpc::Codec.

void BasicCodec::writeNullFlag ( bool isNull )

overridevirtual

Writes a flag indicating whether the next value is null.

Parameters

[in] isNull Null flag to send.

Implements erpc::Codec.

void BasicCodec::startReadMessage	(	message_type_t &	type,
		uint32_t &	service,
		uint32_t &	request,
		uint32_t &	sequence
	)

overridevirtual

Prototype for read header of message.

Parameters

[out]	type	Type of message.
[out]	service	Which interface was used.
[out]	request	Which function was called.
[out]	sequence	Returned sequence number to be sure that received message is reply for current request.

Implements erpc::Codec.

void BasicCodec::readData	(	uint32_t	length,
		void *	value
	)

virtual

Prototype for read data stream.

Parameters

[in]	length	Size of data stream in bytes to be read.
[in]	value	Pointer to data stream to be read.

void BasicCodec::read ( bool & value )

overridevirtual

Prototype for read boolean value.

Parameters

[out] value Boolean typed value to read.

Implements erpc::Codec.

void BasicCodec::read ( int8_t & value )

overridevirtual

Prototype for read int8_t value.

Parameters

[out] value int8_t typed value to read.

Implements erpc::Codec.

void BasicCodec::read ( int16_t & value )

overridevirtual

Prototype for read int16_t value.

Parameters

[out] value int16_t typed value to read.

Implements erpc::Codec.

void BasicCodec::read ( int32_t & value )

overridevirtual

Prototype for read int32_t value.

Parameters

[out] value int32_t typed value to read.

Implements erpc::Codec.

void BasicCodec::read ( int64_t & value )

overridevirtual

Prototype for read int64_t value.

Parameters

[out] value int64_t typed value to read.

Implements erpc::Codec.

void BasicCodec::read ( uint8_t & value )

overridevirtual

Prototype for read uint8_t value.

Parameters

[out] value uint8_t typed value to read.

Implements erpc::Codec.

void BasicCodec::read ( uint16_t & value )

overridevirtual

Prototype for read uint16_t value.

Parameters

[out] value uint16_t typed value to read.

Implements erpc::Codec.

void BasicCodec::read ( uint32_t & value )

overridevirtual

Prototype for read uint32_t value.

Parameters

[out] value uint32_t typed value to read.

Implements erpc::Codec.

void BasicCodec::read ( uint64_t & value )

overridevirtual

Prototype for read uint64_t value.

Parameters

[out] value uint64_t typed value to read.

Implements erpc::Codec.

void BasicCodec::read ( float & value )

overridevirtual

Prototype for read float value.

Parameters

[out] value float typed value to read.

Implements erpc::Codec.

void BasicCodec::read ( double & value )

overridevirtual

Prototype for read double value.

Parameters

[out] value double typed value to read.

Implements erpc::Codec.

void BasicCodec::readPtr ( uintptr_t & value )

overridevirtual

Prototype for read uintptr value.

Parameters

[out] value uintptr typed value to read.

Implements erpc::Codec.

void BasicCodec::readString	(	uint32_t &	length,
		char **	value
	)

overridevirtual

Prototype for read string value.

Parameters

[out]	length	of string.
[out]	value	String value to read.

Implements erpc::Codec.

void BasicCodec::readBinary	(	uint32_t &	length,
		uint8_t **	value
	)

overridevirtual

Prototype for read binary value.

Parameters

[out]	length	of binary. 0 can be valid value or in case of error.
[out]	value	Binary value to read. Null in case of error.

Implements erpc::Codec.

void BasicCodec::startReadList ( uint32_t & length )

overridevirtual

Prototype for start read list.

Parameters

[out] length Length of list.

Implements erpc::Codec.

void BasicCodec::startReadUnion ( int32_t & discriminator )

overridevirtual

Prototype for start read union.

Parameters

[in] discriminator Discriminator of union.

Implements erpc::Codec.

void BasicCodec::readNullFlag ( bool & isNull )

overridevirtual

Reads a flag indicating whether the next value is null.

Parameters

[in] isNull Null flag to read.

Implements erpc::Codec.

Member Data Documentation

const uint32_t BasicCodec::kBasicCodecVersion

static

Codec version.

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

erpc_basic_codec.hpp
erpc_basic_codec.cpp

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation