evio::evioChannel Class Reference

Defines EVIO I/O channel functionality. More...

#include <evioChannel.hxx>

Inheritance diagram for evio::evioChannel:

List of all members.

Public Member Functions
	evioChannel (void)
	evioChannel (evioDictionary *dict)
virtual	~evioChannel (void)
virtual void	open (void)=0 throw (evioException)
virtual bool	read (void)=0 throw (evioException)
virtual bool	read (uint32_t *myBuf, int length)=0 throw (evioException)
virtual bool	readAlloc (uint32_t **buffer, uint32_t *bufLen)=0 throw (evioException)
virtual bool	readNoCopy (void)=0 throw (evioException)
virtual bool	readRandom (uint32_t eventNumber) throw (evioException)
virtual void	write (void)=0 throw (evioException)
virtual void	write (const uint32_t *myBuf)=0 throw (evioException)
virtual void	write (const evioChannel &channel)=0 throw (evioException)
virtual void	write (const evioChannel *channel)=0 throw (evioException)
virtual void	write (const evioChannelBufferizable &o)=0 throw (evioException)
virtual void	write (const evioChannelBufferizable *o)=0 throw (evioException)
virtual void	close (void)=0 throw (evioException)
virtual int	ioctl (const string &request, void *argp)=0 throw (evioException)
virtual const evioDictionary *	getDictionary (void) const
virtual const uint32_t *	getBuffer (void) const =0 throw (evioException)
virtual int	getBufSize (void) const =0
virtual const uint32_t *	getNoCopyBuffer (void) const =0 throw (evioException)
virtual const uint32_t *	getRandomBuffer (void) const throw (evioException)
virtual void	getRandomAccessTable (const uint32_t ***table, uint32_t *len) const throw (evioException)
Protected Attributes
evioDictionary *	dictionary

---

Detailed Description

Defines EVIO I/O channel functionality.

Sub-class gets channel-specific info from constructor and implements evioChannel methods.

Some default methods throw unsupported feature exception.

Users should be able to program to this interface.

---

Constructor & Destructor Documentation

evio::evioChannel::evioChannel

(

void

)

[inline]

evio::evioChannel::evioChannel

(

evioDictionary *

dict

)

[inline]

virtual evio::evioChannel::~evioChannel

(

void

)

[inline, virtual]

---

Member Function Documentation

virtual void evio::evioChannel::close

(

void

)

throw (evioException) [pure virtual]

Implemented in evio::evioBufferChannel, evio::evioFileChannel, and evio::evioSocketChannel.

virtual const uint32_t* evio::evioChannel::getBuffer

(

void

)

const throw (evioException) [pure virtual]

Implemented in evio::evioBufferChannel, evio::evioFileChannel, and evio::evioSocketChannel.

virtual int evio::evioChannel::getBufSize

(

void

)

const [pure virtual]

Implemented in evio::evioBufferChannel, evio::evioFileChannel, and evio::evioSocketChannel.

virtual const evioDictionary* evio::evioChannel::getDictionary

(

void

)

const [inline, virtual]

virtual const uint32_t* evio::evioChannel::getNoCopyBuffer

(

void

)

const throw (evioException) [pure virtual]

Implemented in evio::evioBufferChannel, evio::evioFileChannel, and evio::evioSocketChannel.

virtual void evio::evioChannel::getRandomAccessTable	(	const uint32_t ***	table,
		uint32_t *	len
	)			const throw (evioException) [inline, virtual]

Reimplemented in evio::evioBufferChannel, and evio::evioFileChannel.

virtual const uint32_t* evio::evioChannel::getRandomBuffer

(

void

)

const throw (evioException) [inline, virtual]

Reimplemented in evio::evioBufferChannel, and evio::evioFileChannel.

virtual int evio::evioChannel::ioctl	(	const string &	request,
		void *	argp
	)			throw (evioException) [pure virtual]

Implemented in evio::evioBufferChannel, evio::evioFileChannel, and evio::evioSocketChannel.

virtual void evio::evioChannel::open

(

void

)

throw (evioException) [pure virtual]

Implemented in evio::evioBufferChannel, evio::evioFileChannel, and evio::evioSocketChannel.

virtual bool evio::evioChannel::read	(	uint32_t *	myBuf,
		int	length
	)			throw (evioException) [pure virtual]

Implemented in evio::evioBufferChannel, evio::evioFileChannel, and evio::evioSocketChannel.

virtual bool evio::evioChannel::read

(

void

)

throw (evioException) [pure virtual]

Implemented in evio::evioBufferChannel, evio::evioFileChannel, and evio::evioSocketChannel.

virtual bool evio::evioChannel::readAlloc	(	uint32_t **	buffer,
		uint32_t *	bufLen
	)			throw (evioException) [pure virtual]

Implemented in evio::evioBufferChannel, evio::evioFileChannel, and evio::evioSocketChannel.

virtual bool evio::evioChannel::readNoCopy

(

void

)

throw (evioException) [pure virtual]

Implemented in evio::evioBufferChannel, evio::evioFileChannel, and evio::evioSocketChannel.

virtual bool evio::evioChannel::readRandom

(

uint32_t

eventNumber

)

throw (evioException) [inline, virtual]

Reimplemented in evio::evioBufferChannel, and evio::evioFileChannel.

virtual void evio::evioChannel::write

(

const evioChannelBufferizable *

o

)

throw (evioException) [pure virtual]

Implemented in evio::evioBufferChannel, evio::evioFileChannel, and evio::evioSocketChannel.

virtual void evio::evioChannel::write

(

const evioChannelBufferizable &

o

)

throw (evioException) [pure virtual]

Implemented in evio::evioBufferChannel, evio::evioFileChannel, and evio::evioSocketChannel.

virtual void evio::evioChannel::write

(

const evioChannel *

channel

)

throw (evioException) [pure virtual]

virtual void evio::evioChannel::write

(

const evioChannel &

channel

)

throw (evioException) [pure virtual]

virtual void evio::evioChannel::write

(

const uint32_t *

myBuf

)

throw (evioException) [pure virtual]

Implemented in evio::evioBufferChannel, evio::evioFileChannel, and evio::evioSocketChannel.

virtual void evio::evioChannel::write

(

void

)

throw (evioException) [pure virtual]

Implemented in evio::evioBufferChannel, evio::evioFileChannel, and evio::evioSocketChannel.

---

Member Data Documentation

evioDictionary* evio::evioChannel::dictionary [protected]

Referenced by evio::evioSocketChannel::open(), evio::evioFileChannel::open(), evio::evioBufferChannel::open(), evio::evioBufferChannel::~evioBufferChannel(), evio::evioFileChannel::~evioFileChannel(), and evio::evioSocketChannel::~evioSocketChannel().

---

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

• evioChannel.hxx