epics::pvData::SerializableControl Class Reference

Callback class for serialization. More...

#include "serialize.h"

Inheritance diagram for epics::pvData::SerializableControl:

Public Member Functions
virtual	~SerializableControl ()
virtual void	flushSerializeBuffer ()=0
virtual void	ensureBuffer (std::size_t size)=0
virtual void	alignBuffer (std::size_t alignment)=0
virtual bool	directSerialize (ByteBuffer *existingBuffer, const char *toSerialize, std::size_t elementCount, std::size_t elementSize)=0
virtual void	cachedSerialize (std::tr1::shared_ptr< const Field > const &field, ByteBuffer *buffer)=0

Detailed Description

Callback class for serialization.

This must be provided by code that calls serialize.

Definition at line 34 of file serialize.h.

Constructor & Destructor Documentation

virtual epics::pvData::SerializableControl::~SerializableControl ( )

inlinevirtual

Destructor.

Definition at line 39 of file serialize.h.

{}

Member Function Documentation

virtual void epics::pvData::SerializableControl::alignBuffer ( std::size_t  alignment )

pure virtual

Add pad bytes to buffer.

Parameters

alignment

alignment required.

Implemented in epics::pvAccess::BlockingUDPTransport, and epics::pvAccess::detail::AbstractCodec.

virtual void epics::pvData::SerializableControl::cachedSerialize ( std::tr1::shared_ptr< const Field > const &  field, ByteBuffer *  buffer  )

pure virtual

serialize via cache

Parameters

field	instance to be serialized
buffer	buffer to be serialized to

virtual bool epics::pvData::SerializableControl::directSerialize ( ByteBuffer *  existingBuffer, const char *  toSerialize, std::size_t  elementCount, std::size_t  elementSize  )

pure virtual

Method for serializing primitive array data. Hook for supplying custom serialization implementation. The serialization implementation need not be provided. Returns true if method performs serialization, false otherwise. This should only be used for arrays of primitive types, i. e. boolean, byte,..., double. It cannot be called for string, structure, or union arrays.

Parameters

existingBuffer	the existing buffer from the caller.
toSerialize	location of data to be put into buffer.
elementCount	number of elements.
elementSize	element size.

Returns

true if serialization performed, else false.

Implemented in epics::pvAccess::detail::AbstractCodec, and epics::pvAccess::BlockingUDPTransport.

virtual void epics::pvData::SerializableControl::ensureBuffer ( std::size_t  size )

pure virtual

Make sure buffer has at least size bytes remaining. If not flush existing buffer and provide a new one.

Parameters

size	The number of bytes.

Implemented in epics::pvAccess::BlockingUDPTransport, and epics::pvAccess::detail::AbstractCodec.

virtual void epics::pvData::SerializableControl::flushSerializeBuffer ( )

pure virtual

Done with this buffer. Flush it.

Implemented in epics::pvAccess::detail::AbstractCodec, and epics::pvAccess::BlockingUDPTransport.

---

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

• modules/pvData/src/misc/pv/serialize.h