evio  5.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
evio::evioBufferChannel Class Reference

Implements evioChannel functionality for I/O to and from user-supplied evio buffer. More...

#include <evioBufferChannel.hxx>

Inheritance diagram for evio::evioBufferChannel:
evio::evioChannel

Public Member Functions

 evioBufferChannel (uint32_t *streamBuf, int bufLen, const string &mode="r", int size=100000) throw (evioException)
 Constructor opens buffer for reading or writing. More...
 
 evioBufferChannel (uint32_t *streamBuf, int bufLen, evioDictionary *dict, const string &mode="r", int size=100000) throw (evioException)
 Constructor opens buffer for reading or writing. More...
 
virtual ~evioBufferChannel (void)
 Destructor closes buffer, deletes internal buffer and dictionary. More...
 
void open (void) throw (evioException)
 Opens channel for reading or writing. More...
 
bool read (void) throw (evioException)
 Reads from buffer. More...
 
bool read (uint32_t *myEventBuf, int length) throw (evioException)
 Reads from buffer into user-supplied event buffer. More...
 
bool readAlloc (uint32_t **buffer, uint32_t *bufLen) throw (evioException)
 Reads from file and allocates buffer as needed. More...
 
bool readNoCopy (void) throw (evioException)
 Get const pointer to next event in stream buffer. More...
 
bool readRandom (uint32_t bufferNumber) throw (evioException)
 Reads buffer from file given buffer number. More...
 
void write (void) throw (evioException)
 Writes to buffer from internal buffer. More...
 
void write (const uint32_t *myEventBuf) throw (evioException)
 Writes to buffer from user-supplied buffer. More...
 
void write (const evioChannel &channel) throw (evioException)
 Writes to buffer from internal buffer of another evioChannel object. More...
 
void write (const evioChannel *channel) throw (evioException)
 Writes from internal buffer of another evioChannel object. More...
 
void write (const evioChannelBufferizable &o) throw (evioException)
 Writes from contents of evioChannelBufferizable object. More...
 
void write (const evioChannelBufferizable *o) throw (evioException)
 Writes from contents of evioChannelBufferizable object. More...
 
void close (void) throw (evioException)
 Closes channel. More...
 
int ioctl (const string &request, void *argp) throw (evioException)
 For getting and setting evIoctl parameters. More...
 
const uint32_t * getBuffer (void) const throw (evioException)
 Returns pointer to internal channel buffer. More...
 
int getBufSize (void) const
 Returns internal channel buffer size. More...
 
const uint32_t * getNoCopyBuffer (void) const throw (evioException)
 Returns pointer to no copy buffer. More...
 
const uint32_t * getRandomBuffer (void) const throw (evioException)
 Returns pointer to random buffer. More...
 
void getRandomAccessTable (uint32_t ***const table, uint32_t *len) const throw (evioException)
 Returns random access table. More...
 
const uint32_t * getStreamBuffer (void) const throw (evioException)
 Returns pointer to stream buffer. More...
 
int getStreamBufSize (void) const
 Returns internal channel buffer size. More...
 
string getMode (void) const
 Returns channel I/O mode. More...
 
uint32_t getEVIOBufferLength (void) const throw (evioException)
 Returns length of event record in stream buffer in 4-byte words. More...
 
string getBufferXMLDictionary (void) const
 Returns XML dictionary read in from buffer. More...
 
- Public Member Functions inherited from evio::evioChannel
 evioChannel (void)
 
 evioChannel (evioDictionary *dict)
 
virtual ~evioChannel (void)
 
virtual const evioDictionarygetDictionary (void) const
 

Additional Inherited Members

- Protected Attributes inherited from evio::evioChannel
evioDictionarydictionary
 

Detailed Description

Implements evioChannel functionality for I/O to and from user-supplied evio buffer.

Constructor & Destructor Documentation

evioBufferChannel::evioBufferChannel ( uint32_t *  streamBuf,
int  bufLen,
const string &  m = "r",
int  size = 100000 
)
throw (evioException
)

Constructor opens buffer for reading or writing.

Parameters
streamBufStream buffer specified by the user
bufLensize of the stream buffer
mI/O mode, "r", "ra", "w", or "a"
sizeInternal event buffer size
evioBufferChannel::evioBufferChannel ( uint32_t *  streamBuf,
int  bufLen,
evioDictionary dict,
const string &  m = "r",
int  size = 100000 
)
throw (evioException
)

Constructor opens buffer for reading or writing.

Parameters
streamBufStream buffer specified by the user
bufLensize of the stream buffer
dictDictionary
mI/O mode, "r", "ra", "w", or "a"
sizeInternal event buffer size
evioBufferChannel::~evioBufferChannel ( void  )
virtual

Destructor closes buffer, deletes internal buffer and dictionary.

Member Function Documentation

void evioBufferChannel::close ( void  )
throw (evioException
)
virtual

Closes channel.

Implements evio::evioChannel.

const uint32_t * evioBufferChannel::getBuffer ( void  ) const
throw (evioException
)
virtual

Returns pointer to internal channel buffer.

Returns
Pointer to internal buffer

Implements evio::evioChannel.

string evioBufferChannel::getBufferXMLDictionary ( void  ) const

Returns XML dictionary read in from buffer.

Returns
XML dictionary read in from buffer
int evioBufferChannel::getBufSize ( void  ) const
virtual

Returns internal channel buffer size.

Returns
Internal buffer size in 4-byte words

Implements evio::evioChannel.

uint32_t evioBufferChannel::getEVIOBufferLength ( void  ) const
throw (evioException
)

Returns length of event record in stream buffer in 4-byte words.

Returns
Length of event record in stream buffer 4-byte words
string evioBufferChannel::getMode ( void  ) const

Returns channel I/O mode.

Returns
String containing I/O mode
const uint32_t * evioBufferChannel::getNoCopyBuffer ( void  ) const
throw (evioException
)
virtual

Returns pointer to no copy buffer.

Returns
Pointer to no copy buffer

Implements evio::evioChannel.

void evioBufferChannel::getRandomAccessTable ( uint32_t ***const  table,
uint32_t *  len 
) const
throw (evioException
)
virtual

Returns random access table.

Parameters
tablePointer to table
lenLength of table

Reimplemented from evio::evioChannel.

const uint32_t * evioBufferChannel::getRandomBuffer ( void  ) const
throw (evioException
)
virtual

Returns pointer to random buffer.

Returns
Pointer to random buffer

Reimplemented from evio::evioChannel.

const uint32_t * evioBufferChannel::getStreamBuffer ( void  ) const
throw (evioException
)

Returns pointer to stream buffer.

Returns
Pointer to stream buffer
int evioBufferChannel::getStreamBufSize ( void  ) const

Returns internal channel buffer size.

Returns
Internal buffer size in 4-byte words
int evioBufferChannel::ioctl ( const string &  request,
void *  argp 
)
throw (evioException
)
virtual

For getting and setting evIoctl parameters.

Parameters
requestString containing evIoctl parameters
argpAdditional evIoctl parameter

Implements evio::evioChannel.

void evioBufferChannel::open ( void  )
throw (evioException
)
virtual

Opens channel for reading or writing.

For read, user-supplied dictionary overrides one found in buffer.

Implements evio::evioChannel.

bool evioBufferChannel::read ( void  )
throw (evioException
)
virtual

Reads from buffer.

Returns
true if successful, false on EOF or other evRead error condition

Implements evio::evioChannel.

bool evioBufferChannel::read ( uint32_t *  myBuf,
int  length 
)
throw (evioException
)
virtual

Reads from buffer into user-supplied event buffer.

Parameters
myBufUser-supplied buffer. length Length of buffer in 4-byte words.
Returns
true if successful, false on EOF or other evRead error condition

Implements evio::evioChannel.

bool evioBufferChannel::readAlloc ( uint32_t **  buffer,
uint32_t *  bufLen 
)
throw (evioException
)
virtual

Reads from file and allocates buffer as needed.

Parameters
bufferPointer to pointer to allocated buffer.
lenLength of allocated buffer in 4-byte words.
Returns
true if successful, false on EOF, throws exception for other error.

Note: user MUST free the allocated buffer!

Implements evio::evioChannel.

bool evioBufferChannel::readNoCopy ( void  )
throw (evioException
)
virtual

Get const pointer to next event in stream buffer.

Returns
true if successful, false on EOF, throws exception for other error.

Implements evio::evioChannel.

bool evioBufferChannel::readRandom ( uint32_t  bufferNumber)
throw (evioException
)
virtual

Reads buffer from file given buffer number.

Parameters
bufferNumberBuffer to return
Returns
true if successful, false on EOF, throws exception for other error.

Reimplemented from evio::evioChannel.

void evioBufferChannel::write ( void  )
throw (evioException
)
virtual

Writes to buffer from internal buffer.

Implements evio::evioChannel.

void evioBufferChannel::write ( const uint32_t *  myBuf)
throw (evioException
)
virtual

Writes to buffer from user-supplied buffer.

Parameters
myBufBuffer containing event

Implements evio::evioChannel.

void evioBufferChannel::write ( const evioChannel channel)
throw (evioException
)
virtual

Writes to buffer from internal buffer of another evioChannel object.

Parameters
channelChannel object

Implements evio::evioChannel.

void evioBufferChannel::write ( const evioChannel channel)
throw (evioException
)
virtual

Writes from internal buffer of another evioChannel object.

Parameters
channelPointer to channel object

Implements evio::evioChannel.

void evioBufferChannel::write ( const evioChannelBufferizable o)
throw (evioException
)
virtual

Writes from contents of evioChannelBufferizable object.

Parameters
oevioChannelBufferizable object that can serialze to buffer

Implements evio::evioChannel.

void evioBufferChannel::write ( const evioChannelBufferizable o)
throw (evioException
)
virtual

Writes from contents of evioChannelBufferizable object.

Parameters
oPointer to evioChannelBufferizable object that can serialize to buffer

Implements evio::evioChannel.


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