TStreamMark Class Reference

#include <s32share.h>

class TStreamMark

Public Member Functions
	TStreamMark()
	TStreamMark(TStreamPos)
void	Clear()
void	ExtractL(TStreamExchange &)
TBool	IsEmpty()
TBool	IsWith(TStreamExchange &)
TStreamPos	Position()
TInt	ReadL(TStreamExchange &, TAny *, TInt)
IMPORT_C TInt	ReadL(TStreamExchange &, TDes8 &, TRequestStatus &)
TInt	ReadL(TStreamExchange &, TDes8 &, TInt, TRequestStatus &)
TStreamTransfer	ReadL(TStreamExchange &, MStreamInput &, TStreamTransfer)
TInt	ReadL(TStreamExchange &, MStreamInput &, TInt)
void	ReadL(TStreamExchange &, MStreamInput &)
TBool	RelatesTo(TStreamExchange &)
void	SeekL(TStreamExchange &, TStreamPos)
TStreamPos	SeekL(TStreamExchange &, TStreamLocation, TInt)
TStreamPos	SeekL(TStreamExchange &, TInt)
TStreamPos	TellL(TStreamExchange &)
void	Withdraw(TStreamExchange &)
void	WriteL(TStreamExchange &, const TAny *, TInt)
IMPORT_C TInt	WriteL(TStreamExchange &, const TDesC8 &, TRequestStatus &)
TInt	WriteL(TStreamExchange &, const TDesC8 &, TInt, TRequestStatus &)
TStreamTransfer	WriteL(TStreamExchange &, MStreamOutput &, TStreamTransfer)
TInt	WriteL(TStreamExchange &, MStreamOutput &, TInt)
void	WriteL(TStreamExchange &, MStreamOutput &)
	operator TStreamMark *()
	operator const TStreamMark *()
TBool	operator!=(const TStreamMark &)
TBool	operator!=(const TStreamMark *)
TStreamMark &	operator=(TStreamPos)
TBool	operator==(const TStreamMark &)
TBool	operator==(const TStreamMark *)

Detailed Description

Manages the position of a read mark or a write mark within a shared stream.

A shared stream is one that shares its host with other streams. In practice, the host is a stream buffer that is, itself, hosted by a file, an RFileBuf object.

TStreamMark objects are owned by RShareBuf, one for reading and one for writing. They re-direct read/write operations through a TStreamExchange object to the RFileBuf object, which handles the actual file read and write operations.

See also: RFileBuf RShareBuf TStreamExchange

Constructor & Destructor Documentation

TStreamMark ( )

TStreamMark

(

)

[inline]

Constructs a default shared stream mark object.

The position for the mark is uninitialised.

An uninitialised mark means that a call to IsEmpty() returns true.

TStreamMark ( TStreamPos )

TStreamMark

(

TStreamPos

aPos

)

[inline]

Constructs the shared stream mark object, setting the mark to the specified stream position.

An initialised mark means that a call to IsEmpty() returns false.

Parameters
aPos	The stream position

Member Function Documentation

Clear ( )

void

Clear

(

)

[inline]

Resets the mark object to its default state.

On return from this function, the mark is uninitialised and a call to IsEmpty() returns true.

Empties the object/makes it empty so that IsEmpty() returns false

ExtractL ( TStreamExchange & )

void

ExtractL

(

TStreamExchange &

aHost

)

[inline]

Refreshes this mark from the mark in the host stream buffer and tells the shared streaming manager to drop any reference it has to to this mark object.

Parameters
aHost	The object that manages shared streaming.

IsEmpty ( )

TBool

IsEmpty

(

)

const [inline]

Tests whether this mark object is uninitialised.

Return Value: True, if this mark object is uninitialised; false, otherwise.

IsWith ( TStreamExchange & )

TBool

IsWith

(

TStreamExchange &

aHost

)

const [inline]

Tests whether the specified shared streaming manager currently refers to this mark object.

Parameters
aHost	The object that manages shared streaming.

Return Value: True, if the shared stream manager refers to this mark; false, otherwise.

Position ( )

TStreamPos

Position

(

)

const [inline]

Gets the position of the mark.

Return Value: The stream position.

ReadL ( TStreamExchange &, TAny *, TInt )

TInt	ReadL	(	TStreamExchange &	aHost,
			TAny *	aPtr,
			TInt	aMaxLength
		)	[inline]

Reads data from the shared stream into the specified memory location.

Parameters
aHost	The object that manages shared streaming.
aPtr	A pointer to the target memory location for the data read from the shared stream.
aMaxLength	The maximum number of bytes to be read.

Return Value: The number of bytes read.

ReadL ( TStreamExchange &, TDes8 &, TRequestStatus & )

IMPORT_C TInt	ReadL	(	TStreamExchange &	aHost,
			TDes8 &	aDes,
			TRequestStatus &	aStatus
		)

ReadL ( TStreamExchange &, TDes8 &, TInt, TRequestStatus & )

TInt	ReadL	(	TStreamExchange &	aHost,
			TDes8 &	aDes,
			TInt	aMaxLength,
			TRequestStatus &	aStatus
		)	[inline]

Reads data, asynchronously, from the shared stream into the specified descriptor.

If the function leaves, then no read request will have been initiated.

Parameters
aHost	The object that manages shared streaming.
aDes	The target descriptor for the data read from the shared stream.
aMaxLength	The maximum number of bytes to be read.
aStatus	The request status that indicates the completion status of this asynchronous request.

Return Value: The maximum number of bytes to be read, as used in this request. This can be different to the value supplied in aMaxLength; this is dependent on the implementation of the underlying stream.

ReadL ( TStreamExchange &, MStreamInput &, TStreamTransfer )

TStreamTransfer	ReadL	(	TStreamExchange &	aHost,
			MStreamInput &	anInput,
			TStreamTransfer	aTransfer
		)	[inline]

Reads data from the shared stream into the specified data sink.

Parameters
aHost	The object that manages shared streaming.
anInput	The sink which is the target for the read operation.
aTransfer	Defines the amount of data available to be read from the shared stream.

Return Value: The amount of data that was not consumed.

ReadL ( TStreamExchange &, MStreamInput &, TInt )

TInt	ReadL	(	TStreamExchange &	aHost,
			MStreamInput &	anInput,
			TInt	aMaxLength
		)	[inline]

Reads data from the shared stream into the specified data sink.

Parameters
aHost	The object that manages shared streaming.
anInput	The sink which is the target for the read operation.
aMaxLength	The maximum amount of data available to be read from the shared stream.

Return Value: The amount of data that was not consumed.

ReadL ( TStreamExchange &, MStreamInput & )

void	ReadL	(	TStreamExchange &	aHost,
			MStreamInput &	anInput
		)	[inline]

Reads data from the shared stream into the specified data sink.

No explicit limit is placed on the amount of data that can be read.

Parameters
aHost	The object that manages shared streaming.
anInput	The sink which is the target for the read operation.

RelatesTo ( TStreamExchange & )

TBool

RelatesTo

(

TStreamExchange &

aHost

)

const [inline]

Tests whether the specified shared streaming manager currently refers to this mark object OR whether this mark object is initialised.

Parameters
aHost	The object that manages shared streaming.

Return Value: True, if the shared stream manager refers to this mark OR if this mark object is initialised; false, otherwise.

SeekL ( TStreamExchange &, TStreamPos )

void	SeekL	(	TStreamExchange &	aHost,
			TStreamPos	aPos
		)	[inline]

SeekL ( TStreamExchange &, TStreamLocation, TInt )

TStreamPos	SeekL	(	TStreamExchange &	aHost,
			TStreamLocation	aLocation,
			TInt	anOffset = 0
		)	[inline]

Moves the position of the mark in the host stream.

The new position is calculated by adding the specified offset to one of:

the position of the beginning of the host stream

the position of the end of the host stream

the position of the current mark.

Parameters
aHost	The object that manages shared streaming.
aLocation	The location in the host stream on which the calculation of the new position is based.
anOffset	The offset value.

Return Value: The new position of the mark.

SeekL ( TStreamExchange &, TInt )

TStreamPos	SeekL	(	TStreamExchange &	aHost,
			TInt	anOffset
		)	[inline]

Moves the position of the mark in the host stream.

Parameters
aHost	The object that manages shared streaming.
anOffset	The amount by which the position of the mark is to be moved relative to the existing position of the mark.

Return Value: The new position of the mark.

TellL ( TStreamExchange & )

TStreamPos

TellL

(

TStreamExchange &

aHost

)

const [inline]

Gets the position of the mark within the host stream.

Parameters
aHost	The object that manages shared streaming.

Return Value: The stream position.

Withdraw ( TStreamExchange & )

void

Withdraw

(

TStreamExchange &

aHost

)

[inline]

Instructs the shared streaming manager to remove any reference it has to this mark object.

Parameters
aHost	The object that manages shared streaming.

WriteL ( TStreamExchange &, const TAny *, TInt )

void	WriteL	(	TStreamExchange &	aHost,
			const TAny *	aPtr,
			TInt	aLength
		)	[inline]

Writes data from the specified memory location into the shared stream.

Parameters
aHost	The object that manages shared streaming.
aPtr	A pointer to the memory location from which data is to be written to the shared stream.
aLength	The number of bytes to be written.

WriteL ( TStreamExchange &, const TDesC8 &, TRequestStatus & )

IMPORT_C TInt	WriteL	(	TStreamExchange &	aHost,
			const TDesC8 &	aDes,
			TRequestStatus &	aStatus
		)

Writes data, asynchronously, from the specified descriptor into the shared stream.

The maximum number of bytes to be written is the value of the maximum length of the descriptor.

If the function leaves, then no write request will have been initiated.

Parameters
aHost	The object that manages shared streaming.
aDes	The source descriptor for the data to be written into the shared stream.
aStatus	The request status that indicates the completion status of this asynchronous request.

Return Value: The maximum number of bytes to be written, as used in this request. This can be different to the maximum length of the descriptor; this is dependent on the implementation.

WriteL ( TStreamExchange &, const TDesC8 &, TInt, TRequestStatus & )

TInt	WriteL	(	TStreamExchange &	aHost,
			const TDesC8 &	aDes,
			TInt	aMaxLength,
			TRequestStatus &	aStatus
		)	[inline]

Writes data, asynchronously, from the specified descriptor into the shared stream.

If the function leaves, then no write request will have been initiated.

Parameters
aHost	The object that manages shared streaming.
aDes	The source descriptor for the data to be written into the shared stream.
aMaxLength	The maximum number of bytes to be written.
aStatus	The request status that indicates the completion status of this asynchronous request.

Return Value: The maximum number of bytes to be written, as used in this request. This can be different to the value supplied in aMaxLength; this is dependent on the implementation.

WriteL ( TStreamExchange &, MStreamOutput &, TStreamTransfer )

TStreamTransfer	WriteL	(	TStreamExchange &	aHost,
			MStreamOutput &	anOutput,
			TStreamTransfer	aTransfer
		)	[inline]

Writes data into the shared stream from the specified data source.

Parameters
aHost	The object that manages shared streaming.
anOutput	The data source for the write operation.
aTransfer	Defines the amount of data to be pulled from the output stream object.

Return Value: A stream transfer object defining the amount of data that was not consumed.

WriteL ( TStreamExchange &, MStreamOutput &, TInt )

TInt	WriteL	(	TStreamExchange &	aHost,
			MStreamOutput &	anOutput,
			TInt	aMaxLength
		)	[inline]

Writes data into the shared stream from the specified data source

Parameters
aHost	The object that manages shared streaming.
anOutput	The data source for the write operation.
aMaxLength	The maximum amount of data available to be written.