Symbian^3 Product Developer Library >

CFsPlugin Class Reference

class CFsPlugin : public CFsObject

A base class for File Server Plugins

Inherits from

Public Member Functions
CFsPlugin()
~CFsPlugin()
TInt Drive()
TInt SessionDisconnect(CSessionFs *)
voidSetDrive(TInt)
Protected Member Functions
IMPORT_C TIntClientRead(TFsPluginRequest &, TDes8 &, TInt)
IMPORT_C TIntClientWrite(TFsPluginRequest &, const TDesC8 &, TInt)
IMPORT_C TIntDeliver(TFsPluginRequest &)
TInt DoRequestL(TFsPluginRequest &)
IMPORT_C TIntFileRead(TFsPluginRequest &, TDes8 &, TInt64)
IMPORT_C TIntFileWrite(TFsPluginRequest &, const TDesC8 &, TInt64)
IMPORT_C voidInitialiseL()
TBool IsMounted(TInt)
TBool IsPluginThread(CFsRequest &)
TBool IsRegistered(TInt)
TBool IsRegistered(TInt, TInterceptAtts)
IMPORT_C CFsPluginConn *NewPluginConnL()
IMPORT_C TIntRegisterIntercept(TInt, TInterceptAtts)
IMPORT_C TIntUnregisterIntercept(TInt, TInterceptAtts)
Private Member Functions
TInt Complete(CFsRequest *, TInt)
TInt Complete(CFsRequest *)
TInt DispatchOperation(TFsPluginRequest &, TDes8 &, TInt64, TInt)
TInt WaitForRequest()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CFsObject::CFsObject()
CFsObject::Close()
CFsObject::Container()const
CFsObject::Dec()
CFsObject::DoClose()
CFsObject::Inc()
CFsObject::IsCorrectThread()
CFsObject::Name()const
CFsObject::Open()
CFsObject::SetName(const TDesC *)
CFsObject::UniqueID()const
CFsObject::~CFsObject()
Protected Member Enumerations
enumTInterceptAtts { EPreIntercept = 0x01, EPostIntercept = 0x02, EPrePostIntercept = EPreIntercept | EPostIntercept }
Protected Attributes
TThreadId iThreadId
Private Attributes
TInt iDrive
TInt iLastError
TInt iMountedOn
const TUintiReadOnly
TUint8 iRegisteredIntercepts
TUint iSpare
CPluginThread *iThreadP
TInt iUniquePos

Constructor & Destructor Documentation

CFsPlugin()

IMPORT_CCFsPlugin()

~CFsPlugin()

IMPORT_C~CFsPlugin()

Member Functions Documentation

ClientRead(TFsPluginRequest &, TDes8 &, TInt)

IMPORT_C TIntClientRead(TFsPluginRequest &aRequest,
TDes8 &aDes,
TIntaOffset = 0
)[protected, static]

Parameters

TFsPluginRequest & aRequest
TDes8 & aDes
TInt aOffset = 0

ClientWrite(TFsPluginRequest &, const TDesC8 &, TInt)

IMPORT_C TIntClientWrite(TFsPluginRequest &aRequest,
const TDesC8 &aDes,
TIntaOffset = 0
)[protected, static]

Parameters

TFsPluginRequest & aRequest
const TDesC8 & aDes
TInt aOffset = 0

Complete(CFsRequest *, TInt)

TInt Complete(CFsRequest *aRequest,
TIntaError
)[private, static]

Parameters

CFsRequest * aRequest
TInt aError

Complete(CFsRequest *)

TInt Complete(CFsRequest *aRequest)[private, static]

Parameters

CFsRequest * aRequest

Deliver(TFsPluginRequest &)

IMPORT_C TIntDeliver(TFsPluginRequest &aRequest)[protected, virtual]

Parameters

TFsPluginRequest & aRequest

DispatchOperation(TFsPluginRequest &, TDes8 &, TInt64, TInt)

TInt DispatchOperation(TFsPluginRequest &aRequest,
TDes8 &aDes,
TInt64aPos,
TIntaFunction
)[private]

Parameters

TFsPluginRequest & aRequest
TDes8 & aDes
TInt64 aPos
TInt aFunction

DoRequestL(TFsPluginRequest &)

TInt DoRequestL(TFsPluginRequest &aRequest)[protected, pure virtual]

Parameters

TFsPluginRequest & aRequest

Drive()

TInt Drive()[inline]

FileRead(TFsPluginRequest &, TDes8 &, TInt64)

IMPORT_C TIntFileRead(TFsPluginRequest &aRequest,
TDes8 &aDes,
TInt64aPos
)[protected]

Parameters

TFsPluginRequest & aRequest
TDes8 & aDes
TInt64 aPos

FileWrite(TFsPluginRequest &, const TDesC8 &, TInt64)

IMPORT_C TIntFileWrite(TFsPluginRequest &aRequest,
const TDesC8 &aDes,
TInt64aPos
)[protected]

Parameters

TFsPluginRequest & aRequest
const TDesC8 & aDes
TInt64 aPos

InitialiseL()

IMPORT_C voidInitialiseL()[protected, virtual]

IsMounted(TInt)

TBool IsMounted(TIntaDrive)[protected]

Parameters

TInt aDrive

IsPluginThread(CFsRequest &)

TBool IsPluginThread(CFsRequest &aMessage)[protected]

Parameters

CFsRequest & aMessage

IsRegistered(TInt)

TBool IsRegistered(TIntaMessage)[protected]

Parameters

TInt aMessage

IsRegistered(TInt, TInterceptAtts)

TBool IsRegistered(TIntaMessage,
TInterceptAttsaInterceptAtts
)[protected]

Parameters

TInt aMessage
TInterceptAtts aInterceptAtts

NewPluginConnL()

IMPORT_C CFsPluginConn *NewPluginConnL()[protected, virtual]

RegisterIntercept(TInt, TInterceptAtts)

IMPORT_C TIntRegisterIntercept(TIntaMessage,
TInterceptAttsaInterceptAtts
)[protected]

Parameters

TInt aMessage
TInterceptAtts aInterceptAtts

SessionDisconnect(CSessionFs *)

TInt SessionDisconnect(CSessionFs *aSession)[inline, virtual]

Parameters

CSessionFs * aSession

SetDrive(TInt)

voidSetDrive(TIntaDrive)[inline]

Parameters

TInt aDrive

UnregisterIntercept(TInt, TInterceptAtts)

IMPORT_C TIntUnregisterIntercept(TIntaMessage,
TInterceptAttsaInterceptAtts
)[protected]

Parameters

TInt aMessage
TInterceptAtts aInterceptAtts

WaitForRequest()

TInt WaitForRequest()[private]

Member Enumerations Documentation

Enum TInterceptAtts

Intercept attribute to specify the order of request handling

Enumerators

EPreIntercept = 0x01
EPostIntercept = 0x02
EPrePostIntercept = EPreIntercept | EPostIntercept

Member Data Documentation

TInt iDrive

TInt iDrive[private]

TInt iLastError

TInt iLastError[private]

TInt iMountedOn

TInt iMountedOn[private]

const TUint iReadOnly

const TUintiReadOnly[private]

TUint8 iRegisteredIntercepts

TUint8 iRegisteredIntercepts[private]

TUint iSpare

TUint iSpare[private]

TThreadId iThreadId

TThreadId iThreadId[protected]

CPluginThread * iThreadP

CPluginThread *iThreadP[private]

TInt iUniquePos

TInt iUniquePos[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.