osg::BinaryDataHandler Class Reference
[Base]

#include <OSGBinaryDataHandler.h>

Inheritance diagram for osg::BinaryDataHandler:

List of all members.

Public Member Functions
Constructors
	BinaryDataHandler (UInt32 zeroCopyThreshold=0, bool networkOrder=true)
Destructors
virtual	~BinaryDataHandler (void)
Put
void	put (void const *src, UInt32 size)
void	putAndFree (MemoryHandle src, UInt32 size)
void	putValue (const bool &value)
void	putValue (const UInt8 &value)
void	putValue (const UInt16 &value)
void	putValue (const UInt32 &value)
void	putValue (const UInt64 &value)
void	putValue (const Int8 &value)
void	putValue (const Int16 &value)
void	putValue (const Int32 &value)
void	putValue (const Int64 &value)
void	putValue (const Real16 &value)
void	putValue (const Real32 &value)
void	putValue (const Real64 &value)
void	putValue (const Real128 &value)
void	putValue (const std::string &value)
void	putValues (const bool *value, UInt32 size)
void	putValues (const UInt8 *value, UInt32 size)
void	putValues (const UInt16 *value, UInt32 size)
void	putValues (const UInt32 *value, UInt32 size)
void	putValues (const UInt64 *value, UInt32 size)
void	putValues (const Int8 *value, UInt32 size)
void	putValues (const Int16 *value, UInt32 size)
void	putValues (const Int32 *value, UInt32 size)
void	putValues (const Int64 *value, UInt32 size)
void	putValues (const Real16 *value, UInt32 size)
void	putValues (const Real32 *value, UInt32 size)
void	putValues (const Real64 *value, UInt32 size)
void	putValues (const Real128 *value, UInt32 size)
void	putValues (const std::string *value, UInt32 size)
Get
void	get (void *dst, UInt32 size)
void	getAndAlloc (MemoryHandle &src, UInt32 size)
void	getValue (bool &value)
void	getValue (UInt8 &value)
void	getValue (UInt16 &value)
void	getValue (UInt32 &value)
void	getValue (UInt64 &value)
void	getValue (Int8 &value)
void	getValue (Int16 &value)
void	getValue (Int32 &value)
void	getValue (Int64 &value)
void	getValue (Real16 &value)
void	getValue (Real32 &value)
void	getValue (Real64 &value)
void	getValue (Real128 &value)
void	getValue (std::string &value)
void	getValues (bool *value, UInt32 size)
void	getValues (UInt8 *value, UInt32 size)
void	getValues (UInt16 *value, UInt32 size)
void	getValues (UInt32 *value, UInt32 size)
void	getValues (UInt64 *value, UInt32 size)
void	getValues (Int8 *value, UInt32 size)
void	getValues (Int16 *value, UInt32 size)
void	getValues (Int32 *value, UInt32 size)
void	getValues (Int64 *value, UInt32 size)
void	getValues (Real16 *value, UInt32 size)
void	getValues (Real32 *value, UInt32 size)
void	getValues (Real64 *value, UInt32 size)
void	getValues (Real128 *value, UInt32 size)
void	getValues (std::string *value, UInt32 size)
Helper
virtual void	forceCopy (void)
virtual void	forceDirectIO (void)
void	flush (void)
	write data not yet written
void	setNetworkOrder (bool value)
bool	getNetworkOrder (void)
Protected Types
typedef std::vector< MemoryBlock >	BuffersT
typedef std::list< MemoryHandle >	FreeMemT
Protected Member Functions
Read
BuffersT::iterator	readBufBegin (void)
BuffersT::iterator	readBufEnd (void)
void	readBufAdd (MemoryHandle mem, UInt32 size, UInt32 dataSize=0)
void	readBufClear (void)
virtual void	read (MemoryHandle src, UInt32 size)
virtual void	readBuffer (void)
Write
BuffersT::iterator	writeBufBegin (void)
BuffersT::iterator	writeBufEnd (void)
void	writeBufAdd (MemoryHandle mem, UInt32 size, UInt32 dataSize=0)
void	writeBufClear (void)
virtual void	write (MemoryHandle src, UInt32 size)
virtual void	writeBuffer (void)
Helper
bool	isReadBufferEmpty (void)
Protected Attributes
Member
BuffersT	_readBuffers
BuffersT	_writeBuffers
BuffersT	_zeroCopyBuffers
UInt32	_zeroCopyThreshold
FreeMemT	_freeMem
BuffersT::iterator	_currentReadBuffer
UInt32	_currentReadBufferPos
BuffersT::iterator	_currentWriteBuffer
UInt32	_currentWriteBufferPos
bool	_networkOrder
Private Member Functions
	BinaryDataHandler (const BinaryDataHandler &source)
	prohibit default function (move to 'public' if needed)
void	operator= (const BinaryDataHandler &source)
	prohibit default function (move to 'public' if needed)
Internal Helper
void	pushBuffer (void)
void	pullBuffer (void)
void	freeMem (void)
Classes
struct	MemoryBlock
struct	ReadError
struct	WriteError

---

Detailed Description

Definition at line 60 of file OSGBinaryDataHandler.h.

---

Member Typedef Documentation

typedef std::vector<MemoryBlock> osg::BinaryDataHandler::BuffersT [protected]

Definition at line 213 of file OSGBinaryDataHandler.h.

typedef std::list<MemoryHandle> osg::BinaryDataHandler::FreeMemT [protected]

Definition at line 214 of file OSGBinaryDataHandler.h.

---

Constructor & Destructor Documentation

BinaryDataHandler::BinaryDataHandler	(	UInt32	zeroCopyThreshold = 0,
		bool	networkOrder = true
	)

Definition at line 57 of file OSGBinaryDataHandler.cpp.

                                                               :
    _readBuffers          (                 ),
    _writeBuffers         (                 ),
    _zeroCopyBuffers      (                 ),
    _zeroCopyThreshold    (zeroCopyThreshold),
    _freeMem              (                 ),
    _currentReadBuffer    (                 ),
    _currentReadBufferPos (0                ),
    _currentWriteBuffer   (                 ),
    _currentWriteBufferPos(0                ),
    _networkOrder         (networkOrder     )
{
}

BinaryDataHandler::~BinaryDataHandler

(

void

)

[virtual]

Definition at line 75 of file OSGBinaryDataHandler.cpp.

References freeMem().

{
    freeMem();
}

osg::BinaryDataHandler::BinaryDataHandler

(

const BinaryDataHandler &

source

)

[private]

---

Member Function Documentation

void BinaryDataHandler::put	(	void const *	src,
		UInt32	size
	)

Definition at line 83 of file OSGBinaryDataHandler.cpp.

References _currentWriteBuffer, _currentWriteBufferPos, _zeroCopyBuffers, _zeroCopyThreshold, osg::osgMin(), pushBuffer(), write(), and writeBufEnd().

Referenced by putAndFree(), putValue(), putValues(), and osg::ClusterViewBuffer::send().

{
    UInt8 const *data = static_cast<UInt8 const *>(src);

    if(_zeroCopyThreshold && size >= _zeroCopyThreshold)
    {
        if(_zeroCopyThreshold == 1)
        {
            write(const_cast<MemoryHandle>(data), size);
        }
        else
        {
            UInt8 tag = 1;

            // we have to write a tag, to indicate the membership
            // of this zero copy block to the current data block
            put(&tag, sizeof(tag));

            _zeroCopyBuffers.push_back(
                MemoryBlock(const_cast<MemoryHandle>(data), size, size));
        }
    }
    else
    {
        UInt32 copySize;

        while(size != 0)
        {
            if(_currentWriteBuffer == writeBufEnd())
            {
                pushBuffer();
            }

            copySize = osgMin((_currentWriteBuffer->getSize() -
                               _currentWriteBufferPos),
                              size);

            memcpy(_currentWriteBuffer->getMem() + _currentWriteBufferPos,
                    data,
                    copySize);

             size                  -= copySize;
            _currentWriteBufferPos += copySize;
             data                  += copySize;

            // skip to next buffer if current buffer is full
            if(_currentWriteBufferPos == _currentWriteBuffer->getSize())
            {
                _currentWriteBuffer->setDataSize(_currentWriteBufferPos);
                _currentWriteBuffer++;
                _currentWriteBufferPos = 0;
            }
        }
    }
}

void BinaryDataHandler::putAndFree	(	MemoryHandle	src,
		UInt32	size
	)

Put data from dynamic allocated block The caller doesn't know, when the block will be written. So we are responsible for freeing this block.

Definition at line 144 of file OSGBinaryDataHandler.cpp.

References _freeMem, _zeroCopyThreshold, and put().

{
    put(src, size);

    if(_zeroCopyThreshold && size > _zeroCopyThreshold)
    {
        _freeMem.push_back(src);
    }
    else
    {
        delete [] src;
    }
}

void osg::BinaryDataHandler::putValue

(

const bool &

value

)

[inline]

Definition at line 60 of file OSGBinaryDataHandler.inl.

References put().

Referenced by osg::SortFirstWindow::clientInit(), osg::ClusterNetwork::connectAllGroupToPoint(), osg::ClusterNetwork::connectAllPointToPoint(), osg::RenderNode::copyToBin(), osg::MField< FieldTypeT, fieldNameSpace >::copyToBin(), osg::BINWriter::doWriteIndexedFC(), osg::RemoteAspect::handleFCMapping(), osg::ClusterWindow::init(), putValue(), putValues(), osg::ClusterViewBuffer::send(), osg::RemoteAspect::sendSync(), osg::SortFirstWindow::serverInit(), osg::GroupMCastConnection::signal(), osg::ClusterServer::start(), and osg::BINWriter::writeFileHeader().

{
    // on Mac OS X a bool is four bytes long on all other
    // platfroms it is one byte long. So we write now always
    // one byte out.
    // put(&value, sizeof(bool));
    UInt8 temp = (UInt8) value;
    put(&temp, sizeof(UInt8));
}

void osg::BinaryDataHandler::putValue

(

const UInt8 &

value

)

[inline]

Definition at line 71 of file OSGBinaryDataHandler.inl.

References put().

{
    put(&value, sizeof(UInt8));
}

void osg::BinaryDataHandler::putValue

(

const UInt16 &

value

)

[inline]

Definition at line 77 of file OSGBinaryDataHandler.inl.

References osg::osghtons(), and put().

{
    UInt16 z = osghtons(value);

    put(&z, sizeof(UInt16));
}

void osg::BinaryDataHandler::putValue

(

const UInt32 &

value

)

[inline]

Definition at line 85 of file OSGBinaryDataHandler.inl.

References osg::osghtonl(), and put().

{
    UInt32 z = osghtonl(value);

    put(&z, sizeof(UInt32));
}

void osg::BinaryDataHandler::putValue

(

const UInt64 &

value

)

[inline]

Definition at line 93 of file OSGBinaryDataHandler.inl.

References osg::osghtonll(), and put().

{
    UInt64 z = osghtonll(value);

    put(&z, sizeof(UInt64));
}

void osg::BinaryDataHandler::putValue

(

const Int8 &

value

)

[inline]

Definition at line 101 of file OSGBinaryDataHandler.inl.

References put().

{
    put(&value, sizeof(Int8));
}

void osg::BinaryDataHandler::putValue

(

const Int16 &

value

)

[inline]

Definition at line 107 of file OSGBinaryDataHandler.inl.

References osg::osghtons(), and put().

{
    Int16 z = osghtons(value);

    put(&z, sizeof(Int16));
}

void osg::BinaryDataHandler::putValue

(

const Int32 &

value

)

[inline]

Definition at line 115 of file OSGBinaryDataHandler.inl.

References osg::osghtonl(), and put().

{
    Int32 z = osghtonl(value);

    put(&z, sizeof(Int32));
}

void osg::BinaryDataHandler::putValue

(

const Int64 &

value

)

[inline]

Definition at line 123 of file OSGBinaryDataHandler.inl.

References osg::osghtonll(), and put().

{
    Int64 z = osghtonll(value);
    put(&z, sizeof(Int64));

}

void osg::BinaryDataHandler::putValue

(

const Real16 &

value

)

[inline]

Definition at line 131 of file OSGBinaryDataHandler.inl.

References osg::Real16::bits(), osg::osghtons(), and put().

{
    UInt16 v = osghtons(value.bits());

    put(&v, sizeof(Real16));
}

void osg::BinaryDataHandler::putValue

(

const Real32 &

value

)

[inline]

Definition at line 139 of file OSGBinaryDataHandler.inl.

References osg::osghtonl(), and put().

{
    UInt32 v = osghtonl( *((const UInt32 *)(&value)) );

    put(&v, sizeof(Real32));
}

void osg::BinaryDataHandler::putValue

(

const Real64 &

value

)

[inline]

Definition at line 147 of file OSGBinaryDataHandler.inl.

References osg::osghtonll(), and put().

{
    UInt64 v = osghtonll( *((const UInt64 *)(&value)) );

    put(&v, sizeof(Real64));
}

void osg::BinaryDataHandler::putValue

(

const Real128 &

value

)

[inline]

Definition at line 155 of file OSGBinaryDataHandler.inl.

References osg::osghtonll(), and put().

{
    UInt64 v = osghtonll( *( (const UInt64 *)(&value)) );
    UInt64 w = osghtonll( *(((const UInt64 *)(&value)) + 1) );

#if BYTE_ORDER == LITTLE_ENDIAN
    put(&w, sizeof(UInt64));
    put(&v, sizeof(UInt64));
#else
    put(&v, sizeof(UInt64));
    put(&w, sizeof(UInt64));
#endif
}

void osg::BinaryDataHandler::putValue

(

const std::string &

value

)

[inline]

Definition at line 170 of file OSGBinaryDataHandler.inl.

References put(), putValue(), and osg::stringlen().

{
    UInt32 len = stringlen(value.c_str()) + 1;

    putValue(len);

    if(len != 0)
    {
        put(value.c_str(), len);
    }
}

void osg::BinaryDataHandler::putValues	(	const bool *	value,
		UInt32	size
	)			[inline]

Definition at line 184 of file OSGBinaryDataHandler.inl.

References putValue().

{
    for(UInt32 i = 0; i < size; ++i)
        putValue(value[i]);
}

void osg::BinaryDataHandler::putValues	(	const UInt8 *	value,
		UInt32	size
	)			[inline]

Definition at line 191 of file OSGBinaryDataHandler.inl.

References put().

{
    put(value, size * sizeof(UInt8));
}

void osg::BinaryDataHandler::putValues	(	const UInt16 *	value,
		UInt32	size
	)			[inline]

Definition at line 197 of file OSGBinaryDataHandler.inl.

References _networkOrder, put(), and putValue().

{
#if BYTE_ORDER == LITTLE_ENDIAN

    if(_networkOrder == true)
    {
        for(UInt32 i = 0; i < size; ++i)
        {
            putValue(value[i]);
        }
    }
    else
#endif
    {
        put(value, size * sizeof(UInt16));
    }
}

void osg::BinaryDataHandler::putValues	(	const UInt32 *	value,
		UInt32	size
	)			[inline]

Definition at line 216 of file OSGBinaryDataHandler.inl.

References _networkOrder, put(), and putValue().

{
#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        for(UInt32 i = 0; i < size; ++i)
        {
            putValue(value[i]);
        }
    }
    else
#endif
    {
        put(value, size * sizeof(UInt32));
    }
}

void osg::BinaryDataHandler::putValues	(	const UInt64 *	value,
		UInt32	size
	)			[inline]

Definition at line 234 of file OSGBinaryDataHandler.inl.

References _networkOrder, put(), and putValue().

{
#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        for(UInt32 i = 0; i < size; ++i)
        {
            putValue(value[i]);
        }
    }
    else
#endif
    {
        put(value, size * sizeof(UInt64));
    }
}

void osg::BinaryDataHandler::putValues	(	const Int8 *	value,
		UInt32	size
	)			[inline]

Definition at line 252 of file OSGBinaryDataHandler.inl.

References _networkOrder, put(), and putValue().

{
#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        for(UInt32 i = 0; i < size; ++i)
        {
            putValue(value[i]);
        }
    }
    else
#endif
    {
        put(value, size * sizeof(Int8));
    }
}

void osg::BinaryDataHandler::putValues	(	const Int16 *	value,
		UInt32	size
	)			[inline]

Definition at line 270 of file OSGBinaryDataHandler.inl.

References _networkOrder, put(), and putValue().

{
#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        for(UInt32 i = 0; i < size; ++i)
        {
            putValue(value[i]);
        }
    }
    else
#endif
    {
        put(value, size * sizeof(Int16));
    }
}

void osg::BinaryDataHandler::putValues	(	const Int32 *	value,
		UInt32	size
	)			[inline]

Definition at line 288 of file OSGBinaryDataHandler.inl.

References _networkOrder, put(), and putValue().

{
#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        for(UInt32 i = 0; i < size; ++i)
        {
            putValue(value[i]);
        }
    }
    else
#endif
    {
        put(value, size * sizeof(Int32));
    }
}

void osg::BinaryDataHandler::putValues	(	const Int64 *	value,
		UInt32	size
	)			[inline]

Definition at line 306 of file OSGBinaryDataHandler.inl.

References _networkOrder, put(), and putValue().

{
#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        for(UInt32 i = 0; i < size; ++i)
        {
            putValue(value[i]);
        }
    }
    else
#endif
    {
        put(value, size * sizeof(Int64));
    }
}

void osg::BinaryDataHandler::putValues	(	const Real16 *	value,
		UInt32	size
	)			[inline]

Definition at line 324 of file OSGBinaryDataHandler.inl.

References _networkOrder, put(), and putValue().

{
#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        for(UInt32 i = 0; i < size; ++i)
        {
            putValue(value[i]);
        }
    }
    else
#endif
    {
        put(value, size * sizeof(Real16));
    }
}

void osg::BinaryDataHandler::putValues	(	const Real32 *	value,
		UInt32	size
	)			[inline]

Definition at line 342 of file OSGBinaryDataHandler.inl.

References _networkOrder, put(), and putValue().

{
#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        for(UInt32 i = 0; i < size; ++i)
        {
            putValue(value[i]);
        }
    }
    else
#endif
    {
        put(value, size * sizeof(Real32));
    }
}

void osg::BinaryDataHandler::putValues	(	const Real64 *	value,
		UInt32	size
	)			[inline]

Definition at line 360 of file OSGBinaryDataHandler.inl.

References _networkOrder, put(), and putValue().

{
#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        for(UInt32 i = 0; i < size; ++i)
        {
            putValue(value[i]);
        }
    }
    else
#endif
    {
        put(value, size * sizeof(Real64));
    }
}

void osg::BinaryDataHandler::putValues	(	const Real128 *	value,
		UInt32	size
	)			[inline]

Definition at line 378 of file OSGBinaryDataHandler.inl.

References _networkOrder, put(), and putValue().

{
#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        for(UInt32 i = 0; i < size; ++i)
        {
            putValue(value[i]);
        }
    }
    else
#endif
    {
        put(value, size * sizeof(Real128));
    }
}

void osg::BinaryDataHandler::putValues	(	const std::string *	value,
		UInt32	size
	)			[inline]

Definition at line 396 of file OSGBinaryDataHandler.inl.

References putValue().

{
    for(UInt32 i = 0; i<size; ++i)
    {
        putValue(value[i]);    
    }
}

void BinaryDataHandler::get	(	void *	dst,
		UInt32	size
	)

Definition at line 161 of file OSGBinaryDataHandler.cpp.

References _currentReadBuffer, _currentReadBufferPos, _zeroCopyThreshold, osg::osgMin(), pullBuffer(), read(), and readBufEnd().

Referenced by osg::RemoteAspect::receiveSync(), and osg::ClusterViewBuffer::recv().

{
    MemoryHandle data = static_cast<MemoryHandle>(dst);

    if(_zeroCopyThreshold && size >= _zeroCopyThreshold)
    {
        if(_zeroCopyThreshold > 1)
        {
            UInt8 tag;

            // we have to read the tag, to force reading of data blocks
            // if the first data field was zero copied
            get(&tag, sizeof(tag));
        }

        // read direct into destination
        read(data, size);
    }
    else
    {
        UInt32 copySize;

        while(size != 0)
        {
            // read new data if nothing left
            if(_currentReadBuffer == readBufEnd())
            {
                pullBuffer();
            }

            // num bytes to copy
            copySize = osgMin((_currentReadBuffer->getDataSize() -
                               _currentReadBufferPos),
                              size);

            // no data in buffer ?
            if(copySize != 0)
            {
                memcpy( data,
                       _currentReadBuffer->getMem() + _currentReadBufferPos,
                        copySize);

                 size                 -= copySize;
                _currentReadBufferPos += copySize;
                 data                 += copySize;
            }

            // skip to next buffer if current buffer is full
            if(_currentReadBufferPos == _currentReadBuffer->getDataSize())
            {
                _currentReadBuffer++;
                _currentReadBufferPos = 0;
            }
        }
    }
}

void BinaryDataHandler::getAndAlloc	(	MemoryHandle &	src,
		UInt32	size
	)

read data in a dynamic allocated block

If data was compressed or converted then it is not possible to write it into the destination memory. BinaryDataHandler doesn't store data in continous memory areas. If the caller needs a continuous memory then we provide a dynamic allocated block. The caller is responsible to free this block.

Definition at line 227 of file OSGBinaryDataHandler.cpp.

{
    src = new UInt8[size];

    get(src, size);
}

void osg::BinaryDataHandler::getValue

(

bool &

value

)

[inline]

Definition at line 405 of file OSGBinaryDataHandler.inl.

Referenced by osg::BINLoader::chargeFieldContainers(), osg::SortFirstWindow::clientInit(), osg::ClusterNetwork::connectAllGroupToPoint(), osg::ClusterNetwork::connectAllPointToPoint(), osg::RenderNode::copyFromBin(), osg::MField< FieldTypeT, fieldNameSpace >::copyFromBin(), osg::BINLoader::createFieldContainers(), getValue(), getValues(), osg::ClusterWindow::init(), osg::RemoteAspect::receiveSync(), osg::ClusterViewBuffer::recv(), osg::SortFirstWindow::serverInit(), osg::ClusterServer::start(), and osg::PointMCastConnection::wait().

{
    //get(&value, sizeof(bool));
    UInt8 temp;
    get(&temp, sizeof(UInt8));
    value = (temp!=0);
}

void osg::BinaryDataHandler::getValue

(

UInt8 &

value

)

[inline]

Definition at line 414 of file OSGBinaryDataHandler.inl.

{
    get(&value, sizeof(UInt8));
}

void osg::BinaryDataHandler::getValue

(

UInt16 &

value

)

[inline]

Definition at line 420 of file OSGBinaryDataHandler.inl.

References osg::osgntohs().

{
    get(&value, sizeof(UInt16));

    value = osgntohs(value);
}

void osg::BinaryDataHandler::getValue

(

UInt32 &

value

)

[inline]

Definition at line 428 of file OSGBinaryDataHandler.inl.

References osg::osgntohl().

{
    get(&value, sizeof(UInt32));

    value = osgntohl(value);
}

void osg::BinaryDataHandler::getValue

(

UInt64 &

value

)

[inline]

Definition at line 436 of file OSGBinaryDataHandler.inl.

References osg::osgntohll().

{
    get(&value, sizeof(UInt64));

    value = osgntohll(value);
}

void osg::BinaryDataHandler::getValue

(

Int8 &

value

)

[inline]

Definition at line 444 of file OSGBinaryDataHandler.inl.

{
    get(&value, sizeof(Int8));
}

void osg::BinaryDataHandler::getValue

(

Int16 &

value

)

[inline]

Definition at line 450 of file OSGBinaryDataHandler.inl.

References osg::osgntohs().

{
    get(&value, sizeof(Int16));

    value = osgntohs(value);
}

void osg::BinaryDataHandler::getValue

(

Int32 &

value

)

[inline]

Definition at line 458 of file OSGBinaryDataHandler.inl.

References osg::osgntohl().

{
    get(&value, sizeof(Int32));

    value = osgntohl(value);
}

void osg::BinaryDataHandler::getValue

(

Int64 &

value

)

[inline]

Definition at line 466 of file OSGBinaryDataHandler.inl.

References osg::osgntohll().

{
    get(&value, sizeof(Int64));

    value = osgntohll(value);
}

void osg::BinaryDataHandler::getValue

(

Real16 &

value

)

[inline]

Definition at line 474 of file OSGBinaryDataHandler.inl.

References osg::osgntohs(), and osg::Real16::setBits().

{
    UInt16 v;

    get(&v, sizeof(Real16));

    v     = osgntohs(v);
    value.setBits(v);
}

void osg::BinaryDataHandler::getValue

(

Real32 &

value

)

[inline]

Definition at line 485 of file OSGBinaryDataHandler.inl.

References osg::osgntohf(), and osg::osgntohl().

{
    get(&value, sizeof(Real32));

    value = osgntohf(value);

#if 0
    // doesn't work on my 64 bit linux ...
    UInt32 v;

    get(&v, sizeof(Real32));

    v     = osgntohl(v);
    value = *(reinterpret_cast<Real32 *>(&v));
#endif
}

void osg::BinaryDataHandler::getValue

(

Real64 &

value

)

[inline]

Definition at line 503 of file OSGBinaryDataHandler.inl.

References osg::osgntohd(), and osg::osgntohll().

{
    get(&value, sizeof(Real64));

    value = osgntohd(value);

#if 0
    UInt64 v;

    get(&v, sizeof(Real64));

    v     = osgntohll(v);
    value = *(reinterpret_cast<Real64 *>(&v));
#endif
}

void osg::BinaryDataHandler::getValue

(

Real128 &

value

)

[inline]

Definition at line 520 of file OSGBinaryDataHandler.inl.

References osg::osgntohdd(), and osg::osgntohll().

{
    get(&value, sizeof(Real128));

    value = osgntohdd(value);

#if 0
    UInt64 v[2];

#if BYTE_ORDER == LITTLE_ENDIAN
    get(&v[1], sizeof(UInt64));
    get(&v[0], sizeof(UInt64));
#else
    get(&v[0], sizeof(UInt64));
    get(&v[1], sizeof(UInt64));
#endif

    v[0]     = osgntohll(v[0]);
    v[1]     = osgntohll(v[1]);
    value = *(reinterpret_cast<Real128 *>(&v));
#endif
}

void osg::BinaryDataHandler::getValue

(

std::string &

value

)

[inline]

Definition at line 544 of file OSGBinaryDataHandler.inl.

References getValue().

{
    UInt32  len;
    Char8  *str = NULL;

    getValue(len);

    if(len != 0)
    {
        str = new Char8[len];
        
        get(str, len);

        value = str;
        
        delete [] str;
    }
    else
    {
        value.erase();
    }
}

void osg::BinaryDataHandler::getValues	(	bool *	value,
		UInt32	size
	)			[inline]

Definition at line 568 of file OSGBinaryDataHandler.inl.

References getValue().

{
    for(UInt32 i = 0; i < size; ++i)
        getValue(value[i]);
}

void osg::BinaryDataHandler::getValues	(	UInt8 *	value,
		UInt32	size
	)			[inline]

Definition at line 575 of file OSGBinaryDataHandler.inl.

{
    get(value, size * sizeof(UInt8));
}

void osg::BinaryDataHandler::getValues	(	UInt16 *	value,
		UInt32	size
	)			[inline]

Definition at line 581 of file OSGBinaryDataHandler.inl.

References _networkOrder, and osg::osgntohs().

{
    get(value, size * sizeof(UInt16));

#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        for(UInt32 i = 0; i < size; ++i)
        {
            value[i] = osgntohs(value[i]);
        }
    }
#endif
}

void osg::BinaryDataHandler::getValues	(	UInt32 *	value,
		UInt32	size
	)			[inline]

Definition at line 597 of file OSGBinaryDataHandler.inl.

References _networkOrder, and osg::osgntohl().

{
    get(value, size * sizeof(UInt32));

#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        for(UInt32 i = 0; i < size; ++i)
        {
            value[i] = osgntohl(value[i]);
        }
    }
#endif
}

void osg::BinaryDataHandler::getValues	(	UInt64 *	value,
		UInt32	size
	)			[inline]

Definition at line 613 of file OSGBinaryDataHandler.inl.

References _networkOrder, and osg::osgntohll().

{
    get(value, size * sizeof(UInt64));

#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        for(UInt32 i = 0; i < size; ++i)
        {
            value[i] = osgntohll(value[i]);
        }
    }
#endif
}

void osg::BinaryDataHandler::getValues	(	Int8 *	value,
		UInt32	size
	)			[inline]

Definition at line 629 of file OSGBinaryDataHandler.inl.

{
    get(value, size * sizeof(Int8));
}

void osg::BinaryDataHandler::getValues	(	Int16 *	value,
		UInt32	size
	)			[inline]

Definition at line 635 of file OSGBinaryDataHandler.inl.

References _networkOrder, and osg::osgntohs().

{
    get(value, size * sizeof(Int16));

#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        for(UInt32 i = 0; i < size; ++i)
        {
            value[i] = osgntohs(value[i]);
        }
    }
#endif
}

void osg::BinaryDataHandler::getValues	(	Int32 *	value,
		UInt32	size
	)			[inline]

Definition at line 651 of file OSGBinaryDataHandler.inl.

References _networkOrder, and osg::osgntohl().

{
    get(value, size * sizeof(Int32));

#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        for(UInt32 i = 0; i < size; ++i)
        {
            value[i] = osgntohl(value[i]);
        }
    }
#endif
}

void osg::BinaryDataHandler::getValues	(	Int64 *	value,
		UInt32	size
	)			[inline]

Definition at line 667 of file OSGBinaryDataHandler.inl.

References _networkOrder, and osg::osgntohll().

{
    get(value, size * sizeof(Int64));

#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        for(UInt32 i = 0; i < size; ++i)
        {
            value[i] = osgntohll(value[i]);
        }
    }
#endif
}

void osg::BinaryDataHandler::getValues	(	Real16 *	value,
		UInt32	size
	)			[inline]

Definition at line 683 of file OSGBinaryDataHandler.inl.

References _networkOrder, osg::osgntohs(), and osg::Real16::setBits().

{
    get(value, size * sizeof(Real16));

#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        UInt16 *intValue = reinterpret_cast<UInt16 *>(value);

        for(UInt32 i = 0; i < size; ++i)
        {
            value[i].setBits(osgntohs(intValue[i]));
        }
    }
#endif
}

void osg::BinaryDataHandler::getValues	(	Real32 *	value,
		UInt32	size
	)			[inline]

Definition at line 701 of file OSGBinaryDataHandler.inl.

References _networkOrder, and osg::osgntohl().

{
    get(value, size * sizeof(Real32));

#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        UInt32 *intValue = reinterpret_cast<UInt32 *>(value);

        for(UInt32 i = 0; i < size; ++i)
        {
            intValue[i] = osgntohl(intValue[i]);
        }
    }
#endif
}

void osg::BinaryDataHandler::getValues	(	Real64 *	value,
		UInt32	size
	)			[inline]

Definition at line 719 of file OSGBinaryDataHandler.inl.

References _networkOrder, and osg::osgntohll().

{
    get(value, size * sizeof(Real64));

#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        UInt64 *longValue = reinterpret_cast<UInt64 *>(value);

        for(UInt32 i = 0; i < size; ++i)
        {
            longValue[i] = osgntohll(longValue[i]);
        }
    }
#endif
}

void osg::BinaryDataHandler::getValues	(	Real128 *	value,
		UInt32	size
	)			[inline]

Definition at line 737 of file OSGBinaryDataHandler.inl.

References _networkOrder, and osg::osgntohll().

{
    get(value, size * sizeof(UInt64) * 2);

#if BYTE_ORDER == LITTLE_ENDIAN
    if(_networkOrder == true)
    {
        UInt64 *longValue = reinterpret_cast<UInt64 *>(value);

        for(UInt32 i = 0; i < size; i += 2)
        {
            UInt64 l = longValue[i];
            longValue[i]     = osgntohll(longValue[i + 1]);
            longValue[i + 1] = osgntohll(longValue[l    ]);
        }
    }
#endif
}

void osg::BinaryDataHandler::getValues	(	std::string *	value,
		UInt32	size
	)			[inline]

Definition at line 757 of file OSGBinaryDataHandler.inl.

References getValue().

{
    for(UInt32 i = 0; i < size; ++i)
    {
        getValue(value[i]);
    }
}

void BinaryDataHandler::forceCopy

(

void

)

[virtual]

always copy memory blocks befor write forceCopy must be called for all endpoints of this connection

Definition at line 260 of file OSGBinaryDataHandler.cpp.

References _zeroCopyThreshold.

{
    _zeroCopyThreshold = 0;
}

void BinaryDataHandler::forceDirectIO

(

void

)

[virtual]

always read or write directly into or from memory blocks forceDirectIO must be called for all endpoints of this connection

Definition at line 268 of file OSGBinaryDataHandler.cpp.

References _zeroCopyThreshold.

{
    _zeroCopyThreshold = 1;
}

void BinaryDataHandler::flush

(

void

)

Definition at line 239 of file OSGBinaryDataHandler.cpp.

References _currentWriteBuffer, _currentWriteBufferPos, pushBuffer(), and writeBufEnd().

Referenced by osg::SortFirstWindow::clientInit(), osg::ClusterNetwork::connectAllGroupToPoint(), osg::ClusterNetwork::connectAllPointToPoint(), osg::ClusterWindow::init(), osg::ClusterViewBuffer::send(), osg::RemoteAspect::sendSync(), osg::SortFirstWindow::serverInit(), osg::GroupMCastConnection::signal(), osg::ClusterServer::start(), and osg::BINWriter::write().

{
    if(_currentWriteBuffer != writeBufEnd())
    {
        // mark rest of buffer as empty
        _currentWriteBuffer->setDataSize(_currentWriteBufferPos);
        _currentWriteBuffer++;

        while(_currentWriteBuffer != writeBufEnd())
        {
            _currentWriteBuffer->setDataSize(0);
            _currentWriteBuffer++;
        }
    }

    pushBuffer();
}

void BinaryDataHandler::setNetworkOrder

(

bool

value

)

always copy memory blocks befor write forceCopy must be called for all endpoints of this connection

Definition at line 277 of file OSGBinaryDataHandler.cpp.

References _networkOrder.

Referenced by osg::ClusterWindow::init(), and osg::ClusterServer::start().

{
    _networkOrder = value;    
}

bool BinaryDataHandler::getNetworkOrder

(

void

)

always copy memory blocks befor write forceCopy must be called for all endpoints of this connection

Definition at line 282 of file OSGBinaryDataHandler.cpp.

References _networkOrder.

{
    return _networkOrder;
}

BinaryDataHandler::BuffersT::iterator osg::BinaryDataHandler::readBufBegin

(

void

)

[inline, protected]

Definition at line 812 of file OSGBinaryDataHandler.inl.

References _readBuffers.

Referenced by pullBuffer(), osg::PointSockPipeline::readBuffer(), osg::PointSockConnection::readBuffer(), osg::PointMCastConnection::readBuffer(), osg::GroupSockConnection::readBuffer(), and readBuffer().

{
    return _readBuffers.begin();
}

BinaryDataHandler::BuffersT::iterator osg::BinaryDataHandler::readBufEnd

(

void

)

[inline, protected]

Definition at line 818 of file OSGBinaryDataHandler.inl.

References _readBuffers.

Referenced by get(), isReadBufferEmpty(), readBufAdd(), readBufClear(), readBuffer(), and osg::GroupSockConnection::selectChannel().

{
    return _readBuffers.end();
}

void BinaryDataHandler::readBufAdd	(	MemoryHandle	mem,
		UInt32	size,
		UInt32	dataSize = 0
	)			[protected]

Definition at line 290 of file OSGBinaryDataHandler.cpp.

References _currentReadBuffer, _readBuffers, and readBufEnd().

Referenced by osg::BINLoader::BinaryFileHandler::BinaryFileHandler(), osg::GroupSockConnection::GroupSockConnection(), osg::PointSockConnection::PointSockConnection(), and osg::GroupSockConnection::setParams().

{
    MemoryBlock memBlock(mem, size, dataSize);

    _readBuffers.push_back(memBlock);

    _currentReadBuffer = readBufEnd();
}

void BinaryDataHandler::readBufClear

(

void

)

[protected]

Definition at line 301 of file OSGBinaryDataHandler.cpp.

References _currentReadBuffer, _readBuffers, and readBufEnd().

Referenced by osg::GroupSockConnection::setParams().

{
    _readBuffers.clear();

    _currentReadBuffer=readBufEnd();
}

void BinaryDataHandler::read	(	MemoryHandle	src,
		UInt32	size
	)			[protected, virtual]

direct buffer read, write data into given buffer

Reimplemented in osg::GroupSockConnection, osg::PointMCastConnection, osg::PointSockConnection, osg::PointSockPipeline, and osg::BINLoader::BinaryFileHandler.

Definition at line 389 of file OSGBinaryDataHandler.cpp.

References SWARNING.

Referenced by get(), and readBuffer().

{
    SWARNING << "BinaryDataHandler::read(MemoryHandle src,int size) called" 
             << std::endl;
}

void BinaryDataHandler::readBuffer

(

void

)

[protected, virtual]

default buffer read

Use direct read to implement buffer read. First read buffer size and then read rest of buffer

Returns:

buffer iterator points behind the last buffer containing data

Reimplemented in osg::GroupSockConnection, osg::PointMCastConnection, osg::PointSockConnection, and osg::PointSockPipeline.

Definition at line 346 of file OSGBinaryDataHandler.cpp.

References osg::osgMin(), osg::osgntohl(), read(), readBufBegin(), readBufEnd(), and SFATAL.

Referenced by pullBuffer().

{
    BuffersT::iterator i;
    UInt32             size,nsize;
    UInt32             readSize;

    // read buffer size
    read((MemoryHandle) &nsize, sizeof(UInt32));
    size = osgntohl(nsize);

    // read rest of buffer
    for(i = readBufBegin(); size != 0; ++i)
    {
        if(i == readBufEnd())
        {
            SFATAL << "Read buffer is to small. " << size
                   << "bytes missing" << std::endl;

            throw ReadError("Read buffer to small for whole block");
        }

        readSize = osgMin(size, i->getSize());

        read(i->getMem(), readSize);

        i->setDataSize(readSize);

        size -= readSize;
    }

    for(; i != readBufEnd(); ++i)
    {
        i->setDataSize(0);
    }
}

BinaryDataHandler::BuffersT::iterator osg::BinaryDataHandler::writeBufBegin

(

void

)

[inline, protected]

Definition at line 824 of file OSGBinaryDataHandler.inl.

References _writeBuffers.

Referenced by pushBuffer(), writeBufAdd(), osg::PointSockConnection::writeBuffer(), osg::GroupSockPipeline::writeBuffer(), osg::GroupSockConnection::writeBuffer(), osg::GroupMCastConnection::writeBuffer(), and writeBuffer().

{
    return _writeBuffers.begin();
}

BinaryDataHandler::BuffersT::iterator osg::BinaryDataHandler::writeBufEnd

(

void

)

[inline, protected]

Definition at line 830 of file OSGBinaryDataHandler.inl.

References _writeBuffers.

Referenced by flush(), put(), writeBufClear(), and writeBuffer().

{
    return _writeBuffers.end();
}

void BinaryDataHandler::writeBufAdd	(	MemoryHandle	mem,
		UInt32	size,
		UInt32	dataSize = 0
	)			[protected]

Definition at line 311 of file OSGBinaryDataHandler.cpp.

References _currentWriteBuffer, _currentWriteBufferPos, _writeBuffers, and writeBufBegin().

Referenced by osg::BINWriter::BinaryFileHandler::BinaryFileHandler(), osg::GroupSockConnection::GroupSockConnection(), osg::PointSockConnection::PointSockConnection(), and osg::GroupSockConnection::setParams().

{
    MemoryBlock memBlock(mem, size, dataSize);

    _writeBuffers.push_back(memBlock);

    _currentWriteBuffer    = writeBufBegin();
    _currentWriteBufferPos = 0;
}

void BinaryDataHandler::writeBufClear

(

void

)

[protected]

Definition at line 323 of file OSGBinaryDataHandler.cpp.

References _currentWriteBuffer, _writeBuffers, and writeBufEnd().

Referenced by osg::GroupSockConnection::setParams().

{
    _writeBuffers.clear();

    _currentWriteBuffer = writeBufEnd();
}

void BinaryDataHandler::write	(	MemoryHandle	src,
		UInt32	size
	)			[protected, virtual]

direct buffer write, write data into given buffer

Reimplemented in osg::GroupMCastConnection, osg::GroupSockConnection, osg::GroupSockPipeline, osg::PointSockConnection, and osg::BINWriter::BinaryFileHandler.

Definition at line 446 of file OSGBinaryDataHandler.cpp.

References SWARNING.

Referenced by pushBuffer(), put(), and writeBuffer().

{
    SWARNING << "BinaryDataHandler::write(MemoryHandle mem,int size) called" 
             << std::endl;
}

void BinaryDataHandler::writeBuffer

(

void

)

[protected, virtual]

default buffer write, use direct write to implement buffer write.

Reimplemented in osg::GroupMCastConnection, osg::GroupSockConnection, osg::GroupSockPipeline, and osg::PointSockConnection.

Definition at line 402 of file OSGBinaryDataHandler.cpp.

References osg::osghtonl(), write(), writeBufBegin(), and writeBufEnd().

Referenced by pushBuffer().

{
    BuffersT::iterator i;
    UInt32             size = 0;
    UInt32             nsize;

    // calculate blocksize
    for(i = writeBufBegin(); i != writeBufEnd(); ++i)
    {
        size += i->getDataSize();
    }

    // write buffer size
    nsize = osghtonl(size);

    write((MemoryHandle) &nsize, sizeof(UInt32));

    // write buffers
    for(i = writeBufBegin(); i != writeBufEnd(); ++i)
    {
        if(i->getDataSize() != 0)
        {
            write(i->getMem(), i->getDataSize());
        }
    }
}

bool BinaryDataHandler::isReadBufferEmpty

(

void

)

[protected]

check for data in read buffer

Definition at line 431 of file OSGBinaryDataHandler.cpp.

References _currentReadBuffer, _zeroCopyThreshold, and readBufEnd().

Referenced by osg::PointMCastConnection::selectChannel().

{
    if(_zeroCopyThreshold == 1)
        return true;
    if(_currentReadBuffer == readBufEnd())
        return true;
    return false;
}

void BinaryDataHandler::pushBuffer

(

void

)

[private]

Definition at line 454 of file OSGBinaryDataHandler.cpp.

References _currentWriteBuffer, _currentWriteBufferPos, _zeroCopyBuffers, freeMem(), write(), writeBufBegin(), and writeBuffer().

Referenced by flush(), and put().

{
    BuffersT::iterator i;

    writeBuffer();

    // direct write zero copy buffers
    for(  i  = _zeroCopyBuffers.begin();
          i != _zeroCopyBuffers.end  ();
        ++i)
    {
        write(i->getMem(), i->getDataSize());
    }

    _zeroCopyBuffers.clear();

    // remove buffers given with getAndFree
    freeMem();

    // reset buffer pos
    _currentWriteBuffer    = writeBufBegin();
    _currentWriteBufferPos = 0;

    _currentWriteBuffer->setDataSize(0);
}

void BinaryDataHandler::pullBuffer

(

void

)

[private]

Definition at line 480 of file OSGBinaryDataHandler.cpp.

References _currentReadBuffer, _currentReadBufferPos, readBufBegin(), and readBuffer().

Referenced by get().

{
    readBuffer();

    _currentReadBuffer    = readBufBegin();
    _currentReadBufferPos = 0;
}

void BinaryDataHandler::freeMem

(

void

)

[private]

Definition at line 488 of file OSGBinaryDataHandler.cpp.

References _freeMem.

Referenced by pushBuffer(), and ~BinaryDataHandler().

{
    for(FreeMemT::iterator i= _freeMem.begin(); i!= _freeMem.end(); ++i)
    {
        delete [] *i;
    }

    _freeMem.clear();
}

void osg::BinaryDataHandler::operator=

(

const BinaryDataHandler &

source

)

[private]

---

Member Data Documentation

BuffersT osg::BinaryDataHandler::_readBuffers [protected]

Definition at line 220 of file OSGBinaryDataHandler.h.

Referenced by readBufAdd(), readBufBegin(), readBufClear(), and readBufEnd().

BuffersT osg::BinaryDataHandler::_writeBuffers [protected]

Definition at line 221 of file OSGBinaryDataHandler.h.

Referenced by writeBufAdd(), writeBufBegin(), writeBufClear(), and writeBufEnd().

BuffersT osg::BinaryDataHandler::_zeroCopyBuffers [protected]

Definition at line 222 of file OSGBinaryDataHandler.h.

Referenced by pushBuffer(), and put().

UInt32 osg::BinaryDataHandler::_zeroCopyThreshold [protected]

Definition at line 223 of file OSGBinaryDataHandler.h.

Referenced by forceCopy(), forceDirectIO(), get(), isReadBufferEmpty(), put(), putAndFree(), and osg::GroupSockConnection::selectChannel().

FreeMemT osg::BinaryDataHandler::_freeMem [protected]

Definition at line 225 of file OSGBinaryDataHandler.h.

Referenced by freeMem(), and putAndFree().

BuffersT::iterator osg::BinaryDataHandler::_currentReadBuffer [protected]

Definition at line 226 of file OSGBinaryDataHandler.h.

Referenced by get(), isReadBufferEmpty(), pullBuffer(), readBufAdd(), readBufClear(), and osg::GroupSockConnection::selectChannel().

UInt32 osg::BinaryDataHandler::_currentReadBufferPos [protected]

Definition at line 227 of file OSGBinaryDataHandler.h.

Referenced by get(), and pullBuffer().

BuffersT::iterator osg::BinaryDataHandler::_currentWriteBuffer [protected]

Definition at line 228 of file OSGBinaryDataHandler.h.

Referenced by flush(), pushBuffer(), put(), writeBufAdd(), and writeBufClear().

UInt32 osg::BinaryDataHandler::_currentWriteBufferPos [protected]

Definition at line 229 of file OSGBinaryDataHandler.h.

Referenced by flush(), pushBuffer(), put(), and writeBufAdd().

bool osg::BinaryDataHandler::_networkOrder [protected]

Definition at line 231 of file OSGBinaryDataHandler.h.

Referenced by getNetworkOrder(), getValues(), putValues(), and setNetworkOrder().

---

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

• OSGBinaryDataHandler.h
• OSGBinaryDataHandler.cpp
• OSGBinaryDataHandler.inl