ByteStreamMarker Class Reference

ByteStreamMarker is an opaque position within a ByteStream. More...

#include <ByteStream.h>

Inheritance diagram for ByteStreamMarker:

List of all members.

Public Member Functions
ByteStream const &	getStream () const
	Returns: marked stream
virtual FileSize	getOffset () const=0
	Returns: byte offset of marked position within stream
Protected Member Functions
	ByteStreamMarker (ByteStream const &stream)
virtual	~ByteStreamMarker ()
Private Attributes
ByteStream const &	stream
	Marked stream.
Friends
class	ByteStream

---

Detailed Description

ByteStreamMarker is an opaque position within a ByteStream.

Stream implementations define derived marker classes containing hidden state. ByteInputStream::newMarker() serves as a factory method for creating new marker instances.

Definition at line 58 of file ByteStream.h.

---

Constructor & Destructor Documentation

ByteStreamMarker::ByteStreamMarker

(

ByteStream const &

stream

)

[explicit, protected]

Definition at line 34 of file ByteStream.cpp.

    : stream(streamInit)
{
}

virtual ByteStreamMarker::~ByteStreamMarker

(

)

[inline, protected, virtual]

Definition at line 69 of file ByteStream.h.

    {
    }

---

Member Function Documentation

ByteStream const & ByteStreamMarker::getStream

(

)

const

Returns:

marked stream

Definition at line 39 of file ByteStream.cpp.

References stream.

Referenced by SegInputStream::mark(), ByteInputStream::mark(), SegInputStream::reset(), and ByteInputStream::reset().

{
    return stream;
}

virtual FileSize ByteStreamMarker::getOffset

(

)

const [pure virtual]

Returns:

byte offset of marked position within stream

Implemented in SequentialByteStreamMarker, and SegStreamMarker.

---

Friends And Related Function Documentation

friend class ByteStream [friend]

Definition at line 60 of file ByteStream.h.

---

Member Data Documentation

ByteStream const& ByteStreamMarker::stream [private]

Marked stream.

Definition at line 65 of file ByteStream.h.

Referenced by getStream().

---

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

• /home/pub/open/dev/fennel/common/ByteStream.h
• /home/pub/open/dev/fennel/common/ByteStream.cpp

---