![Symbian Developer Library](../../../../a_stock/images/mainheading.gif)
![]() |
![]() |
|
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.
RHandleBase
- A handle to an object.
RSessionBase
-
Client-side handle to a session with a server.
RSyncMLSession
- A client handle to a SyncML Sync Agent session.
Defined in RSyncMLSession
:
CancelEvent()
Cancels an outstanding session event request.CancelProgress()
Cancels an outstanding request for progress events.Close()
Close the session, freeing all resources.CurrentJobL(TSmlJobId &,TSmlUsageType &)const
Gets information about a currently running job.DeleteProfileL(TSmlProfileId)
Deletes the profile with the specified ID.ListDataProvidersL(RArray< TSmlDataProviderId > &)const
Gets a list of IDs of all available data providers.ListProfilesL(RArray< TSmlProfileId > &,TSmlUsageType)const
Gets a list of IDs of all defined profiles of the specified type.ListQueuedJobsL(RArray< TSmlJobId > &,TSmlUsageType)const
Gets a list of IDs of all queued jobs of the specified type.ListTransportsL(RArray< TSmlTransportId > &)const
Gets a list of IDs of all available communications transports.OpenL()
Opens a new session with the SyncML Sync Agent.RSyncMLSession()
Default constructor.RequestEventL(MSyncMLEventObserver &)
Requests notification of session events.RequestProgressL(MSyncMLProgressObserver &)
Requests notification of progress events from data synchronisation and device ma...Inherited from RHandleBase
:
Attributes()const
BTraceId()const
Returns a unique object identifier for use with BTrace
Duplicate(const RThread &,TOwnerType)
Creates a valid handle to the kernel object for which the specified thread alrea...FullName()const
Gets the full name of the handle.FullName(TDes &)const
Gets the full name of the handle.Handle()const
Retrieves the handle-number of the object associated with this handle.HandleInfo(THandleInfo *)
Gets information about the handle.Name()const
Gets the name of the handle.Open(const TFindHandleBase &,TOwnerType)
Opens a handle to a kernel side object found using a find-handle object.RHandleBase(TInt)
Copy constructor.SetHandle(TInt)
Sets the handle-number of this handle to the specified value.SetHandleNC(TInt)
Sets the handle-number of this handle to the specified value, and marks it as no...iHandle
Inherited from RSessionBase
:
CreateSession(RServer2,const TVersion &)
Creates a session with a server, specifying no message slots.CreateSession(RServer2,const TVersion &,TInt)
Creates a session with a server.CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
Creates a session with a server.CreateSession(const TDesC &,const TVersion &)
Creates a session with a server, specifying no message slots.CreateSession(const TDesC &,const TVersion &,TInt)
Creates a session with a server.CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
Creates a session with a server.CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
EAutoAttach
EExplicitAttach
Open(RMessagePtr2,TInt,TOwnerType)
Opens a handle to a session using a handle number sent by a client to a server.Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
Opens a handle to a session using a handle number sent by a client to a server, ...Open(TInt,TOwnerType)
Opens a handle to a session using a handle number passed as an environment data ...Open(TInt,const TSecurityPolicy &,TOwnerType)
Opens a handle to a session using a handle number passed as an environment data ...Send(TInt)const
Issues a blind request to the server with the specified function number, but wit...Send(TInt,const TIpcArgs &)const
Issues a blind request to the server with the specified function number, and arg...SendReceive(TInt)const
Issues a synchronous request to the server with the specified function number, b...SendReceive(TInt,TRequestStatus &)const
Issues an asynchronous request to the server with the specified function number,...SendReceive(TInt,const TIpcArgs &)const
Issues a synchronous request to the server with the specified function number an...SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
Issues an asynchronous request to the server with the specified function number ...SetReturnedHandle(TInt)
Sets the handle-number of this handle to the specified value.SetReturnedHandle(TInt,RHandleBase &)
SetReturnedHandle(TInt,const TSecurityPolicy &)
Sets the handle-number of this session handle to the specified value after valid...ShareAuto()
Creates a session that can be shared by other threads in the current process.ShareProtected()
Creates a session handle that can be be passed via IPC to another process as wel...TAttachMode
Indicates whether or not threads in the process are automatically attached to th...IMPORT_C void OpenL();
Opens a new session with the SyncML
Sync Agent.
|
IMPORT_C void RequestEventL(MSyncMLEventObserver &);
The session is open.
Requests notification of session events.
Events will continue to be delivered to the supplied observer until the session is closed or RSyncMLSession::CancelEvent()
is called.
|
|
IMPORT_C void CancelEvent();
The session is open.
Cancels an outstanding session event request.
IMPORT_C void RequestProgressL(MSyncMLProgressObserver &);
The session is open.
Requests notification of progress events from data synchronisation and device management jobs.
There need not be a job in progress when this method is called, but no events are received until a job is running.
|
|
IMPORT_C void CurrentJobL(TSmlJobId &, TSmlUsageType &) const;
The session is open.
Gets information about a currently running job.
|
|
IMPORT_C void ListQueuedJobsL(RArray< TSmlJobId > &, TSmlUsageType) const;
The session is open.
Gets a list of IDs of all queued jobs of the specified type.
|
|
IMPORT_C void ListProfilesL(RArray< TSmlProfileId > &, TSmlUsageType) const;
The session is open.
Gets a list of IDs of all defined profiles of the specified type.
|
|
IMPORT_C void ListTransportsL(RArray< TSmlTransportId > &) const;
The session is open.
Gets a list of IDs of all available communications transports.
|
|
IMPORT_C void ListDataProvidersL(RArray< TSmlDataProviderId > &) const;
The session is open.
Gets a list of IDs of all available data providers.
|
|
Capability: | WriteDeviceData |
IMPORT_C void DeleteProfileL(TSmlProfileId);
The session is open.
Deletes the profile with the specified ID.
|
|
IMPORT_C void Close();
All dependant sub-sessions have been closed.
Close the session, freeing all resources.