FlowEngine::DynamicBufferInterface Class Reference

#include <DynamicBufferInterface.h>

Public Member Functions
virtual FLE_DLL Result	getContent (Buffer< char > buffer) const =0
virtual FLE_DLL Size	getContentSize () const =0
virtual FLE_DLL Result	setContent (ConstBuffer< char > buffer)=0
virtual FLE_DLL	~DynamicBufferInterface ()=default

Detailed Description

Dynamic memory buffer utility used to marshall variable amount of data.

Constructor & Destructor Documentation

~DynamicBufferInterface()

virtual FLE_DLL FlowEngine::DynamicBufferInterface::~DynamicBufferInterface ( )

virtualdefault

Default virtual destructor.

Member Function Documentation

getContent()

virtual FLE_DLL Result FlowEngine::DynamicBufferInterface::getContent ( Buffer< char >  buffer ) const

pure virtual

Copies the content of the buffer to the supplied buffer.

Parameters

buffer

a buffer that will receive the data.

Returns

One of the following result codes:

• Result::Success – if the data was successfully copied to the buffer.
• Result::InvalidArgument – if buffer is not a valid buffer.
• Result::BufferTooSmall – if buffer is not big enough to receive all data. See getContentSize.

getContentSize()

virtual FLE_DLL Size FlowEngine::DynamicBufferInterface::getContentSize ( ) const

pure virtual

Returns

the size of the buffer.

setContent()

virtual FLE_DLL Result FlowEngine::DynamicBufferInterface::setContent ( ConstBuffer< char >  buffer )

pure virtual

Set the content of the buffer. Data is copied.

Parameters

buffer

a buffer containing the data to be copied.

Returns

One of the following result codes:

• Result::Success – if the data was successfully copied from the buffer.
• Result::InvalidArgument – if buffer is not a valid buffer.
• Result::OutOfMemoryError – if the system reported a bad memory allocation.