Storage Class Reference

#include <Storage.h>

Inheritance diagram for Storage:

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 (void) const
virtual IOOffset	position (IOOffset offset, Relative whence=SET)=0
virtual bool	prefetch (const IOPosBuffer *what, IOSize n)
virtual IOSize	read (void *into, IOSize n, IOOffset pos)
IOSize	read (IOBuffer into, 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)
virtual IOSize	write (const void *from, IOSize n, IOOffset pos)
IOSize	write (IOBuffer from, IOOffset pos)
virtual IOSize	writev (const IOPosBuffer *from, IOSize buffers)
	~Storage (void) override
Public Member Functions inherited from IOInput
int	read (void)
IOSize	read (IOBuffer into)
virtual IOSize	read (void *into, IOSize n)=0
virtual IOSize	readv (IOBuffer *into, IOSize buffers)
IOSize	xread (IOBuffer into)
IOSize	xread (void *into, IOSize n)
IOSize	xreadv (IOBuffer *into, IOSize buffers)
virtual	~IOInput (void)
	Destruct the stream. A no-op. More...
Public Member Functions inherited from IOOutput
IOSize	write (unsigned char byte)
IOSize	write (IOBuffer from)
virtual IOSize	write (const void *from, IOSize n)=0
virtual IOSize	writev (const IOBuffer *from, IOSize buffers)
IOSize	xwrite (const void *from, IOSize n)
IOSize	xwrite (IOBuffer from)
IOSize	xwritev (const IOBuffer *from, IOSize buffers)
virtual	~IOOutput (void)
	Destruct the stream. A no-op. More...

Private Member Functions
Storage &	operator= (const Storage &)=delete
	Storage (const Storage &)=delete

Detailed Description

Definition at line 20 of file Storage.h.

Member Enumeration Documentation

enum Storage::Relative

Enumerator
SET
CURRENT
END

Definition at line 22 of file Storage.h.

{ SET, CURRENT, END };

Constructor & Destructor Documentation

Storage::Storage

(

void

)

Definition at line 5 of file Storage.cc.

{}

Storage::~Storage ( void  )

override

Definition at line 7 of file Storage.cc.

{}

Storage::Storage ( const Storage &  )

privatedelete

Member Function Documentation

void Storage::close ( void  )

virtual

Reimplemented in File, XrdFile, StorageAccountProxy, DCacheFile, LocalCacheFile, DavixFile, LStoreFile, and RemoteFile.

Definition at line 95 of file Storage.cc.

Referenced by esMonitoring.AsyncLineReaderMixin::handle_close(), esMonitoring.FDJsonServer::handle_close(), Vispa.Gui.BoxContentDialog.BoxContentDialog::keyPressEvent(), and Vispa.Gui.FindDialog.FindDialog::keyPressEvent().

{}

bool Storage::eof ( void  ) const

virtual

Definition at line 98 of file Storage.cc.

References position(), and size().

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

void Storage::flush ( void  )

virtual

Reimplemented in File, StorageAccountProxy, and LocalCacheFile.

Definition at line 93 of file Storage.cc.

{}

Storage& Storage::operator= ( const Storage &  )

privatedelete

IOOffset Storage::position ( void  ) const

virtual

Definition at line 72 of file Storage.cc.

References CURRENT, and position().

Referenced by eof(), position(), read(), lhef::StorageInputStream::readBytes(), readv(), rewind(), size(), lhef::StorageInputStream::StorageInputStream(), and write().

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

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

pure virtual

Implemented in File, XrdFile, StorageAccountProxy, DCacheFile, LocalCacheFile, DavixFile, and LStoreFile.

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

virtual

Reimplemented in XrdFile, File, StorageAccountProxy, and LocalCacheFile.

Definition at line 90 of file Storage.cc.

{ return false; }

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

virtual

Reimplemented in XrdFile, File, StorageAccountProxy, and LocalCacheFile.

Definition at line 12 of file Storage.cc.

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

Referenced by PixelSLinkDataInputSource::PixelSLinkDataInputSource(), lhef::StorageInputStream::readBytes(), PixelSLinkDataInputSource::setRunAndEventInfo(), and lhef::StorageInputStream::StorageInputStream().

                                                       {
  // 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::read	(	IOBuffer	into,
		IOOffset	pos
	)

Definition at line 10 of file Storage.cc.

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

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

IOSize Storage::readv ( IOPosBuffer *  into, IOSize  buffers  )

virtual

Reimplemented in XrdFile, StorageAccountProxy, DavixFile, DCacheFile, and LocalCacheFile.

Definition at line 24 of file Storage.cc.

References data, mps_fire::i, dqmiodumpmetadata::n, hltrates_dqm_sourceclient-live_cfg::offset, position(), IOInput::read(), size(), and dqmMemoryStats::total.

                                                 {
  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 File, XrdFile, StorageAccountProxy, DCacheFile, LocalCacheFile, DavixFile, and LStoreFile.

Referenced by Vispa.Gui.TextDialog.TextDialog::__init__(), Vispa.Plugins.ConfigEditor.ToolDialog.ToolDialog::__init__(), Vispa.Main.MainWindow.MainWindow::_loadIni(), and Vispa.Gui.PortConnection.PointToPointConnection::updateConnection().

void Storage::rewind ( void  )

virtual

Definition at line 87 of file Storage.cc.

References position().

Referenced by MatacqProducer::loadOrbitOffset().

{ position(0); }

IOOffset Storage::size ( void  ) const

virtual

Reimplemented in File.

Definition at line 77 of file Storage.cc.

References END, and position().

Referenced by ntupleDataFormat._Collection::__iter__(), ntupleDataFormat._Collection::__len__(), eof(), StorageAccountProxy::prefetch(), LocalCacheFile::readv(), readv(), XrdFile::readv(), 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 ( const void *  from, IOSize  n, IOOffset  pos  )

virtual

Reimplemented in XrdFile, File, StorageAccountProxy, and LocalCacheFile.

Definition at line 44 of file Storage.cc.

References dqmiodumpmetadata::n, and position().

Referenced by 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::write	(	IOBuffer	from,
		IOOffset	pos
	)

Definition at line 42 of file Storage.cc.

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

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

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

virtual

Reimplemented in StorageAccountProxy, and LocalCacheFile.

Definition at line 57 of file Storage.cc.

References data, mps_fire::i, dqmiodumpmetadata::n, hltrates_dqm_sourceclient-live_cfg::offset, size(), dqmMemoryStats::total, and write().

                                                        {
  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;
}