Collapse all Symbian^3 Product Developer Library

REncryptStream Class Reference

class REncryptStream : public RWriteStream

Supports the encryption of a stream.

The stream to be encrypted is a stream represented by an existing RWriteStream object. In effect, REncryptStream forms a layer over the RWriteStream object, either using its target stream buffer or taking complete ownership of the target stream buffer.

Encryption of streamed data is supported using the TEncryptFilter class derived from TStreamFilter. Encryption itself is performed by an instance of a class implementing the CPBEncryptionBase interface.

TEncryptFilter TStreamFilter CPBEncryptionBase

Inherits from

REncryptStream
- RWriteStream

Public Member Functions
	REncryptStream()
	REncryptStream(const MExternalizer< TStreamRef > &)
IMPORT_C void	AttachL(RWriteStream &, const CPBEncryptionBase &)
IMPORT_C void	AttachLC(RWriteStream &, const CPBEncryptionBase &)
IMPORT_C void	OpenL(RWriteStream &, const CPBEncryptionBase &)
IMPORT_C void	OpenLC(RWriteStream &, const CPBEncryptionBase &)

Inherited Functions
	RWriteStream::Attach(MStreamBuf *)
	RWriteStream::Close()
	RWriteStream::CommitL()
	RWriteStream::Detach()
	RWriteStream::Pop()
	RWriteStream::PushL()
	RWriteStream::RWriteStream()
	RWriteStream::RWriteStream(MStreamBuf *)
	RWriteStream::RWriteStream(const MExternalizer< TStreamRef > &)
	RWriteStream::Release()
	RWriteStream::Sink()
	RWriteStream::WriteInt16L(TInt)
	RWriteStream::WriteInt32L(TInt32)
	RWriteStream::WriteInt8L(TInt)
	RWriteStream::WriteL(RReadStream &)
	RWriteStream::WriteL(RReadStream &,TInt)
	RWriteStream::WriteL(const TDesC16 &)
	RWriteStream::WriteL(const TDesC16 &,TInt)
	RWriteStream::WriteL(const TDesC8 &)
	RWriteStream::WriteL(const TDesC8 &,TInt)
	RWriteStream::WriteL(const TUint16 *,TInt)
	RWriteStream::WriteL(const TUint8 *,TInt)
	RWriteStream::WriteReal32L(TReal)
	RWriteStream::WriteReal64L(TReal64)
	RWriteStream::WriteUint16L(TUint)
	RWriteStream::WriteUint32L(TUint32)
	RWriteStream::WriteUint8L(TUint)

Private Attributes
TEncryptFilter	iFilter

Constructor & Destructor Documentation

REncryptStream()

REncryptStream

(

)

[inline]

Constructs an empty encrypting stream object.

Call OpenL() or OpenLC() to use a target stream owned by an existing write stream interface object, a RWriteStream.

Call AttachL() or AttachLC() to use and take ownership of a target stream owned by an existing write stream interface object.

REncryptStream(const MExternalizer< TStreamRef > &)

REncryptStream

(

const MExternalizer< TStreamRef > &

anExter

)

[inline]

Parameters

const MExternalizer< TStreamRef > & anExter

Member Functions Documentation

AttachL(RWriteStream &, const CPBEncryptionBase &)

IMPORT_C void	AttachL	(	RWriteStream &	aHost,
			const CPBEncryptionBase &	aKey
		)

Attach an encrypting write stream to aHost. Takes ownership of the target stream owned by the specified write stream interface object, and prepares the stream for writing through an encrypting filter.

leave: KErrNoMemory

Parameters

RWriteStream & aHost	The write stream interface object for the target stream
const CPBEncryptionBase & aKey	A Password Based Encryption object for encryption handling.

AttachLC(RWriteStream &, const CPBEncryptionBase &)

IMPORT_C void	AttachLC	(	RWriteStream &	aHost,
			const CPBEncryptionBase &	aKey
		)

Attach an encrypting write stream to aHost. Takes ownership of the target stream owned by the specified write stream interface object, prepares the stream for writing through an encrypting filter, and puts a cleanup item onto the cleanup stack.

leave: KErrNoMemory

Parameters

RWriteStream & aHost	The write stream interface object for the target stream
const CPBEncryptionBase & aKey	A Password Based Encryption object for encryption handling.

OpenL(RWriteStream &, const CPBEncryptionBase &)

IMPORT_C void	OpenL	(	RWriteStream &	aHost,
			const CPBEncryptionBase &	aKey
		)

Open an encrypting write stream over aHost. Prepares the target stream owned by the specified write stream interface object for writing through an encrypting filter.

leave: KErrNoMemory

Parameters

RWriteStream & aHost	The write stream interface object for the target stream. The function does not take ownership of the target stream.
const CPBEncryptionBase & aKey	A Password Based Encryption object for encryption handling.

OpenLC(RWriteStream &, const CPBEncryptionBase &)

IMPORT_C void	OpenLC	(	RWriteStream &	aHost,
			const CPBEncryptionBase &	aKey
		)

Open an encrypting write stream over aHost. Prepares the target stream owned by the specified write stream interface object for writing through an encrypting filter and puts a cleanup item onto the cleanup stack.

leave: KErrNoMemory

Parameters

RWriteStream & aHost	The write stream interface object for the target stream. The function does not take ownership of the target stream.
const CPBEncryptionBase & aKey	A Password Based Encryption object for encryption handling.

Member Data Documentation

TEncryptFilter iFilter

TEncryptFilter

iFilter

[private]