eckit::SeekableHandle class

Base classes

class DataHandle

Public static functions

static auto classSpec() -> const ClassSpec&

Constructors, destructors, conversion operators

SeekableHandle(PeekHandle*)
SeekableHandle(PeekHandle&)
~SeekableHandle() override
Destructor.

Public functions

auto openForRead() -> Length override
auto read(void*, long) -> long override
void close() override
void rewind() override
void print(std::ostream&) const override
void skip(const Length&) override
auto seek(const Offset&) -> Offset override
auto canSeek() const -> bool override
auto estimate() -> Length override
auto position() -> Offset override
void clear()
void openForWrite(const Length&) virtual
void openForAppend(const Length&) virtual
auto write(const void*, long) -> long virtual
void flush() virtual
auto size() -> Length virtual
void restartReadFrom(const Offset&) virtual
void restartWriteFrom(const Offset&) virtual
auto clone() const -> DataHandle* virtual
auto saveInto(DataHandle&, TransferWatcher& = TransferWatcher::dummy()) -> Length virtual
Save into an other datahandle.
auto saveInto(const PathName&, TransferWatcher& = TransferWatcher::dummy()) -> Length virtual
Save into a file.
auto copyTo(DataHandle&, long bufsize = -1, Length maxsize = -1, TransferWatcher& = TransferWatcher::dummy()) -> Length virtual
auto name() const -> std::string virtual
auto openf(const char* mode, bool delete_on_close = false) -> FILE*
Create a FILE* from this handle.
auto openf(bool delete_on_close = false) -> FILE*
auto compare(DataHandle&) -> bool
Compare bytes.
auto compress(bool = false) -> bool virtual
auto merge(DataHandle*) -> bool virtual
auto isEmpty() const -> bool virtual
auto moveable() const -> bool virtual
void toLocal(Stream& s) const virtual
auto toLocal() -> DataHandle* virtual
void toRemote(Stream& s) const virtual
void selectMover(MoverTransferSelection&, bool read) const virtual
auto metricsTag() const -> std::string virtual
void hash(MD5& md5) const virtual
auto doubleBufferOK() const -> bool virtual
void encode(Stream&) const override
auto reanimator() const -> const ReanimatorBase& override
auto className() const -> std::string virtual

Private functions

auto title() const -> std::string override
void collectMetrics(const std::string& what) const override

Function documentation

static const ClassSpec& eckit::SeekableHandle::classSpec()

void eckit::SeekableHandle::openForWrite(const Length&) virtual

void eckit::SeekableHandle::openForAppend(const Length&) virtual

long eckit::SeekableHandle::write(const void*, long) virtual

void eckit::SeekableHandle::flush() virtual

Length eckit::SeekableHandle::size() virtual

void eckit::SeekableHandle::restartReadFrom(const Offset&) virtual

void eckit::SeekableHandle::restartWriteFrom(const Offset&) virtual

DataHandle* eckit::SeekableHandle::clone() const virtual

Length eckit::SeekableHandle::saveInto(DataHandle&, TransferWatcher& = TransferWatcher::dummy()) virtual

Save into an other datahandle.

Length eckit::SeekableHandle::saveInto(const PathName&, TransferWatcher& = TransferWatcher::dummy()) virtual

Save into a file.

Length eckit::SeekableHandle::copyTo(DataHandle&, long bufsize = -1, Length maxsize = -1, TransferWatcher& = TransferWatcher::dummy()) virtual

Quiet version of saveInto Does not support progess, restart and double buffering

std::string eckit::SeekableHandle::name() const virtual

FILE* eckit::SeekableHandle::openf(const char* mode, bool delete_on_close = false)

Create a FILE* from this handle.

FILE* eckit::SeekableHandle::openf(bool delete_on_close = false)

bool eckit::SeekableHandle::compare(DataHandle&)

Compare bytes.

bool eckit::SeekableHandle::compress(bool = false) virtual

bool eckit::SeekableHandle::merge(DataHandle*) virtual

bool eckit::SeekableHandle::isEmpty() const virtual

bool eckit::SeekableHandle::moveable() const virtual

void eckit::SeekableHandle::toLocal(Stream& s) const virtual

DataHandle* eckit::SeekableHandle::toLocal() virtual

void eckit::SeekableHandle::toRemote(Stream& s) const virtual

void eckit::SeekableHandle::selectMover(MoverTransferSelection&, bool read) const virtual

std::string eckit::SeekableHandle::metricsTag() const virtual

void eckit::SeekableHandle::hash(MD5& md5) const virtual

bool eckit::SeekableHandle::doubleBufferOK() const virtual

void eckit::SeekableHandle::encode(Stream&) const override

const ReanimatorBase& eckit::SeekableHandle::reanimator() const override

std::string eckit::SeekableHandle::className() const virtual