#include <GaudiKernel/StreamBuffer.h>

Collaboration diagram for StreamBuffer:

[legend]

Classes
class	ContainedLink
	Definition of the contained link set. More...

class	DataIO
	A small base class to handle generic data streaming. More...

class	IdentifiedLink
	Definition of the contained link set. More...

class	Istream
	Reader for standard input streams. More...

class	Ostream
	Writer for standard output streams. More...

Public Types
enum	Mode { UNINITIALIZED, READING, WRITING }
	Streamer mode. More...

enum	SwapAction { SINGLE_BYTE, SWAP, NOSWAP }
	Data Sawp actions. More...

enum	State { INVALID = -1, VALID }
	Link state defintions. More...

typedef std::vector< ContainedLink >	ContainedLinks

typedef std::vector< IdentifiedLink >	IdentifiedLinks
	Definition of the identifiable link set. More...

typedef void(*	AnalyzeFunction) (const void *data, int siz, const std::type_info &type)
	Definition of the buffer analyzer. More...

Public Member Functions
	StreamBuffer (bool do_swap=true)
	Standard constructor. More...

virtual	~StreamBuffer ()
	Standard destructor. More...

const char *	data () const
	Read access to data buffer. More...

char *	data ()
	write access to data buffer More...

void	erase ()
	Reset the buffer. More...

char *	adopt () const
	Remove the data buffer and pass it to client. It's the client responsability to free the memory. More...

void	reserve (long len)
	Reserve buffer space; Default: 16 k buffer size. More...

void	extend (long len)
	Extend the buffer. More...

long	size () const
	Total buffer size. More...

ContainedLinks &	containedLinks ()
	Access to contained links. More...

const ContainedLinks &	containedLinks () const
	CONST Access to contained links. More...

IdentifiedLinks &	identifiedLinks ()
	Access to identified links. More...

const IdentifiedLinks &	identifiedLinks () const
	CONST Access to identified links. More...

void	setMode (Mode m)
	Set mode of the stream and allocate buffer. More...

bool	isReading () const
	Get stream buffer state. More...

bool	isWriting () const
	Get stream buffer state. More...

long	buffPointer () const
	Retrieve current buffer pointer. More...

void	setBuffPointer (long ptr)
	Retrieve current buffer pointer. More...

void	setAnalyzer (AnalyzeFunction fun=nullptr)
	Enable user analysis function. More...

void	swapToBuffer (const void *source, int siz)
	Swap buffers: int, long, short, float and double. More...

void	swapFromBuffer (void *target, int siz)
	Swap buffers: int, long, short, float and double. More...

StreamBuffer &	writeBytes (const char *str, long len)
	Write string to output stream. More...

void	getIdentifiedLink (DataObject *&pObject, long &hint)

void	addIdentifiedLink (const DataObject *pObject, long hint)

void	getContainedLink (ContainedObject *&pObject, long &hint, long &link)

void	addContainedLink (const ContainedObject *pObject, long hint, long link)

StreamBuffer &	operator<< (long long data)
	Output Streamer. More...

StreamBuffer &	operator>> (long long &data)
	Input Streamer. More...

StreamBuffer &	operator<< (int data)
	Output Streamer. More...

StreamBuffer &	operator>> (int &data)
	Input Streamer. More...

StreamBuffer &	operator<< (unsigned int data)
	Output Streamer. More...

StreamBuffer &	operator>> (unsigned int &data)
	Input Streamer. More...

StreamBuffer &	operator<< (long data)
	Output Streamer. More...

StreamBuffer &	operator>> (long &data)
	Input Streamer. More...

StreamBuffer &	operator<< (unsigned long data)
	Output Streamer. More...

StreamBuffer &	operator>> (unsigned long &data)
	Input Streamer. More...

StreamBuffer &	operator<< (short data)
	Output Streamer. More...

StreamBuffer &	operator>> (short &data)
	Input Streamer. More...

StreamBuffer &	operator<< (unsigned short data)
	Output Streamer. More...

StreamBuffer &	operator>> (unsigned short &data)
	Input Streamer. More...

StreamBuffer &	operator<< (char data)
	Output Streamer. More...

StreamBuffer &	operator>> (char &data)
	Input Streamer. More...

StreamBuffer &	operator<< (unsigned char data)
	Output Streamer. More...

StreamBuffer &	operator>> (unsigned char &data)
	Input Streamer. More...

StreamBuffer &	operator<< (float data)
	Output Streamer. More...

StreamBuffer &	operator>> (float &data)
	Input Streamer. More...

StreamBuffer &	operator<< (double data)
	Output Streamer. More...

StreamBuffer &	operator>> (double &data)
	Input Streamer. More...

StreamBuffer &	operator>> (char *data)
	Streamer to read strings in (char*) format. More...

StreamBuffer &	operator<< (const char *data)
	Streamer to write strings in (char*) format. More...

StreamBuffer &	operator>> (std::string &data)
	Streamer to read strings in (std::string) format. More...

StreamBuffer &	operator<< (const std::string &data)
	Streamer to write strings in (std::string) format. More...

template<class TYPE >
StreamBuffer &	operator>> (TYPE *&refpObject)
	Streamer to read links to contained or identified objects. More...

StreamBuffer &	operator<< (const ContainedObject *pObject)
	Streamer to write links to contained objects. More...

StreamBuffer &	operator<< (const DataObject *pObject)
	Streamer to write links to identified objects. More...

void	serialize (DataIO &ioObject)
	Serialize the buffer using an IO object. More...

Protected Member Functions
SwapAction	swapBuffer (int siz) const
	Check for byte swapping. More...

template<class TYPE >
StreamBuffer &	getObjectPointer (const DataObject , TYPE &refpObject)
	Helper to distinguish between identified pointers and contained pointers. More...

template<class TYPE >
StreamBuffer &	getObjectPointer (const ContainedObject , TYPE &refpObject)
	Helper to distinguish between identified pointers and contained pointers. More...

Protected Attributes
Mode	m_mode = UNINITIALIZED
	Boolean indicating wether the stream is in read or write mode. More...

long	m_pointer = 0
	Current buffer pointer. More...

long	m_length = 0
	Total buffer length. More...

char *	m_buffer = nullptr
	Pointer to heap buffer. More...

bool	m_swapEnabled = true
	Flag indicating swapping. More...

ContainedLinks	m_containedLinks
	Container with links to contained objects. More...

IdentifiedLinks	m_identifiedLinks
	Container with links to contained objects. More...

AnalyzeFunction	m_analyzer = nullptr
	Hook function for analysis of data to the stream. More...

Friends
class	DataObject
	DataObject is friend. More...

Detailed Description

The stream buffer is a small object collecting object data. The basic idea behind the StreamBuffer is generic object conversion. The StreamBuffer acts as a byte stream (hence inheriting from a std::string: DP: this is not true anymore and it is not a bad thing in my opinion) and stores any information streamed to the buffer. Since the information must be represented in a generic way on the fly byte swapping is performed. However, not only primitive data can be stored in the buffer, but also pointers to DataObjects (symbolic links) and pointers to contained objects. Automatically during serialization the persistent references to the corresponding objects and containers must be stored. These objects are accessible from the StreamBuffer object.

"On the fly" data conversion to non persistent

Author: M.Frank

Definition at line 47 of file StreamBuffer.h.

Member Typedef Documentation

◆ AnalyzeFunction

typedef void( * StreamBuffer::AnalyzeFunction) (const void *data, int siz, const std::type_info &type)

Definition of the buffer analyzer.

Definition at line 144 of file StreamBuffer.h.

◆ ContainedLinks

typedef std::vector<ContainedLink> StreamBuffer::ContainedLinks

Definition at line 140 of file StreamBuffer.h.

◆ IdentifiedLinks

typedef std::vector<IdentifiedLink> StreamBuffer::IdentifiedLinks

Definition of the identifiable link set.

Definition at line 142 of file StreamBuffer.h.

Member Enumeration Documentation

◆ Mode

enum StreamBuffer::Mode

Streamer mode.

Enumerator
UNINITIALIZED
READING
WRITING

Definition at line 113 of file StreamBuffer.h.

113 { UNINITIALIZED, READING, WRITING };

◆ State

enum StreamBuffer::State

Link state defintions.

Enumerator
INVALID
VALID

Definition at line 117 of file StreamBuffer.h.

117 { INVALID = -1, VALID };

◆ SwapAction

enum StreamBuffer::SwapAction

Data Sawp actions.

Enumerator
SINGLE_BYTE
SWAP
NOSWAP

Definition at line 115 of file StreamBuffer.h.

115 { SINGLE_BYTE, SWAP, NOSWAP };

Constructor & Destructor Documentation

◆ StreamBuffer()

StreamBuffer::StreamBuffer ( bool do_swap = true )

inline

Standard constructor.

Definition at line 201 of file StreamBuffer.h.

201 : m_swapEnabled( do_swap ) {}

◆ ~StreamBuffer()

virtual StreamBuffer::~StreamBuffer ( )

inlinevirtual

Standard destructor.

Definition at line 203 of file StreamBuffer.h.

203 { ::free( m_buffer ); }

Member Function Documentation

◆ addContainedLink()

void StreamBuffer::addContainedLink	(	const ContainedObject *	pObject,
		long	hint,
		long	link
	)

inline

Definition at line 300 of file StreamBuffer.h.

                                                                                 {
     m_containedLinks.push_back( ContainedLink( (ContainedObject*)pObject, hint, link ) );
   }

◆ addIdentifiedLink()

void StreamBuffer::addIdentifiedLink	(	const DataObject *	pObject,
		long	hint
	)

inline

Definition at line 289 of file StreamBuffer.h.

                                                                  {
     m_identifiedLinks.push_back( IdentifiedLink( (DataObject*)pObject, hint ) );
   }

◆ adopt()

char* StreamBuffer::adopt ( ) const

inline

Remove the data buffer and pass it to client. It's the client responsability to free the memory.

Definition at line 211 of file StreamBuffer.h.

                       {
     char* ptr = m_buffer;
     m_containedLinks.erase( m_containedLinks.begin(), m_containedLinks.end() );
     m_identifiedLinks.erase( m_identifiedLinks.begin(), m_identifiedLinks.end() );
     m_buffer  = NULL; // char *
     m_pointer = 0;    // long
     m_length  = 0;    // long
     return ptr;
   }

◆ buffPointer()

long StreamBuffer::buffPointer ( ) const

inline

Retrieve current buffer pointer.

Definition at line 263 of file StreamBuffer.h.

263 { return m_pointer; }

◆ containedLinks() [1/2]

ContainedLinks& StreamBuffer::containedLinks ( )

inline

Access to contained links.

Definition at line 240 of file StreamBuffer.h.

240 { return m_containedLinks; }

◆ containedLinks() [2/2]

const ContainedLinks& StreamBuffer::containedLinks ( ) const

inline

CONST Access to contained links.

Definition at line 242 of file StreamBuffer.h.

242 { return m_containedLinks; }

◆ data() [1/2]

char* StreamBuffer::data ( )

inline

write access to data buffer

Definition at line 207 of file StreamBuffer.h.

207 { return m_buffer; }

◆ data() [2/2]

const char* StreamBuffer::data ( ) const

inline

Read access to data buffer.

Definition at line 205 of file StreamBuffer.h.

205 { return m_buffer; }

◆ erase()

void StreamBuffer::erase ( )

inline

Reset the buffer.

Definition at line 209 of file StreamBuffer.h.

209 { m_pointer = 0; }

◆ extend()

void StreamBuffer::extend ( long len )

inline

Extend the buffer.

Definition at line 228 of file StreamBuffer.h.

                           {
     if ( len + m_pointer > m_length ) {
       // We have to be a bit generous here in order not to run too often
       // into ::realloc().
       long new_len = ( m_length < 16384 ) ? 16384 : 2 * m_length;
       if ( m_length < len ) new_len += len;
       reserve( new_len );
     }
   }

◆ getContainedLink()

void StreamBuffer::getContainedLink	(	ContainedObject *&	pObject,
		long &	hint,
		long &	link
	)

inline

Definition at line 293 of file StreamBuffer.h.

                                                                              {
     ContainedLink& l = m_containedLinks.back();
     pObject          = l.first;
     hint             = l.second;
     link             = l.third;
     m_containedLinks.pop_back();
   }

◆ getIdentifiedLink()

void StreamBuffer::getIdentifiedLink	(	DataObject *&	pObject,
		long &	hint
	)

inline

Definition at line 283 of file StreamBuffer.h.

                                                              {
     IdentifiedLink& l = m_identifiedLinks.back();
     pObject           = l.first;
     hint              = l.second;
     m_identifiedLinks.pop_back();
   }

◆ getObjectPointer() [1/2]

template<class TYPE >

StreamBuffer& StreamBuffer::getObjectPointer	(	const ContainedObject *	,
		TYPE *&	refpObject
	)

inlineprotected

Helper to distinguish between identified pointers and contained pointers.

This entry resolves contained pointers (= Pointers to ContainedObject instances.)

Definition at line 191 of file StreamBuffer.h.

                                                                                 {
     ContainedLink&   link = m_containedLinks.back();
     ContainedObject* pObj = link.first;
     m_containedLinks.pop_back();
     refpObject = dynamic_cast<TYPE*>( pObj );
     return *this;
   }

◆ getObjectPointer() [2/2]

template<class TYPE >

StreamBuffer& StreamBuffer::getObjectPointer	(	const DataObject *	,
		TYPE *&	refpObject
	)

inlineprotected

Helper to distinguish between identified pointers and contained pointers.

This entry resolves identified pointers (= Pointers to DataObject instances.)

Definition at line 180 of file StreamBuffer.h.

                                                                            {
     IdentifiedLink& link = m_identifiedLinks.back();
     DataObject*     pObj = link.first;
     m_identifiedLinks.pop_back();
     refpObject = dynamic_cast<TYPE*>( pObj );
     return *this;
   }

◆ identifiedLinks() [1/2]

IdentifiedLinks& StreamBuffer::identifiedLinks ( )

inline

Access to identified links.

Definition at line 245 of file StreamBuffer.h.

245 { return m_identifiedLinks; }

◆ identifiedLinks() [2/2]

const IdentifiedLinks& StreamBuffer::identifiedLinks ( ) const

inline

CONST Access to identified links.

Definition at line 247 of file StreamBuffer.h.

247 { return m_identifiedLinks; }

◆ isReading()

bool StreamBuffer::isReading ( ) const

inline

Get stream buffer state.

Definition at line 258 of file StreamBuffer.h.

258 { return m_mode == READING; }

◆ isWriting()

bool StreamBuffer::isWriting ( ) const

inline

Get stream buffer state.

Definition at line 261 of file StreamBuffer.h.

261 { return m_mode == WRITING; }

◆ operator<<() [1/15]

StreamBuffer& StreamBuffer::operator<< ( char data )

inline

Output Streamer.

Definition at line 406 of file StreamBuffer.h.

                                         {
     swapToBuffer( &data, sizeof( data ) );
     STREAM_ANALYSE( data, sizeof( data ) );
     return *this;
   }

◆ operator<<() [2/15]

StreamBuffer& StreamBuffer::operator<< ( const char * data )

inline

Streamer to write strings in (char*) format.

Definition at line 457 of file StreamBuffer.h.

                                                {
     const char* ptr = 0 == data ? "" : data;
     size_t      len = strlen( ptr ) + 1;
     if ( 0 == m_analyzer )
       writeBytes( ptr, len );
     else { STREAM_ANALYSE( data, len ); }
     return *this;
   }

◆ operator<<() [3/15]

StreamBuffer& StreamBuffer::operator<< ( const ContainedObject * pObject )

inline

Streamer to write links to contained objects.

Links to contained objects are not stored immediately, but collected instead and analyzed later.

Parameters

pObject Pointer to object to be loaded.

Returns: Reference to StreamBuffer object

Definition at line 500 of file StreamBuffer.h.

                                                              {
     STREAM_ANALYSE( pObject, sizeof( pObject ) );
     addContainedLink( pObject, INVALID, INVALID );
     return *this;
   }

◆ operator<<() [4/15]

StreamBuffer& StreamBuffer::operator<< ( const DataObject * pObject )

inline

Streamer to write links to identified objects.

Links to identified objects are not stored immediately, but collected instead and analyzed later.

Parameters

pObject Pointer to object to be loaded.

Returns: Reference to StreamBuffer object

Definition at line 512 of file StreamBuffer.h.

                                                         {
     STREAM_ANALYSE( pObject, sizeof( pObject ) );
     addIdentifiedLink( pObject, INVALID );
     return *this;
   }

◆ operator<<() [5/15]

StreamBuffer& StreamBuffer::operator<< ( const std::string & data )

inline

Streamer to write strings in (std::string) format.

Definition at line 473 of file StreamBuffer.h.

                                                     {
     if ( 0 == m_analyzer ) {
       const char* ptr = data.c_str();
       long        len = data.length();
       writeBytes( ptr, len );
     } else {
       STREAM_ANALYSE( data, sizeof( data ) );
     }
     return *this;
   }

◆ operator<<() [6/15]

StreamBuffer& StreamBuffer::operator<< ( double data )

inline

Output Streamer.

Definition at line 439 of file StreamBuffer.h.

                                           {
     swapToBuffer( &data, sizeof( data ) );
     STREAM_ANALYSE( data, sizeof( data ) );
     return *this;
   }

◆ operator<<() [7/15]

StreamBuffer& StreamBuffer::operator<< ( float data )

inline

Output Streamer.

Definition at line 428 of file StreamBuffer.h.

                                          {
     swapToBuffer( &data, sizeof( data ) );
     STREAM_ANALYSE( data, sizeof( data ) );
     return *this;
   }

◆ operator<<() [8/15]

StreamBuffer& StreamBuffer::operator<< ( int data )

inline

Output Streamer.

Definition at line 340 of file StreamBuffer.h.

                                        {
     swapToBuffer( &data, sizeof( data ) );
     STREAM_ANALYSE( data, sizeof( data ) );
     return *this;
   }

◆ operator<<() [9/15]

StreamBuffer& StreamBuffer::operator<< ( long data )

inline

Output Streamer.

Definition at line 362 of file StreamBuffer.h.

                                         {
     swapToBuffer( &data, sizeof( data ) );
     STREAM_ANALYSE( data, sizeof( data ) );
     return *this;
   }

◆ operator<<() [10/15]

StreamBuffer& StreamBuffer::operator<< ( long long data )

inline

Output Streamer.

Definition at line 329 of file StreamBuffer.h.

                                              {
     swapToBuffer( &data, sizeof( data ) );
     STREAM_ANALYSE( data, sizeof( data ) );
     return *this;
   }

◆ operator<<() [11/15]

StreamBuffer& StreamBuffer::operator<< ( short data )

inline

Output Streamer.

Definition at line 384 of file StreamBuffer.h.

                                          {
     swapToBuffer( &data, sizeof( data ) );
     STREAM_ANALYSE( data, sizeof( data ) );
     return *this;
   }

◆ operator<<() [12/15]

StreamBuffer& StreamBuffer::operator<< ( unsigned char data )

inline

Output Streamer.

Definition at line 417 of file StreamBuffer.h.

                                                  {
     swapToBuffer( &data, sizeof( data ) );
     STREAM_ANALYSE( data, sizeof( data ) );
     return *this;
   }

◆ operator<<() [13/15]

StreamBuffer& StreamBuffer::operator<< ( unsigned int data )

inline

Output Streamer.

Definition at line 351 of file StreamBuffer.h.

                                                 {
     swapToBuffer( &data, sizeof( data ) );
     STREAM_ANALYSE( data, sizeof( data ) );
     return *this;
   }

◆ operator<<() [14/15]

StreamBuffer& StreamBuffer::operator<< ( unsigned long data )

inline

Output Streamer.

Definition at line 373 of file StreamBuffer.h.

                                                  {
     swapToBuffer( &data, sizeof( data ) );
     STREAM_ANALYSE( data, sizeof( data ) );
     return *this;
   }

◆ operator<<() [15/15]

StreamBuffer& StreamBuffer::operator<< ( unsigned short data )

inline

Output Streamer.

Definition at line 395 of file StreamBuffer.h.

                                                   {
     swapToBuffer( &data, sizeof( data ) );
     STREAM_ANALYSE( data, sizeof( data ) );
     return *this;
   }

◆ operator>>() [1/14]

StreamBuffer& StreamBuffer::operator>> ( char & data )

inline

Input Streamer.

Definition at line 412 of file StreamBuffer.h.

                                          {
     swapFromBuffer( &data, sizeof( data ) );
     return *this;
   }

◆ operator>>() [2/14]

StreamBuffer& StreamBuffer::operator>> ( char * data )

inline

Streamer to read strings in (char*) format.

Definition at line 450 of file StreamBuffer.h.

                                          {
     long i, len;
     *this >> len;
     for ( i = 0, data[0] = 0; i < len; i++ ) { data[i] = m_buffer[m_pointer++]; }
     return *this;
   }

◆ operator>>() [3/14]

StreamBuffer& StreamBuffer::operator>> ( double & data )

inline

Input Streamer.

Definition at line 445 of file StreamBuffer.h.

                                            {
     swapFromBuffer( &data, sizeof( data ) );
     return *this;
   }

◆ operator>>() [4/14]

StreamBuffer& StreamBuffer::operator>> ( float & data )

inline

Input Streamer.

Definition at line 434 of file StreamBuffer.h.

                                           {
     swapFromBuffer( &data, sizeof( data ) );
     return *this;
   }

◆ operator>>() [5/14]

StreamBuffer& StreamBuffer::operator>> ( int & data )

inline

Input Streamer.

Definition at line 346 of file StreamBuffer.h.

                                         {
     swapFromBuffer( &data, sizeof( data ) );
     return *this;
   }

◆ operator>>() [6/14]

StreamBuffer& StreamBuffer::operator>> ( long & data )

inline

Input Streamer.

Definition at line 368 of file StreamBuffer.h.

                                          {
     swapFromBuffer( &data, sizeof( data ) );
     return *this;
   }

◆ operator>>() [7/14]

StreamBuffer& StreamBuffer::operator>> ( long long & data )

inline

Input Streamer.

Definition at line 335 of file StreamBuffer.h.

                                               {
     swapFromBuffer( &data, sizeof( data ) );
     return *this;
   }

◆ operator>>() [8/14]

StreamBuffer& StreamBuffer::operator>> ( short & data )

inline

Input Streamer.

Definition at line 390 of file StreamBuffer.h.

                                           {
     swapFromBuffer( &data, sizeof( data ) );
     return *this;
   }

◆ operator>>() [9/14]

StreamBuffer& StreamBuffer::operator>> ( std::string & data )

inline

Streamer to read strings in (std::string) format.

Definition at line 466 of file StreamBuffer.h.

                                               {
     long i, len;
     *this >> len;
     for ( i = 0, data = ""; i < len; i++ ) { data.append( 1, m_buffer[m_pointer++] ); }
     return *this;
   }

◆ operator>>() [10/14]

template<class TYPE >

StreamBuffer& StreamBuffer::operator>> ( TYPE *& refpObject )

inline

Streamer to read links to contained or identified objects.

The specified internal function call distinguishes between contained and identified objects.

Parameters

refpObject Reference to pointer to object to be loaded.

Returns: Reference to StreamBuffer object

Definition at line 490 of file StreamBuffer.h.

                                                 {
     return getObjectPointer( refpObject, refpObject );
   }

◆ operator>>() [11/14]

StreamBuffer& StreamBuffer::operator>> ( unsigned char & data )

inline

Input Streamer.

Definition at line 423 of file StreamBuffer.h.

                                                   {
     swapFromBuffer( &data, sizeof( data ) );
     return *this;
   }

◆ operator>>() [12/14]

StreamBuffer& StreamBuffer::operator>> ( unsigned int & data )

inline

Input Streamer.

Definition at line 357 of file StreamBuffer.h.

                                                  {
     swapFromBuffer( &data, sizeof( data ) );
     return *this;
   }

◆ operator>>() [13/14]

StreamBuffer& StreamBuffer::operator>> ( unsigned long & data )

inline

Input Streamer.

Definition at line 379 of file StreamBuffer.h.

                                                   {
     swapFromBuffer( &data, sizeof( data ) );
     return *this;
   }

◆ operator>>() [14/14]

StreamBuffer& StreamBuffer::operator>> ( unsigned short & data )

inline

Input Streamer.

Definition at line 401 of file StreamBuffer.h.

                                                    {
     swapFromBuffer( &data, sizeof( data ) );
     return *this;
   }

◆ reserve()

void StreamBuffer::reserve ( long len )

inline

Reserve buffer space; Default: 16 k buffer size.

Definition at line 221 of file StreamBuffer.h.

                            {
     if ( len > m_length ) {
       m_length = ( len < 16384 ) ? 16384 : len;
       m_buffer = (char*)::realloc( m_buffer, m_length );
     }
   }

◆ serialize()

void StreamBuffer::serialize ( DataIO & ioObject )

inline

Serialize the buffer using an IO object.

The streambuffer object will make use of a DataIO object, which can be specialized for streaming to any representation like e.g. disk files, Root files, Objectivity etc.

Parameters

ioObject Reference to data IO object.

Definition at line 524 of file StreamBuffer.h.

                                      {
     ioObject.serialize( *this );
     m_pointer = 0;
   }

◆ setAnalyzer()

void StreamBuffer::setAnalyzer ( AnalyzeFunction fun = nullptr )

inline

Enable user analysis function.

Definition at line 267 of file StreamBuffer.h.

267 { m_analyzer = fun; }

◆ setBuffPointer()

void StreamBuffer::setBuffPointer ( long ptr )

inline

Retrieve current buffer pointer.

Definition at line 265 of file StreamBuffer.h.

265 { m_pointer = ptr; }

◆ setMode()

void StreamBuffer::setMode ( Mode m )

inline

Set mode of the stream and allocate buffer.

Definition at line 250 of file StreamBuffer.h.

                          {
     m_mode    = m;
     m_pointer = 0;
     m_containedLinks.erase( m_containedLinks.begin(), m_containedLinks.end() );
     m_identifiedLinks.erase( m_identifiedLinks.begin(), m_identifiedLinks.end() );
   }

◆ size()

long StreamBuffer::size ( ) const

inline

Total buffer size.

Definition at line 238 of file StreamBuffer.h.

238 { return m_length; }

◆ swapBuffer()

StreamBuffer::SwapAction StreamBuffer::swapBuffer ( int siz ) const

inlineprotected

Check for byte swapping.

Definition at line 533 of file StreamBuffer.h.

                                                                       {
   switch ( siz ) {
   case 1:
     return SINGLE_BYTE;
   default:
 #if defined( __alpha ) && !defined( __VMS )
     //    return m_swapEnabled ? SWAP : NOSWAP;
     return NOSWAP;
 #elif defined( __sun ) && defined( __SVR4 ) && defined( __i386 )
     //    return m_swapEnabled ? SWAP : NOSWAP;
     return NOSWAP;
 #elif defined( __APPLE__ )
     //    return m_swapEnabled ? SWAP : NOSWAP;
     return SWAP;
 #elif defined( __linux ) && !defined( __powerpc )
     //    return m_swapEnabled ? SWAP : NOSWAP;
     return NOSWAP;
 #elif defined( BORLAND ) || defined( _WIN32 ) || defined( WIN32 )
     //    return m_swapEnabled ? SWAP : NOSWAP;
     return NOSWAP;
 #else
     return m_swapEnabled ? SWAP : NOSWAP;
 //    return NOSWAP;
 #endif
   }
 }

◆ swapFromBuffer()

void StreamBuffer::swapFromBuffer	(	void *	target,
		int	siz
	)

inline

Swap buffers: int, long, short, float and double.

Swap bytes from the stream buffer to target buffer with arbitray size.

Definition at line 587 of file StreamBuffer.h.

                                                                 {
   char* tar = (char*)target;
   char* src = m_buffer + m_pointer;
   switch ( swapBuffer( siz ) ) {
   case SINGLE_BYTE:
     *tar = *src;
     break;
   case SWAP:
 #ifdef __APPLE__
     for ( int i = 0, j = siz - 1; i < siz; i++, j-- ) tar[j] = src[i];
 #else
     ::_swab( src, tar, siz );
 #endif
     break;
   case NOSWAP:
     std::copy_n( src, siz, tar );
     break;
   default:
     break;
   }
   m_pointer += siz;
 }

◆ swapToBuffer()

void StreamBuffer::swapToBuffer	(	const void *	source,
		int	siz
	)

inline

Swap buffers: int, long, short, float and double.

Swap bytes from a source buffer to the stream buffer with arbitray size.

Definition at line 561 of file StreamBuffer.h.

                                                                     {
   char buff[8], *tar, *src = (char*)source;
   extend( m_pointer + siz );
   tar = m_buffer + m_pointer;
   switch ( swapBuffer( siz ) ) {
   case SINGLE_BYTE:
     *tar = *src;
     break;
   case SWAP:
 #ifdef __APPLE__
     for ( int i = 0, j = siz - 1; i < siz; i++, j-- ) tar[j] = src[i];
 #else
     ::_swab( src, buff, siz );
 #endif
     src = buff;
     [[fallthrough]];
   case NOSWAP:
     std::copy_n( src, siz, tar );
     break;
   default:
     break;
   }
   m_pointer += siz;
 }

◆ writeBytes()

StreamBuffer& StreamBuffer::writeBytes	(	const char *	str,
		long	len
	)

inline

Write string to output stream.

Definition at line 275 of file StreamBuffer.h.

                                                         {
     extend( m_pointer + len + 4 );
     *this << len;
     std::copy_n( str, len, data() + buffPointer() );
     m_pointer += len;
     return *this;
   }

Friends And Related Function Documentation

◆ DataObject

friend class DataObject

friend

DataObject is friend.

Definition at line 146 of file StreamBuffer.h.

Member Data Documentation

◆ m_analyzer

AnalyzeFunction StreamBuffer::m_analyzer = nullptr

protected

Hook function for analysis of data to the stream.

Definition at line 171 of file StreamBuffer.h.

◆ m_buffer

char* StreamBuffer::m_buffer = nullptr

mutableprotected

Pointer to heap buffer.

Definition at line 159 of file StreamBuffer.h.

◆ m_containedLinks

ContainedLinks StreamBuffer::m_containedLinks

mutableprotected

Container with links to contained objects.

Definition at line 165 of file StreamBuffer.h.

◆ m_identifiedLinks

IdentifiedLinks StreamBuffer::m_identifiedLinks

mutableprotected

Container with links to contained objects.

Definition at line 168 of file StreamBuffer.h.

◆ m_length

long StreamBuffer::m_length = 0

mutableprotected

Total buffer length.

Definition at line 156 of file StreamBuffer.h.

◆ m_mode

Mode StreamBuffer::m_mode = UNINITIALIZED

protected

Boolean indicating wether the stream is in read or write mode.

Definition at line 150 of file StreamBuffer.h.

◆ m_pointer

long StreamBuffer::m_pointer = 0

mutableprotected

Current buffer pointer.

Definition at line 153 of file StreamBuffer.h.

◆ m_swapEnabled

bool StreamBuffer::m_swapEnabled = true

protected

Flag indicating swapping.

Definition at line 162 of file StreamBuffer.h.

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

GaudiKernel/include/GaudiKernel/StreamBuffer.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ AnalyzeFunction

◆ ContainedLinks

◆ IdentifiedLinks

Member Enumeration Documentation

◆ Mode

◆ State

◆ SwapAction

Constructor & Destructor Documentation

◆ StreamBuffer()

◆ ~StreamBuffer()

Member Function Documentation

◆ addContainedLink()

◆ addIdentifiedLink()

◆ adopt()

◆ buffPointer()

◆ containedLinks() [1/2]

◆ containedLinks() [2/2]

◆ data() [1/2]

◆ data() [2/2]

◆ erase()

◆ extend()

◆ getContainedLink()

◆ getIdentifiedLink()

◆ getObjectPointer() [1/2]

◆ getObjectPointer() [2/2]

◆ identifiedLinks() [1/2]

◆ identifiedLinks() [2/2]

◆ isReading()

◆ isWriting()

◆ operator<<() [1/15]

◆ operator<<() [2/15]

◆ operator<<() [3/15]

◆ operator<<() [4/15]

◆ operator<<() [5/15]

◆ operator<<() [6/15]

◆ operator<<() [7/15]

◆ operator<<() [8/15]

◆ operator<<() [9/15]

◆ operator<<() [10/15]

◆ operator<<() [11/15]

◆ operator<<() [12/15]

◆ operator<<() [13/15]

◆ operator<<() [14/15]

◆ operator<<() [15/15]

◆ operator>>() [1/14]

◆ operator>>() [2/14]

◆ operator>>() [3/14]

◆ operator>>() [4/14]

◆ operator>>() [5/14]

◆ operator>>() [6/14]

◆ operator>>() [7/14]

◆ operator>>() [8/14]

◆ operator>>() [9/14]

◆ operator>>() [10/14]

◆ operator>>() [11/14]

◆ operator>>() [12/14]

◆ operator>>() [13/14]

◆ operator>>() [14/14]

◆ reserve()

◆ serialize()

◆ setAnalyzer()

◆ setBuffPointer()

◆ setMode()

◆ size()

◆ swapBuffer()

◆ swapFromBuffer()

◆ swapToBuffer()

◆ writeBytes()

Friends And Related Function Documentation

◆ DataObject

Member Data Documentation

◆ m_analyzer