epics::pvData::DeserializableControl Class Reference

Callback class for deserialization. More...

#include "serialize.h"

Inheritance diagram for epics::pvData::DeserializableControl:

Public Member Functions
virtual	~DeserializableControl ()
virtual void	ensureData (std::size_t size)=0
virtual void	alignData (std::size_t alignment)=0
virtual bool	directDeserialize (ByteBuffer *existingBuffer, char *deserializeTo, std::size_t elementCount, std::size_t elementSize)=0
virtual std::tr1::shared_ptr< const Field >	cachedDeserialize (ByteBuffer *buffer)=0

Detailed Description

Callback class for deserialization.

This must be provided by code that calls deserialize.

Definition at line 89 of file serialize.h.

Constructor & Destructor Documentation

virtual epics::pvData::DeserializableControl::~DeserializableControl ( )

inlinevirtual

Destructor.

Definition at line 94 of file serialize.h.

{}

Member Function Documentation

virtual void epics::pvData::DeserializableControl::alignData ( std::size_t  alignment )

pure virtual

Align buffer. Note that this takes care only current buffer alignment. If streaming protocol is used, care must be taken that entire stream is aligned.

Parameters

alignment

size in bytes, must be power of two.

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

virtual std::tr1::shared_ptr<const Field> epics::pvData::DeserializableControl::cachedDeserialize ( ByteBuffer *  buffer )

pure virtual

deserialize via cache

Parameters

buffer

buffer to be deserialized from

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

virtual bool epics::pvData::DeserializableControl::directDeserialize ( ByteBuffer *  existingBuffer, char *  deserializeTo, std::size_t  elementCount, std::size_t  elementSize  )

pure virtual

Method for deserializing array data. Hook for supplying custom deserialization implementation. The deserialization implementation need not be provided. Returns true if method performs deserialization, 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.
deserializeTo	location of data.
elementCount	number of elements.
elementSize	element size.

Returns

true if deserialization performed, else false.

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

virtual void epics::pvData::DeserializableControl::ensureData ( std::size_t  size )

pure virtual

Helper method. Ensures specified size of bytes, provides it if necessary.

Parameters

size	The number of bytes.

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