Celartem::PartialStream Class Reference

#include <cel_stream.h>

Inheritance diagram for Celartem::PartialStream:

Public Member Functions
virtual size_t	readBytes (void *buffer, size_t inSize, bool wouldBlock=false)
virtual void	writeBytes (const void *buffer, size_t inSize)
virtual void	flushBuffer ()
virtual bool	isEof () const
virtual void	lock () const
virtual void	unlock () const
Public Member Functions inherited from Celartem::Stream
virtual size_t	duplicateStream (Stream *inStream, size_t inBufferSize=1024, DuplicateStreamCallback inCallback=NULL, void *inCallbackContext=NULL)
virtual size_t	duplicateStreamBytes (Stream *inStream, size_t inMaximumByteSize, size_t inBufferSize=1024, DuplicateStreamCallback inCallback=NULL, void *inCallbackContext=NULL)
Public Member Functions inherited from Celartem::Referable
	Referable ()
void	addRef () const
void	releaseRef () const
size_t	getReferenceCount () const

Static Public Member Functions
static AutoPtr< PartialStream >	create (Stream *inStream, uint64_t inSize)
Static Public Member Functions inherited from Celartem::Referable
static void	dumpDbgAllRefCount ()

Detailed Description

This stream class limits read/write operations to the specified size.

Member Function Documentation

static AutoPtr<PartialStream> Celartem::PartialStream::create ( Stream *  inStream, uint64_t  inSize  )

inlinestatic

This method creates an instance of PartialStream class.

Parameters

inStream	Base stream. The actual operation will be done on the stream.
inSize	The maximum size to read/write.

virtual void Celartem::PartialStream::flushBuffer ( )

inlinevirtual

flushBuffer is provided for the purpose of flushing buffered stream.

Implements Celartem::Stream.

virtual bool Celartem::PartialStream::isEof ( ) const

inlinevirtual

isEof return true if the stream pointer has already reached the end of stream; you should not rely on readBytes to determine the end of stream.

Returns

true if the file pointer reachs EOF, otherwise false.

Implements Celartem::Stream.

virtual void Celartem::PartialStream::lock ( ) const

inlinevirtual

The actual meanings of this method is defined in the derived class.

Implements Celartem::Lockable.

virtual size_t Celartem::PartialStream::readBytes ( void *  buffer, size_t  inSize, bool  wouldBlock = false  )

inlinevirtual

readBytes tries to read bytes from the stream. If wouldBlock is false, readBytes reads the data currenly available and returned immediately; the returned value indicates the bytes actually read and it is no more than inSize. If wouldBlock is true, it blocks until it reads all the bytes specified by inSize parameter. If the stream is potentially read-only and it seems there're no chance to read the bytes specified by inSize, it throws some exception. In the case it throws some exception, the contents in the buffer is invalid and the position of stream pointer is not defined; they are implementation specific.

Parameters

buffer	Pointer to a buffer that receives the data.
inSize	Maximum size to read; readBytes reads data no more than the number of bytes specified by inSize.
wouldBlock	It specifies it blocks until all bytes comes or not.

Returns

readBytes returns the number of bytes read by this call.

Implements Celartem::Stream.

virtual void Celartem::PartialStream::unlock ( ) const

inlinevirtual

The actual meanings of this method is defined in the derived class.

Implements Celartem::Lockable.

virtual void Celartem::PartialStream::writeBytes ( const void *  buffer, size_t  inSize  )

inlinevirtual

writeBytes tries to write the data to the stream. If it could not write all the bytes specified by inSize, it throws some exception, which describes the status. In the case it throws some exception, the position of stream pointer is not defined; it is implementation specific.

Parameters

buffer	Pointer to the buffer that holds the data to be sent.
inSize	the number of bytes to be sent.

Implements Celartem::Stream.

---

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

• cel_stream.h