The Nebula Device 3: IO::Stream Class Reference

The Nebula Device 3

IO::Stream Class Reference

#include <stream.h>

Inheritance diagram for IO::Stream:

Core::RefCounted IO::FileStream IO::MemoryStream IO::ZipFileStream

Detailed Description

Offers an abstract interface for read/write access to a sequence of bytes. Base class for all classes which need to provide a read/write interface to data, like a FileStream, a MemoryStream, etc...

Stream objects can be accessed directly, or through stream reader and writer classes, which offer specific read/writing interfaces to streams.

(C) 2006 Radon Labs GmbH

Public Types

enum  AccessMode
 access modes
enum  AccessPattern
 access prefered pattern
enum  SeekOrigin
 seek origins
typedef int Position
 typedefs

Public Member Functions

 Stream ()
 constructor
virtual ~Stream ()
 destructor
void SetURI (const URI &u)
 set stream location as URI
const URIGetURI () const
 get stream URI
virtual bool CanRead () const
 return true if the stream supports reading
virtual bool CanWrite () const
 return true if the stream supports writing
virtual bool CanSeek () const
 return true if the stream supports seeking
virtual bool CanBeMapped () const
 return true if the stream provides direct memory access
virtual void SetSize (Size s)
 set a new size for the stream
virtual Size GetSize () const
 get the size of the stream in bytes
virtual Position GetPosition () const
 get the current position of the read/write cursor
void SetAccessMode (AccessMode m)
 set the access mode of the stream (default is ReadAccess)
AccessMode GetAccessMode () const
 get the access mode of the stream
void SetAccessPattern (AccessPattern p)
 set the prefered access pattern (default is Sequential)
AccessPattern GetAccessPattern () const
 get the prefered access pattern
void SetMediaType (const MediaType &t)
 set optional media type of stream content
const MediaTypeGetMediaType () const
 get optional media type
virtual bool Open ()
 open the stream
virtual void Close ()
 close the stream
bool IsOpen () const
 return true if currently open
virtual void Write (const void *ptr, Size numBytes)
 directly write to the stream
virtual Size Read (void *ptr, Size numBytes)
 directly read from the stream
virtual void Seek (Offset offset, SeekOrigin origin)
 seek in stream
virtual void Flush ()
 flush unsaved data
virtual bool Eof () const
 return true if end-of-stream reached
virtual void * Map ()
 map stream to memory
virtual void Unmap ()
 unmap stream
bool IsMapped () const
 return true if stream is currently mapped to memory
int GetRefCount () const
 get the current refcount
void AddRef ()
 increment refcount by one
void Release ()
 decrement refcount and destroy object if refcount is zero
bool IsInstanceOf (const Rtti &rtti) const
 return true if this object is instance of given class
bool IsInstanceOf (const Util::String &className) const
 return true if this object is instance of given class by string
bool IsInstanceOf (const Util::FourCC &classFourCC) const
 return true if this object is instance of given class by fourcc
bool IsA (const Rtti &rtti) const
 return true if this object is instance of given class, or a derived class
bool IsA (const Util::String &rttiName) const
 return true if this object is instance of given class, or a derived class, by string
bool IsA (const Util::FourCC &rttiFourCC) const
 return true if this object is instance of given class, or a derived class, by fourcc
const Util::StringGetClassName () const
 get the class name
Util::FourCC GetClassFourCC () const
 get the class FourCC code

Static Public Member Functions

static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

Member Function Documentation

void IO::Stream::SetURI ( const URI u  ) 

set stream location as URI

Set the URI of the stream as string. The URI identifies the source resource of the stream.

const URI & IO::Stream::GetURI (  )  const

get stream URI

Get the URI of the stream as string.

bool IO::Stream::CanRead (  )  const [virtual]

return true if the stream supports reading

This method must return true if the derived stream class supports reading.

Reimplemented in IO::FileStream, IO::MemoryStream, and IO::ZipFileStream.

bool IO::Stream::CanWrite (  )  const [virtual]

return true if the stream supports writing

This method must return true if the derived stream class supports writing.

Reimplemented in IO::FileStream, IO::MemoryStream, and IO::ZipFileStream.

bool IO::Stream::CanSeek (  )  const [virtual]

return true if the stream supports seeking

This method must return true if the derived stream supports seeking.

Reimplemented in IO::FileStream, IO::MemoryStream, and IO::ZipFileStream.

bool IO::Stream::CanBeMapped (  )  const [virtual]

return true if the stream provides direct memory access

This method must return true if the stream supports direct memory access through the Map()/Unmap() methods.

Reimplemented in IO::FileStream, IO::MemoryStream, and IO::ZipFileStream.

void IO::Stream::SetSize ( Size  s  )  [virtual]

set a new size for the stream

This sets a new size for the stream. Not all streams support this method. If the new size if smaller then the existing size, the contents will be clipped.

Stream::Size IO::Stream::GetSize (  )  const [virtual]

get the size of the stream in bytes

This method returns the size of the stream in bytes.

Reimplemented in IO::FileStream, IO::MemoryStream, and IO::ZipFileStream.

Stream::Position IO::Stream::GetPosition (  )  const [virtual]

get the current position of the read/write cursor

This method returns the current position of the read/write cursor.

Reimplemented in IO::FileStream, IO::MemoryStream, and IO::ZipFileStream.

void IO::Stream::SetAccessMode ( AccessMode  m  ) 

set the access mode of the stream (default is ReadAccess)

This method sets the intended access mode of the stream. The actual behaviour depends on the implementation of the derived class. The default is ReadWrite.

Stream::AccessMode IO::Stream::GetAccessMode (  )  const

get the access mode of the stream

Get the access mode of the stream.

void IO::Stream::SetAccessPattern ( AccessPattern  p  ) 

set the prefered access pattern (default is Sequential)

Set the prefered access pattern of the stream. This can be Random or Sequential. This is an optional flag to improve performance with some stream implementations. The default is sequential. The pattern cannot be changed while the stream is open.

Stream::AccessPattern IO::Stream::GetAccessPattern (  )  const

get the prefered access pattern

Get the currently set prefered access pattern of the stream.

bool IO::Stream::Open (  )  [virtual]

open the stream

Open the stream. Only one thread may open a stream at any time. Returns true if succeeded.

Reimplemented in IO::FileStream, IO::MemoryStream, and IO::ZipFileStream.

void IO::Stream::Close (  )  [virtual]

close the stream

Closes the stream.

Reimplemented in IO::FileStream, IO::MemoryStream, and IO::ZipFileStream.

bool IO::Stream::IsOpen (  )  const

return true if currently open

Return true if the stream is currently open.

void IO::Stream::Write ( const void *  ptr,
Size  numBytes 
) [virtual]

directly write to the stream

Write raw data to the stream. For more convenient writing, attach the stream to an IO::StreamWriter object. This method is only valid if the stream class returns true in CanWrite().

Stream::Size IO::Stream::Read ( void *  ptr,
Size  numBytes 
) [virtual]

directly read from the stream

Read raw data from the stream. For more convenient reading, attach the stream to an IO::StreamReader object. The method returns the number of bytes actually read. This method is only valid if the stream class returns true in CanRead(). Returns the number of bytes actually read from the stream, this may be less then numBytes, or 0 if end-of-stream is reached.

void IO::Stream::Seek ( Offset  offset,
SeekOrigin  origin 
) [virtual]

seek in stream

Move the read/write cursor to a new position, returns the new position in the stream. This method is only supported if the stream class returns true in CanSeek().

void IO::Stream::Flush (  )  [virtual]

flush unsaved data

Flush any unsaved data. Note that unsaved data will also be flushed automatically when the stream is closed.

Reimplemented in IO::FileStream.

bool IO::Stream::Eof (  )  const [virtual]

return true if end-of-stream reached

Return true if the read/write cursor is at the end of the stream.

Reimplemented in IO::FileStream, IO::MemoryStream, and IO::ZipFileStream.

void * IO::Stream::Map (  )  [virtual]

map stream to memory

If the stream provides memory mapping, this method will return a pointer to the beginning of the stream data in memory. The application is free to read and write to the stream through direct memory access. Special care must be taken to not read or write past the end of the mapped data (indicated by GetSize()). The normal Read()/Write() method are not valid while the stream is mapped, also the read/write cursor position will not be updated.

Reimplemented in IO::FileStream, IO::MemoryStream, and IO::ZipFileStream.

void IO::Stream::Unmap (  )  [virtual]

unmap stream

This will unmap a memory-mapped stream.

Reimplemented in IO::FileStream, IO::MemoryStream, and IO::ZipFileStream.

bool IO::Stream::IsMapped (  )  const

return true if stream is currently mapped to memory

Returns true if the stream is currently mapped.

int Core::RefCounted::GetRefCount (  )  const [inline, inherited]

get the current refcount

Return the current refcount of the object.

void Core::RefCounted::AddRef (  )  [inline, inherited]

increment refcount by one

Increment the refcount of the object.

void Core::RefCounted::Release (  )  [inline, inherited]

decrement refcount and destroy object if refcount is zero

Decrement the refcount and destroy object if refcount is zero.

const Util::String & Core::RefCounted::GetClassName (  )  const [inline, inherited]

get the class name

Get the class name of the object.

Util::FourCC Core::RefCounted::GetClassFourCC (  )  const [inline, inherited]

get the class FourCC code

Get the class FourCC of the object.

void Core::RefCounted::DumpRefCountingLeaks (  )  [static, inherited]

dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

This method should be called as the very last before an application exits.