Symbian^3 Application Developer Library >

RSyncMLSession Class Reference

class RSyncMLSession : public RSessionBase

A client handle to a SyncML Sync Agent session.

An instance of this class must be created in order to instantiate any of the other client-side classes.

Accessor methods are provided to enable clients to retrieve identifiers of current and queued jobs, and of available profiles, transports, and data providers. These IDs can be used to open handles on these objects in order to manipulate them.

Clients can request notifications of events related to jobs, profiles, transports, and the SyncML Agent, and can request progress for the currently running job.

Inherits from

Public Member Functions
RSyncMLSession ()
IMPORT_C void CancelEvent ()
IMPORT_C void CancelProgress ()
IMPORT_C void Close ()
IMPORT_C void CurrentJobL ( TSmlJobId &, TSmlUsageType &)
IMPORT_C void DeleteProfileL ( TSmlProfileId )
IMPORT_C void ListDataProvidersL ( RArray < TSmlDataProviderId > &)
IMPORT_C void ListProfilesL ( RArray < TSmlProfileId > &, TSmlUsageType )
IMPORT_C TSmlProtocolVersion ListProtocolVersionsL ( TSmlUsageType , RArray < TSmlProtocolVersion > &)
IMPORT_C void ListQueuedJobsL ( RArray < TSmlJobId > &, TSmlUsageType )
IMPORT_C void ListTransportsL ( RArray < TSmlTransportId > &)
IMPORT_C void OpenL ()
IMPORT_C void RequestEventL ( MSyncMLEventObserver &)
IMPORT_C void RequestProgressL ( MSyncMLProgressObserver &)
IMPORT_C void _DbgTestSettingL ( TInt , TInt )
Private Member Functions
RSyncMLSession (const RSyncMLSession &)
void ReceiveArrayL ( RArray < TInt > &, TInt , TInt , TInt )
RSyncMLSession & operator= (const RSyncMLSession &)
Inherited Functions
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
RHandleBase::DoExtendedClose()
RHandleBase::Duplicate(const RThread &,TOwnerType)
RHandleBase::FullName()const
RHandleBase::FullName(TDes &)const
RHandleBase::Handle()const
RHandleBase::HandleInfo(THandleInfo *)
RHandleBase::Name()const
RHandleBase::NotifyDestruction(TRequestStatus &)
RHandleBase::Open(const TFindHandleBase &,TOwnerType)
RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
RHandleBase::RHandleBase()
RHandleBase::RHandleBase(TInt)
RHandleBase::SetHandle(TInt)
RHandleBase::SetHandleNC(TInt)
RSessionBase::CreateSession(RServer2,const TVersion &)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Open(TInt,TOwnerType)
RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Send(TInt)const
RSessionBase::Send(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt)const
RSessionBase::SendReceive(TInt,TRequestStatus &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSessionBase::SetReturnedHandle(TInt)
RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
RSessionBase::ShareAuto()
RSessionBase::ShareProtected()
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
Private Attributes
CClientSessionData * iData
CSmlActiveCallback * iEventCallback
Inherited Attributes
RHandleBase::iHandle

Constructor & Destructor Documentation

RSyncMLSession()

IMPORT_C RSyncMLSession ( )

RSyncMLSession(const RSyncMLSession &)

RSyncMLSession ( const RSyncMLSession & ) [private]

Parameters

const RSyncMLSession &

Member Functions Documentation

CancelEvent()

IMPORT_C void CancelEvent ( )

CancelProgress()

IMPORT_C void CancelProgress ( )

Close()

IMPORT_C void Close ( )

CurrentJobL(TSmlJobId &, TSmlUsageType &)

IMPORT_C void CurrentJobL ( TSmlJobId & ,
TSmlUsageType &
) const

Parameters

TSmlJobId &
TSmlUsageType &

DeleteProfileL(TSmlProfileId)

IMPORT_C void DeleteProfileL ( TSmlProfileId )

Parameters

TSmlProfileId

ListDataProvidersL(RArray< TSmlDataProviderId > &)

IMPORT_C void ListDataProvidersL ( RArray < TSmlDataProviderId > & ) const

Parameters

RArray < TSmlDataProviderId > &

ListProfilesL(RArray< TSmlProfileId > &, TSmlUsageType)

IMPORT_C void ListProfilesL ( RArray < TSmlProfileId > & ,
TSmlUsageType
) const

Parameters

RArray < TSmlProfileId > &
TSmlUsageType

ListProtocolVersionsL(TSmlUsageType, RArray< TSmlProtocolVersion > &)

IMPORT_C TSmlProtocolVersion ListProtocolVersionsL ( TSmlUsageType ,
RArray < TSmlProtocolVersion > &
) const

Parameters

TSmlUsageType
RArray < TSmlProtocolVersion > &

ListQueuedJobsL(RArray< TSmlJobId > &, TSmlUsageType)

IMPORT_C void ListQueuedJobsL ( RArray < TSmlJobId > & ,
TSmlUsageType
) const

Parameters

RArray < TSmlJobId > &
TSmlUsageType

ListTransportsL(RArray< TSmlTransportId > &)

IMPORT_C void ListTransportsL ( RArray < TSmlTransportId > & ) const

Parameters

RArray < TSmlTransportId > &

OpenL()

IMPORT_C void OpenL ( )

ReceiveArrayL(RArray< TInt > &, TInt, TInt, TInt)

void ReceiveArrayL ( RArray < TInt > & ,
TInt ,
TInt ,
TInt
) const [private]

Parameters

RArray < TInt > &
TInt
TInt
TInt

RequestEventL(MSyncMLEventObserver &)

IMPORT_C void RequestEventL ( MSyncMLEventObserver & )

Parameters

MSyncMLEventObserver &

RequestProgressL(MSyncMLProgressObserver &)

IMPORT_C void RequestProgressL ( MSyncMLProgressObserver & )

Parameters

MSyncMLProgressObserver &

_DbgTestSettingL(TInt, TInt)

IMPORT_C void _DbgTestSettingL ( TInt aSetting,
TInt aParam
)

Parameters

TInt aSetting
TInt aParam

operator=(const RSyncMLSession &)

RSyncMLSession & operator= ( const RSyncMLSession & ) [private]

Parameters

const RSyncMLSession &

Member Data Documentation

CClientSessionData * iData

CClientSessionData * iData [private]

CSmlActiveCallback * iEventCallback

CSmlActiveCallback * iEventCallback [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.