Collapse all Symbian^3 Application Developer Library

MSyncMLEventObserver Class Reference

class MSyncMLEventObserver

Interface to receive notifications of SyncML session events.

Notifications are requested through RSyncMLSession::RequestEventL() .

Public Member Functions
void	OnSyncMLSessionEvent ( TEvent , TInt , TInt , TInt )

Public Member Enumerations
enum	TEvent { EJobStart , EJobStartFailed , EJobStop , EJobRejected , EProfileCreated , EProfileChanged , EProfileDeleted , ETransportTimeout , EServerSuspended , EServerTerminated }

Member Functions Documentation

OnSyncMLSessionEvent(TEvent, TInt, TInt, TInt)

void	OnSyncMLSessionEvent	(	TEvent	aEvent,
			TInt	aIdentifier,
			TInt	aError,
			TInt	aAdditionalData
		)	[pure virtual]

Receives a SyncML session event.

The following table lists the meaning of the identifier and error parameters for the various event types.

         TEvent				aIdentifier		aError		aAdditionalData	
EJobStart			ID of the new job.	KErrNone.	KUnusedAdditionalData.
EJobStartFailed			Unused.			Reason for fail.	KUnusedAdditionalData.
EJobStop			ID of the job.		Completion code.	KUnusedAdditionalData.
EJobRejected			Unused.			Reason for rejection.	KUnusedAdditionalData.
EProfileCreated			ID of the profile.	Unused.	The usage type( either ESmlDataSync or ESmlDevMan) or an error code.
EProfileChanged			ID of the profile.	Unused.	The usage type( either ESmlDataSync or ESmlDevMan) or an error code.
EProfileDeleted			ID of the profile.	Unused.	KUnusedAdditionalData.
ETransportTimeout		ID of the transport.	KErrTimedOut.	KUnusedAdditionalData.
EServerSuspended		Non-zero if the server	KErrNone when entering. When exiting,  
				is entering suspended 	any error encountered when reloading data.	KUnusedAdditionalData.
				state, zero on exiting.			
EServerTerminated		Unused.			KErrServerTerminated.	KUnusedAdditionalData.

Parameters

TEvent aEvent	Event type.
TInt aIdentifier	When the event relates to an object with an ID (job or profile), the ID.
TInt aError	When the event relates to an error, the error code.
TInt aAdditionalData	The value of this parameter can be: KUnusedAdditionalData if additional data are unavailable, ESmlDataSync if the event is generated during a Data Sync session, ESmlDevMan if the event is generated during a Device Management session

Member Enumerations Documentation

Enum TEvent

SyncML session event types.

Enumerators

EJobStart	Job has started.
EJobStartFailed	Job has failed to start.
EJobStop	Job has stopped.
EJobRejected	Job could not be parsed, and will not be processed.
EProfileCreated	A profile has been created.
EProfileChanged	A profile has been changed.
EProfileDeleted	A profile has been deleted.
ETransportTimeout	A transport has timed-out.
EServerSuspended	The SyncML Agent is suspended. This can occur when processing pauses in order to perform a back-up.
EServerTerminated	The SyncML Agent has shutdown.