Class allowing to encapsulate an hybrid form of fragment buffer. More...

#include <FragHybridBuffer.h>

Inheritance diagram for ipsdk::FragHybridBuffer:

Public Member Functions
eBufferType	getBufferType () const
	retrieve buffer type

void	init (const eDataType &dataType, const BufferPtrColl &bufferPtrColl, const ipUInt64 fragmentsSize)
	generic initialisation method for buffer from external data More...

void	init (const eDataType &dataType, const ipUInt64 nbFragments, const ipUInt64 fragmentsSize)
	initialization method for buffer with own data More...

bool	isBufferOwn () const
	check whether buffer is own More...

void	setDataPtr (const ipUInt64 fragmentIndex, void *pData)
	method allowing to set a given data pointer for buffer More...

Constructors and destructors
	FragHybridBuffer ()

	~FragHybridBuffer ()

Public Member Functions inherited from ipsdk::BaseFragBuffer
ipUInt64	getNbFragments () const
	retrieve number of fragments for buffer More...

ipUInt64	getFragmentsSize () const
	retrieve fragments size More...

const BufferPtrColl &	getBufferPtrColl () const
	retrieve fragment pointers collection for buffer More...

void	rollUpFragments ()
	method allowing to roll up all fragments into buffer. Fragments indexes are modified as follow : More...

void	rollDownFragments ()
	method allowing to roll down all fragments into buffer. Fragments indexes are modified as follow : More...

	BaseFragBuffer ()

virtual	~BaseFragBuffer ()=0

const void *	getDataPtr (const ipUInt64 fragmentIndex) const
	retrieve buffer data for a given fragment index More...

void *	getDataPtr (const ipUInt64 fragmentIndex)
	retrieve buffer data for a given fragment index More...

const void *	getDataPtr (const ipUInt64 fragmentIndex, const ipUInt64 offset) const
	retrieve buffer data for a given fragment index and a given offset More...

void *	getDataPtr (const ipUInt64 fragmentIndex, const ipUInt64 offset)
	retrieve buffer data for a given fragment index and a given offset More...

Public Member Functions inherited from ipsdk::BaseBuffer
bool	isInit () const

ipUInt64	getSize () const
	retrieve buffer size More...

ipUInt32	getBufferBaseSize () const
	retrieve buffer base size More...

ipUInt64	getMemorySize () const
	retrieve buffer memory size (in octets) More...

const eDataType &	getDataType () const
	retrieve buffer data type More...

void	clear ()
	delete buffer data

	BaseBuffer ()

virtual	~BaseBuffer ()=0

Public Member Functions inherited from ipsdk::BaseObjectWithSkeleton
const eSklSrzMode &	getSerializationMode () const
	retrieve serialization flag for object More...

void	setSerializationMode (const eSklSrzMode &sklSrzMode) const
	set serialization flag for object

	BaseObjectWithSkeleton ()

	~BaseObjectWithSkeleton ()

Public Member Functions inherited from ipsdk::BaseSerializationObject
	BaseSerializationObject ()
	Default constructor.

virtual	~BaseSerializationObject ()=0
	destructor

Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string &	getClassName () const
	method allowing to retrieve object class name

virtual BaseDynamicObject *	createNew () const =0
	method allowing to create new instance of current object type

virtual DynamicObjectPtr	createShared () const =0
	method allowing to create new shared instance of current object type

virtual bool	hasCopySupport () const =0
	check whether objet has copy support

virtual BaseDynamicObject *	duplicate () const =0
	method allowing to duplicate current object More...

virtual DynamicObjectPtr	duplicateShared () const =0
	method allowing shared duplication of current object More...

	BaseDynamicObject ()

virtual	~BaseDynamicObject ()=0

Protected Member Functions
void	clearDerived ()
	clear method instanciation in derived class

Protected Member Functions inherited from ipsdk::BaseFragBuffer
void	initBase (const eDataType &dataType, const BufferPtrColl &bufferPtrColl, const ipUInt64 fragmentsSize)
	initialization of base class More...

void	setDataPtr (const ipUInt64 fragmentIndex, void *pData)
	method allowing to set a given data pointer for buffer More...

Protected Member Functions inherited from ipsdk::BaseBuffer
void	initBase (const ipUInt64 size, const eDataType &dataType)
	initialization of base class More...

Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult	write (BaseOArchive &ar) const
	method allowing to ensure serialization write part for object

virtual BoolResult	read (BaseIArchive &ar)
	method allowing to ensure serialization read part for object

Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void	initCtorCopy (const BaseDynamicObject &object)

virtual void	copy (const BaseDynamicObject &object)
	method allowing to copy data from another object

Protected Attributes
boost::scoped_array< ipUInt8 >	_pBufferData
	own buffer data

Protected Attributes inherited from ipsdk::BaseObjectWithSkeleton
eSklSrzMode	_sklSrzMode
	serialization flag for object More...

Additional Inherited Members
Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()
	method allowing to retrieve class version information for serialization

Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()
	method allowing to retrieve name associated to class

Detailed Description

Class allowing to encapsulate an hybrid form of fragment buffer.

Author: E. Noirfalise

Date: 2013/8/29

Copyright: 2013 Reactiv'IP, all right reserved.

This buffer can be alternatively own or external

When buffer is own, resize and reinit operations conduce to reallocation only if size differ.

When restored (via serialization), an already initialized buffer will try to match restored data with its buffer.

For an external buffer :
- a send operation (of type save this then restore other) will conduce to the creation of an own buffer (provided buffer is not already an external) since there is no guaranty that external data is stored on the same computer.
- a receive operation (of type save other then restore this) will simply copy received data to external location. In this case, if data type or size mismatch an error will be thrown
For a own buffer :
- a send operation (of type save this then restore other) will conduce to the creation of an own buffer (provided buffer is not already an external) and copy data.
- a receive operation (of type save other then restore this) will simply copy received data to external location. In this case, buffer is resized if needed

Member Function Documentation

◆ init() [1/2]

void ipsdk::FragHybridBuffer::init	(	const eDataType &	dataType,
		const BufferPtrColl &	bufferPtrColl,
		const ipUInt64	fragmentsSize
	)

generic initialisation method for buffer from external data

Exceptions

ipsdk::IPSDKBaseDataException if dataType == eDataType::eDT_None

◆ init() [2/2]

void ipsdk::FragHybridBuffer::init	(	const eDataType &	dataType,
		const ipUInt64	nbFragments,
		const ipUInt64	fragmentsSize
	)

initialization method for buffer with own data

Exceptions

ipsdk::IPSDKBaseDataException	if dataType == eDataType::eDT_None
ipsdk::IPSDKBaseDataException	if can't allocate memory

◆ isBufferOwn()

bool ipsdk::FragHybridBuffer::isBufferOwn ( ) const

check whether buffer is own

Exceptions

ipsdk::IPSDKBaseDataException if isInit() == false

◆ setDataPtr()

void ipsdk::FragHybridBuffer::setDataPtr	(	const ipUInt64	fragmentIndex,
		void *	pData
	)

method allowing to set a given data pointer for buffer

Exceptions

ipsdk::IPSDKBaseDataException	if isBufferOwn() == true
ipsdk::IPSDKBaseDataException	if fragmentIndex >= getNbFragments()

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKBaseData/Buffer/FragHybridBuffer.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ init() [1/2]

◆ init() [2/2]

◆ isBufferOwn()

◆ setDataPtr()