Collapse all Symbian^3 Product Developer Library

CXIMPOperationBase Class Reference

class CXIMPOperationBase : public CBase

Base C-class for operations

ximpoperation.lib

Since: S60 v4.0

Inherits from

CXIMPOperationBase
- CBase

Public Member Functions
	CXIMPOperationBase()
	~CXIMPOperationBase()
IMPORT_C void	BaseConstructL(TXIMPRequestId, CXIMPPscContext *)
IMPORT_C void	BeginOperation()
void	ConstructL(const TDesC8 &)
IMPORT_C CXIMPPscContext *	Context()
IMPORT_C void	EndOperation()
IMPORT_C MXIMPPscContext *	GetContext()
IMPORT_C MXIMPRestrictedObjectCollection *	GetObjCollection()
IMPORT_C CXIMPRequestCompleteEventImp *	GetReqCompleteEvent()
IMPORT_C TBool	IsServerOperation()
IMPORT_C void	ProcessL()
IMPORT_C void	RequestCompletedL()
IMPORT_C TXIMPRequestId	RequestId()
IMPORT_C void	SetHost(MXIMPHost &)
IMPORT_C void	SetObjectCollection(MXIMPBase *)
IMPORT_C void	SetOpL(CXIMPPscContext *)
IMPORT_C void	SetReqId(TXIMPRequestId)
IMPORT_C void	SetResultCode(TInt)
IMPORT_C void	SetServerOperation()
IMPORT_C void	SetStatus(MXIMPStatus *)
IMPORT_C MXIMPStatus &	Status()
IMPORT_C TInt	Type()

Protected Member Functions
IMPORT_C void	CreateRequestCompleteEventL()

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()

Protected Attributes
CXIMPPscContext *	iContext
MXIMPHost *	iMyHost
TBool	iNotActive
CXIMPRestrictedObjectCollectionImp *	iObjCollection
CXIMPRequestCompleteEventImp *	iReqCompleteEvent
TXIMPRequestId	iReqId
TBool	iServerOperation
CXIMPStatusImp *	iStatusObj

Constructor & Destructor Documentation

CXIMPOperationBase()

IMPORT_C

CXIMPOperationBase

(

)

Call this, then BaseConstructL in derived class.

~CXIMPOperationBase()

IMPORT_C

~CXIMPOperationBase

(

)

[virtual]

Member Functions Documentation

BaseConstructL(TXIMPRequestId, CXIMPPscContext *)

IMPORT_C void	BaseConstructL	(	TXIMPRequestId	aRequestId,
			CXIMPPscContext *	aContext
		)

Parameters

TXIMPRequestId aRequestId	The request id
CXIMPPscContext * aContext

BeginOperation()

IMPORT_C void

BeginOperation

(

)

[virtual]

ConstructL(const TDesC8 &)

void

ConstructL

(

const TDesC8 &

aParamPck

)

[pure virtual]

Parameters

const TDesC8 & aParamPck

Context()

IMPORT_C CXIMPPscContext *

Context

(

)

[virtual]

CreateRequestCompleteEventL()

IMPORT_C void

CreateRequestCompleteEventL

(

)

[protected, virtual]

Create request complete event

EndOperation()

IMPORT_C void

EndOperation

(

)

[virtual]

GetContext()

IMPORT_C MXIMPPscContext *

GetContext

(

)

GetObjCollection()

IMPORT_C MXIMPRestrictedObjectCollection *

GetObjCollection

(

)

GetReqCompleteEvent()

IMPORT_C CXIMPRequestCompleteEventImp *

GetReqCompleteEvent

(

)

[virtual]

IsServerOperation()

IMPORT_C TBool

IsServerOperation

(

)

const

ProcessL()

IMPORT_C void

ProcessL

(

)

[virtual]

Process this operation.

RequestCompletedL()

IMPORT_C void

RequestCompletedL

(

)

[virtual]

Request made by the operation has been completed.

RequestId()

IMPORT_C TXIMPRequestId

RequestId

(

)

const [virtual]

SetHost(MXIMPHost &)

IMPORT_C void

SetHost

(

MXIMPHost &

aMyHost

)

[virtual]

Set host for operation. ProcessL cannot be called before host is set.

Parameters

MXIMPHost & aMyHost

SetObjectCollection(MXIMPBase *)

IMPORT_C void

SetObjectCollection

(

MXIMPBase *

aCollection

)

[virtual]

Set new object collection for operator.

Parameters

MXIMPBase * aCollection

SetOpL(CXIMPPscContext *)

IMPORT_C void

SetOpL

(

CXIMPPscContext *

aContext

)

[virtual]

Parameters

CXIMPPscContext * aContext

The context of operation

SetReqId(TXIMPRequestId)

IMPORT_C void

SetReqId

(

TXIMPRequestId

aRequestId

)

[virtual]

Parameters

TXIMPRequestId aRequestId

The request id

SetResultCode(TInt)

IMPORT_C void

SetResultCode

(

TInt

aResultCode

)

[virtual]

Set result code for operation

Parameters

TInt aResultCode

SetServerOperation()

IMPORT_C void

SetServerOperation

(

)

SetStatus(MXIMPStatus *)

IMPORT_C void

SetStatus

(

MXIMPStatus *

aStatus

)

[virtual]

Set status for operation

Parameters

MXIMPStatus * aStatus

Status()

IMPORT_C MXIMPStatus &

Status

(

)

const [virtual]

Type()

IMPORT_C TInt

Type

(

)

const [virtual]

Member Data Documentation

CXIMPPscContext * iContext

CXIMPPscContext *

iContext

[protected]

Context of operation

MXIMPHost * iMyHost

MXIMPHost *

iMyHost

[protected]

Host of this operation. Shared owning. Use close to destroy

TBool iNotActive

TBool

iNotActive

[protected]

If ETrue, operation is not active

CXIMPRestrictedObjectCollectionImp * iObjCollection

CXIMPRestrictedObjectCollectionImp *

iObjCollection

[protected]

Holder for parameters. Owned

CXIMPRequestCompleteEventImp * iReqCompleteEvent

CXIMPRequestCompleteEventImp *

iReqCompleteEvent

[protected]

Request complete event Owned.

TXIMPRequestId iReqId

TXIMPRequestId

iReqId

[protected]

Req id

TBool iServerOperation

TBool

iServerOperation

[protected]

True if server initiated operation

CXIMPStatusImp * iStatusObj

CXIMPStatusImp *

iStatusObj

[protected]

Internal state of the host