MSmlSyncRelationship Class Reference

#include <syncml/SmlDataSyncDefs.h>

class MSmlSyncRelationship
Public Member Functions
pure virtual TBool IsStreamPresentL(TUid)
pure virtual voidOpenReadStreamLC(RReadStream &, TUid)
pure virtual voidOpenWriteStreamLC(RWriteStream &, TUid)
pure virtual TSmlSyncTaskKey SyncTaskKey()

Detailed Description

SyncML store interface exposed to Database Adaptor implementations. This interface may be used by a DBA to store change information for a Data Store, in the context of a sync relationship with a remote Data Store. It is vital for correct synchronisation behaviour that change information is stored separately for different remote Data Stores. This interface facilitates this by providing streams that are stored against specific Sync Tasks, and a unique key that identifies the sync relationship.

Member Function Documentation

IsStreamPresentL ( TUid )

TBool IsStreamPresentL(TUidaStreamUid)const [pure virtual]

Tests if the specified stream identified exists in the store.

ParameterDescription
aStreamUidThe stream UID

Returns: Non-zero if the stream exists, otherwise EFalse.

OpenReadStreamLC ( RReadStream &, TUid )

voidOpenReadStreamLC(RReadStream &aReadStream,
TUidaStreamUid
)[pure virtual]

Opens a specified stream for reading, and places an item on the cleanup stack to close it.

ParameterDescription
aReadStreamOn return, an open read stream
aStreamUidThe UID of the stream to open for reading.

OpenWriteStreamLC ( RWriteStream &, TUid )

voidOpenWriteStreamLC(RWriteStream &aWriteStream,
TUidaStreamUid
)[pure virtual]

Opens the specified stream, or creates a new one if it does not exist, and places an item on the cleanup stack to close it.

ParameterDescription
aWriteStreamOn return, an open write stream
aStreamUidThe UID of the stream to open or create

SyncTaskKey ( )

TSmlSyncTaskKey SyncTaskKey()const [pure virtual]

Returns the unique identifier for the synchronisation relationship.

Returns: A unique identifier for the sync relationship.