epics::pvData::SerializeHelper Class Reference

Serialization helper. More...

#include <misc/pv/serializeHelper.h>

Static Public Member Functions
static void	writeSize (std::size_t s, ByteBuffer *buffer, SerializableControl *flusher)
static std::size_t	readSize (ByteBuffer *buffer, DeserializableControl *control)
static void	serializeString (const std::string &value, ByteBuffer *buffer, SerializableControl *flusher)
static void	serializeSubstring (const std::string &value, std::size_t offset, std::size_t count, ByteBuffer *buffer, SerializableControl *flusher)
static std::string	deserializeString (ByteBuffer *buffer, DeserializableControl *control, std::size_t max=0x7fffffff)

Detailed Description

Serialization helper.

Definition at line 29 of file serializeHelper.h.

Member Function Documentation

deserializeString()

std::string epics::pvData::SerializeHelper::deserializeString ( ByteBuffer * buffer, DeserializableControl * control, std::size_t max = 0x7fffffff )

static

std::string deserialization helper method.

Parameters

[in]	buffer	deserialization buffer
[in]	control	control
[in]	max	length limit

Returns

deserialized string

Todo

This method cannot return "null", but Java implementation could have serialized "null" value as well. This implementation returns an empty string in that event.

Since

8.0.9 Added the max argument. Test for the DESERIALIZE_STRING_HAS_LIMIT macro to detect. Retroactive default is 2 GiB

readSize()

std::size_t epics::pvData::SerializeHelper::readSize ( ByteBuffer * buffer, DeserializableControl * control )

static

Deserialize array size. The specified DeserializableControl ensures sufficient bytes are available.

Parameters

[in]	buffer	deserialization buffer.
[in]	control	the DeserializableControl.

Returns

array size, or (size_t) -1.

serializeString()

void epics::pvData::SerializeHelper::serializeString ( const std::string & value, ByteBuffer * buffer, SerializableControl * flusher )

static

std::string serialization helper method.

Parameters

[in]	value	std::string to serialize
[in]	buffer	serialization buffer
[in]	flusher	flusher

serializeSubstring()

void epics::pvData::SerializeHelper::serializeSubstring ( const std::string & value, std::size_t offset, std::size_t count, ByteBuffer * buffer, SerializableControl * flusher )

static

std::string serialization helper method.

Parameters

[in]	value	std::string to serialize
[in]	offset	start of the substring in value
[in]	count	the number of characters to write
[in]	buffer	serialization buffer
[in]	flusher	flusher

writeSize()

void epics::pvData::SerializeHelper::writeSize ( std::size_t s, ByteBuffer * buffer, SerializableControl * flusher )

static

Serialize the specified array size into the specified buffer, flushing when necessary. The specified SerializableControl manages any flushing required.

Parameters

[in]	s	size to encode
[in]	buffer	serialization buffer
[in]	flusher	SerializableControl to manage the flushing

---

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

• misc/pv/serializeHelper.h