Swi::RSwiObserverSession Class Reference

class Swi::RSwiObserverSession : public RScsClientBase

The SWI Installer uses this class to establish a connection with the SWI Observer and to transfer the log file handle including changed files list.

Inherits from

Public Member Functions
RSwiObserverSession ()
IMPORT_C void AddEventL (const CObservationData &)
IMPORT_C void AddHeaderL (const CObservationHeader &)
IMPORT_C void CancelRegistration ()
IMPORT_C void Close ()
IMPORT_C void CommitL ()
IMPORT_C TInt Connect ()
IMPORT_C void GetFileHandleL ( TDes &)
IMPORT_C void ProcessLogsL ( RFs &)
IMPORT_C void Register ( TRequestStatus &)
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)
RScsClientBase::CallSessionFunction(TInt)const
RScsClientBase::CallSessionFunction(TInt,const TIpcArgs &)const
RScsClientBase::CallSessionFunction(TInt,const TIpcArgs &,TRequestStatus &)const
RScsClientBase::CancelSessionFunction(TInt)const
RScsClientBase::Connect(const TDesC &,const TVersion &,const TDesC &,const TUidType &)
RScsClientBase::RScsClientBase()
RScsClientBase::ResetServerHeapFail()
RScsClientBase::SetServerHeapFail(TInt)
RScsClientBase::ShutdownServer()
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
TThreadId iClientTid
RFile iFile
RFileWriteStream iStream
Inherited Attributes
RHandleBase::iHandle

Constructor & Destructor Documentation

RSwiObserverSession()

IMPORT_C RSwiObserverSession ( )

This constructor provides a single point of definition from which the superclass constructor is called.

Member Functions Documentation

AddEventL(const CObservationData &)

IMPORT_C void AddEventL ( const CObservationData & aData )

Writes an observed SWI event into the shared log file about the file changed by the SWI operation.

Parameters

const CObservationData & aData The observed SWI event.

AddHeaderL(const CObservationHeader &)

IMPORT_C void AddHeaderL ( const CObservationHeader & aHeader )

Writes a SWI observation header into the shared log file about the file changed by the SWI operation.

Parameters

const CObservationHeader & aHeader The observation header.

CancelRegistration()

IMPORT_C void CancelRegistration ( )

Cancels the registration request. This function has no effect if there is no outstanding request.

Close()

IMPORT_C void Close ( )

Closes the SWI Observer connection.

CommitL()

IMPORT_C void CommitL ( )

Notifies the SWI Observer that the SWI operation has been finished successfully.

Connect()

IMPORT_C TInt Connect ( )

Connect to the SWI Observer.

GetFileHandleL(TDes &)

IMPORT_C void GetFileHandleL ( TDes & aFileName )

Requests a file handle from the SWI Observer. Having created a log file (e.g. 1.swi) under its own private folder, the SWI Observer shares the file handle with the process where an instance of this class is working.

Parameters

TDes & aFileName The fully qualified name of the file whose handle was sent by the SWI Observer.

ProcessLogsL(RFs &)

IMPORT_C void ProcessLogsL ( RFs & aFs )

Checks the SWI Observer's flag file to find out if there are some log files to process. If that's the case, it starts up the SWI Observer, if not, then it returns without doing anything.

Parameters

RFs & aFs The file server session handle.

Register(TRequestStatus &)

IMPORT_C void Register ( TRequestStatus & aStatus )

Registers to the SWI Observer. If the SWI Observer processor is busy, the server completes the client when the processor becomes idle.

Parameters

TRequestStatus & aStatus The SWI Observer completes this request object when the SWI Observer Processor becomes idle.

Member Data Documentation

TThreadId iClientTid

TThreadId iClientTid [private]

RFile iFile

RFile iFile [private]

RFileWriteStream iStream

RFileWriteStream iStream [private]