Collapse all Symbian^3 Product Developer Library

CWimOMAProv Class Reference

class CWimOMAProv : public CActive

Reads OMA Provisioning information from Smart Card

WimClient

Since: Series60 2.6

Inherits from

CWimOMAProv
- CActive
  - CBase

Public Member Functions
	~CWimOMAProv()
IMPORT_C void	CancelGetSize()
IMPORT_C void	CancelInitialize()
IMPORT_C void	CancelRetrieve()
IMPORT_C void	GetSize(TInt &, const TOMAType &, TRequestStatus &)
IMPORT_C void	Initialize(TRequestStatus &)
IMPORT_C CWimOMAProv *	NewL()
IMPORT_C void	Retrieve(const TOMAType &, TDes8 &, TRequestStatus &)

Private Member Functions
	CWimOMAProv()
void	AllocMemoryForOmaProvStructL(const TInt)
void	ConstructL()
void	DeallocMemoryFromOmaProvStruct()
void	DoCancel()
TInt	RunError(TInt)
void	RunL()
void	SignalOwnStatusAndComplete()

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	CActive::Extension_(TUint,TAny &,TAny )
	CActive::IsActive()const
	CActive::IsAdded()const
	CActive::Priority()const
	CActive::SetActive()
	CActive::SetPriority(TInt)
	CActive::~CActive()
	CBase::CBase()
	CBase::Delete(CBase *)
	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()

Private Member Enumerations
enum	TOMAPhase { EInitialize, EConnectClientSession, EInitializeWim, EInitializeDone, EGetSize, EGetSizeDone, ERetrieve, ERetrieveDone }

Inherited Enumerations
	CActive:TPriority

Private Attributes
RWimMgmt *	iClientSession
TRequestStatus *	iClientStatus
RWimCertMgmt *	iConnectionHandle
TDes8 *	iData
TOMAType	iOMAType
HBufC8 *	iOmaProvBuf
TPtr8 *	iOmaProvBufPtr
TOMAPhase	iPhase
TInt *	iSize
TInt	iWimStartErr

Inherited Attributes
	CActive::iStatus

Constructor & Destructor Documentation

CWimOMAProv()

CWimOMAProv

(

)

[private]

C++ default constructor.

~CWimOMAProv()

IMPORT_C

~CWimOMAProv

(

)

[virtual]

Destructor

Member Functions Documentation

AllocMemoryForOmaProvStructL(const TInt)

void

AllocMemoryForOmaProvStructL

(

const TInt

aDataLength

)

[private]

Allocates memory for member variables, which are needed in OMA Provisioning struct.

Parameters

const TInt aDataLength

-The length of the data to be allocated

CancelGetSize()

IMPORT_C void

CancelGetSize

(

)

Cancels outgoing GetSize operation.

CancelInitialize()

IMPORT_C void

CancelInitialize

(

)

Cancels outgoing Initialize operation.

CancelRetrieve()

IMPORT_C void

CancelRetrieve

(

)

Cancels outgoing Retrieve operation.

ConstructL()

void

ConstructL

(

)

[private]

Symbian constructor

DeallocMemoryFromOmaProvStruct()

void

DeallocMemoryFromOmaProvStruct

(

)

[private]

Deallocates memory from member variables

DoCancel()

void

DoCancel

(

)

[private, virtual]

Cancellation function Deallocates member variables and completes client status with KErrCancel error code.

GetSize(TInt &, const TOMAType &, TRequestStatus &)

IMPORT_C void	GetSize	(	TInt &	aSize,
			const TOMAType &	aOMAType,
			TRequestStatus &	aStatus
		)

Fetches the size of provisioning information string. This information can be used as a notification, does provisioning information exist. If the size is not included in Smart Card's DODF-PROV file then the full length of the file containing the provisioning information is returned.

Parameters

TInt & aSize	(OUT) The length of provisioning string
const TOMAType & aOMAType	(IN) OMA provisioning file type Pseudo values: -Bootstrap -Config 1 -Config 2
TRequestStatus & aStatus	Indicates the result of this call. KErrNone, no errors. NOTE: size can still be 0 indicating that no provisioning information was found. If aSize > 0 it means that provisioning information was found. KErrNoMemory, No memory KErrGeneral, any other error

Initialize(TRequestStatus &)

IMPORT_C void

Initialize

(

TRequestStatus &

aStatus

)

Initializes the WIM Server cache. This is the most time consuming call.

Parameters

TRequestStatus & aStatus

Indicates the result of this call. Values: KErrNone, call was successull KErrNotFound, no WIM was found KErrNoMemory, no memory KErrGeneral, any other error

NewL()

IMPORT_C CWimOMAProv *

NewL

(

)

[static]

Two-phased constructor.

Retrieve(const TOMAType &, TDes8 &, TRequestStatus &)

IMPORT_C void	Retrieve	(	const TOMAType &	aOMAType,
			TDes8 &	aOMAData,
			TRequestStatus &	aStatus
		)

Fetches the whole data of provisioning information string.

Parameters

const TOMAType & aOMAType	(IN) The type of provisioning string
TDes8 & aOMAData	(OUT) provisioning binary data
TRequestStatus & aStatus	Indicates the result of this call. KErrNone, no errors. KErrNoMemory, No memory KErrGeneral, any other error

RunError(TInt)

TInt

RunError

(

TInt

aError

)

[private, virtual]

The active scheduler calls this function if this active object's RunL() function leaves. Handles necessary cleanup and completes request with received error code.

Parameters

TInt aError

-The error code which caused this function call.

RunL()

void

RunL

(

)

[private, virtual]

Different phases are handled here.

SignalOwnStatusAndComplete()

void

SignalOwnStatusAndComplete

(

)

[private]

Sets own iStatus to KRequestPending, and signals it with User::RequestComplete() -request. This gives chance active scheduler to run other active objects. After a quick visit in active scheduler, signal returns to RunL() and starts next phase of operation.

Member Enumerations Documentation

Enum TOMAPhase

Enumerators

EInitialize
EConnectClientSession
EInitializeWim
EInitializeDone
EGetSize
EGetSizeDone
ERetrieve
ERetrieveDone

Member Data Documentation

RWimMgmt * iClientSession

RWimMgmt *

iClientSession

[private]

TRequestStatus * iClientStatus

TRequestStatus *

iClientStatus

[private]

RWimCertMgmt * iConnectionHandle

RWimCertMgmt *

iConnectionHandle

[private]

TDes8 * iData

TDes8 *

iData

[private]

TOMAType iOMAType

TOMAType

iOMAType

[private]

HBufC8 * iOmaProvBuf

HBufC8 *

iOmaProvBuf

[private]

TPtr8 * iOmaProvBufPtr

TPtr8 *

iOmaProvBufPtr

[private]

TOMAPhase iPhase

TOMAPhase

iPhase

[private]

TInt * iSize

TInt *

iSize

[private]

TInt iWimStartErr

TInt

iWimStartErr

[private]