---

Storage Class Reference

#include <Utilities/StorageFactory/interface/Storage.h>

Inheritance diagram for Storage:

List of all members.

Public Types
enum	Relative { SET, CURRENT, END }
Public Member Functions
virtual void	close (void)
virtual bool	eof (void) const
virtual void	flush (void)
virtual IOOffset	position (IOOffset offset, Relative whence=SET)=0
virtual IOOffset	position (void) const
virtual bool	prefetch (const IOPosBuffer *what, IOSize n)
IOSize	read (IOBuffer into, IOOffset pos)
virtual IOSize	read (void *into, IOSize n, IOOffset pos)
virtual IOSize	readv (IOPosBuffer *into, IOSize buffers)
virtual void	resize (IOOffset size)=0
virtual void	rewind (void)
virtual IOOffset	size (void) const
	Storage (void)
IOSize	write (IOBuffer from, IOOffset pos)
virtual IOSize	write (const void *from, IOSize n, IOOffset pos)
virtual IOSize	writev (const IOPosBuffer *from, IOSize buffers)
virtual	~Storage (void)
Private Member Functions
Storage &	operator= (const Storage &)
	Storage (const Storage &)

---

Detailed Description

Definition at line 8 of file Storage.h.

---

Member Enumeration Documentation

enum Storage::Relative

Enumerator:

SET
CURRENT
END

Definition at line 11 of file Storage.h.

{ SET, CURRENT, END };

---

Constructor & Destructor Documentation

Storage::Storage

(

void

)

Definition at line 5 of file Storage.cc.

{}

Storage::~Storage

(

void

)

[virtual]

Definition at line 8 of file Storage.cc.

{}

Storage::Storage

(

const Storage &

)

[private]

---

Member Function Documentation

void Storage::close

(

void

)

[virtual]

Reimplemented in DCacheFile, RFIOFile, File, LocalCacheFile, RemoteFile, StorageAccountProxy, and XrdFile.

Definition at line 128 of file Storage.cc.

Referenced by StorageAccountProxy::close(), LocalCacheFile::close(), TStorageFactoryFile::SysClose(), and TStorageFactoryFile::SysOpen().

{}

bool Storage::eof

(

void

)

const [virtual]

Definition at line 133 of file Storage.cc.

References position(), and size().

{ return position () == size (); }

void Storage::flush

(

void

)

[virtual]

Reimplemented in File, LocalCacheFile, and StorageAccountProxy.

Definition at line 124 of file Storage.cc.

Referenced by StorageAccountProxy::flush(), and TStorageFactoryFile::SysSync().

{}

Storage& Storage::operator=

(

const Storage &

)

[private]

virtual IOOffset Storage::position	(	IOOffset	offset,
		Relative	whence = SET
	)			[pure virtual]

Implemented in DCacheFile, RFIOFile, File, LocalCacheFile, StorageAccountProxy, and XrdFile.

IOOffset Storage::position

(

void

)

const [virtual]

Definition at line 95 of file Storage.cc.

References CURRENT.

Referenced by eof(), StorageAccountProxy::position(), read(), readv(), RFIOFile::reopen(), rewind(), size(), TStorageFactoryFile::SysSeek(), write(), File::write(), and File::writev().

{
  Storage *self = const_cast<Storage *> (this);
  return self->position (0, CURRENT);
}

bool Storage::prefetch	(	const IOPosBuffer *	what,
		IOSize	n
	)			[virtual]

Reimplemented in RFIOFile, File, LocalCacheFile, StorageAccountProxy, and XrdFile.

Definition at line 119 of file Storage.cc.

Referenced by StorageAccountProxy::prefetch(), TStorageFactoryFile::ReadBufferAsync(), and TStorageFactoryFile::ReadBuffers().

{ return false; }

IOSize Storage::read	(	IOBuffer	into,
		IOOffset	pos
	)

Definition at line 13 of file Storage.cc.

References IOBuffer::data(), IOInput::read(), and IOBuffer::size().

{ return read (into.data (), into.size (), pos); }

IOSize Storage::read	(	void *	into,
		IOSize	n,
		IOOffset	pos
	)			[virtual]

Reimplemented in File, LocalCacheFile, StorageAccountProxy, and XrdFile.

Definition at line 17 of file Storage.cc.

References position(), and IOInput::read().

Referenced by LocalCacheFile::cache(), mcdbGetInputFile(), PixelSLinkDataInputSource::PixelSLinkDataInputSource(), PixelSLinkDataInputSource::produce(), and StorageAccountProxy::read().

{
  // FIXME: this is not thread safe!  split into separate interface
  // that a particular storage can choose to support or not?  make
  // sure that throw semantics are correct here!
  // FIXME: use saveposition object in case exceptions are thrown?
  IOOffset here = position ();
  position (pos);
  n = read (into, n);
  position (here);
  return n;
}

IOSize Storage::readv	(	IOPosBuffer *	into,
		IOSize	buffers
	)			[virtual]

Reimplemented in RFIOFile, LocalCacheFile, StorageAccountProxy, and XrdFile.

Definition at line 31 of file Storage.cc.

References data, i, offset, position(), IOInput::read(), and size().

Referenced by TStorageFactoryFile::ReadBuffers(), LocalCacheFile::readv(), StorageAccountProxy::readv(), and RFIOFile::readv().

{
  IOOffset here = position();
  IOSize total = 0;
  for (IOSize i = 0; i < n; ++i)
  {
    try
    {
      position(into[i].offset());
      total += read(into[i].data(), into[i].size());
    }
    catch (cms::Exception &)
    {
      if (! total)
        throw;
      break;
    }
  }
  position(here);
  return total;
}

virtual void Storage::resize

(

IOOffset

size

)

[pure virtual]

Implemented in DCacheFile, RFIOFile, File, LocalCacheFile, StorageAccountProxy, and XrdFile.

Referenced by StorageAccountProxy::resize().

void Storage::rewind

(

void

)

[virtual]

Definition at line 114 of file Storage.cc.

References position().

{ position(0); }

IOOffset Storage::size

(

void

)

const [virtual]

Reimplemented in File.

Definition at line 102 of file Storage.cc.

References END, and position().

Referenced by eof(), StorageAccountProxy::prefetch(), LocalCacheFile::readv(), readv(), TStorageFactoryFile::SysStat(), and writev().

{
  // FIXME: use saveposition object in case exceptions are thrown?
  Storage *self = const_cast<Storage *> (this);
  IOOffset here = position ();
  self->position (0, END);
  IOOffset size = position ();
  self->position (here); // FIXME: VERIFY()?
  return size;
}

IOSize Storage::write	(	IOBuffer	from,
		IOOffset	pos
	)

Definition at line 55 of file Storage.cc.

References IOBuffer::data(), IOBuffer::size(), and write().

{ return write (from.data (), from.size (), pos); }

IOSize Storage::write	(	const void *	from,
		IOSize	n,
		IOOffset	pos
	)			[virtual]

Reimplemented in File, LocalCacheFile, StorageAccountProxy, and XrdFile.

Definition at line 59 of file Storage.cc.

References position().

Referenced by write(), StorageAccountProxy::write(), and writev().

{
  // FIXME: this is not thread safe!  split into separate interface
  // that a particular storage can choose to support or not?  make
  // sure that throw semantics are correct here!

  // FIXME: use saveposition object in case exceptions are thrown?
  IOOffset here = position ();
  position (pos);
  n = write (from, n);
  position (here);
  return n;
}

IOSize Storage::writev	(	const IOPosBuffer *	from,
		IOSize	buffers
	)			[virtual]

Reimplemented in LocalCacheFile, and StorageAccountProxy.

Definition at line 74 of file Storage.cc.

References data, i, offset, size(), and write().

Referenced by StorageAccountProxy::writev().

{
  IOSize total = 0;
  for (IOSize i = 0; i < n; ++i)
  {
    try
    {
      total += write(from[i].data(), from[i].size(), from[i].offset());
    }
    catch (cms::Exception &)
    {
      if (! total)
        throw;
      break;
    }
  }
  return total;
}

---

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

• Utilities/StorageFactory/interface/Storage.h
• Utilities/StorageFactory/src/Storage.cc

---