Collapse all Symbian^3 Product Developer Library

RWimMgmt Class Reference

class RWimMgmt : public RWimClient

RWimMgmt This class inherits RWimClient and communicates with it. WimClient

Since: Series 60 2.1

Inherits from

RWimMgmt
- RWimClient
  - RSessionBase
    - RHandleBase

Public Member Functions
	~RWimMgmt()
void	CancelEnableDisablePin(const TPinAddress)
void	CancelPinOperation(const TPinAddress, const TWimServRqst)
RWimMgmt *	ClientSessionL()
TInt	CloseAfter()
TInt	CloseWIM(const TWimAddress)
void	DeallocMemoryFromEnableDisablePinQuery()
void	EnableDisablePinQueryL(const TPinAddress, const TPINStateRequest &, const TPINParams &, TRequestStatus &)
TInt	IsBlocked(const TPinAddress)
TInt	IsDisabledPINBlocked(const TPinAddress)
TBool	IsOpen(const TWimAddress)
TUint	PINCount(const TWimAddress)
void	PINInfo(const TPinAddress, TWimPinStruct &, TRequestStatus &)
TInt	PINRefs(const TWimAddress, TUint32 &, TPinAddressList, TUint8)
void	PINsInfo(const TWimAddress, CArrayFixFlat< TWimPinStruct > &, TUint8, TRequestStatus &)
TInt	PINsInfo(const TWimAddress, CArrayFixFlat< TWimPinStruct > &, TUint8)
void	PinOperationL(const TPinAddress, const TPINParams, const TWimServRqst, TRequestStatus &)
void	SetCloseAfter(const TUint)
TInt	TimeRemaining()
TUint	WIMCount()
TInt	WIMInfo(const TWimAddress, TWimSecModuleStruct &)
TInt	WIMRefs(TWimAddressList, TUint8)

Private Member Functions
	RWimMgmt()
	RWimMgmt(const RWimMgmt &)
RWimMgmt &	operator=(const RWimMgmt &)

Inherited Functions
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	RHandleBase::Close()
	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)
	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()
	RWimClient::CancelInitialize()
	RWimClient::Connect()
	RWimClient::FreeAddrLst(const TUint32)
	RWimClient::FreeWIMAddr(const TWimAddress)
	RWimClient::FreeWIMAddrLst(const TWimAddressList,const TUint)
	RWimClient::Initialize(TRequestStatus &)
	RWimClient::RWimClient()
	RWimClient::SendReceiveData(TWimServRqst,TIpcArgs &)
	RWimClient::SendReceiveData(TWimServRqst,TIpcArgs &,TRequestStatus &)
	RWimClient::StartWim()
	RWimClient::Version()const
	RWimClient::~RWimClient()

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Private Attributes
TPtr8 *	iPinInfoLstPtr
TPckg< TWimPinStruct > *	iPinModule
CWimCertPckgBuf< TPINParams > *	iPinParamsBuf
TBool	iPinParamsBufAllocated
CWimCertPckgBuf< TPINStateRequest > *	iPinStateRequestBuf
TBool	iPinStateRequestBufAllocated

Inherited Attributes
	RHandleBase::iHandle

Constructor & Destructor Documentation

RWimMgmt()

RWimMgmt

(

)

[private]

Constructor

RWimMgmt(const RWimMgmt &)

RWimMgmt

(

const RWimMgmt &

aSource

)

[private]

Copy constructor

Parameters

const RWimMgmt & aSource

-Reference to class object.

~RWimMgmt()

~RWimMgmt

(

)

[virtual]

Destructor

Member Functions Documentation

CancelEnableDisablePin(const TPinAddress)

void

CancelEnableDisablePin

(

const TPinAddress

aPinAddr

)

Cancel Enable and Disable PIN requests. Server knows wanted operation by flag which is set in TPINStateRequest.

Parameters

const TPinAddress aPinAddr

-Address to the PIN struct.

CancelPinOperation(const TPinAddress, const TWimServRqst)

void	CancelPinOperation	(	const TPinAddress	aPinAddr,
			const TWimServRqst	aOpCode
		)

Cancel PinOperationL handles several PIN operations: it can be verify PIN request, change PIN request or unblock PIN request. The type of request is handled via aOpCode.

Parameters

const TPinAddress aPinAddr	-Address to the PIN struct
const TWimServRqst aOpCode	-Code that informs the type of operation

ClientSessionL()

RWimMgmt *

ClientSessionL

(

)

[static]

A static method to get the client session. RWimMgmt*

CloseAfter()

TInt

CloseAfter

(

)

Returns the time which is set as WIM closing time

CloseWIM(const TWimAddress)

TInt

CloseWIM

(

const TWimAddress

aWimAddr

)

Closes the WIM and returns the status of the WIMI_CloseWIM()

Parameters

const TWimAddress aWimAddr

- Address to the WIM

DeallocMemoryFromEnableDisablePinQuery()

void

DeallocMemoryFromEnableDisablePinQuery

(

)

Deallocates memory from pckgBuf member variables

EnableDisablePinQueryL(const TPinAddress, const TPINStateRequest &, const TPINParams &, TRequestStatus &)

void	EnableDisablePinQueryL	(	const TPinAddress	aPinAddr,
			const TPINStateRequest &	aPinStateRequest,
			const TPINParams &	aPinParams,
			TRequestStatus &	aStatus
		)

Handles Enable and Disable PIN requests. Server knows wanted operation by flag which is set in TPINStateRequest.

Parameters

const TPinAddress aPinAddr	-Address to the PIN struct.
const TPINStateRequest & aPinStateRequest	-Enable/Disable flag
const TPINParams & aPinParams	-General information about PIN.
TRequestStatus & aStatus	-Caller's status

IsBlocked(const TPinAddress)

TInt

IsBlocked

(

const TPinAddress

aPinAddr

)

Used to check is PIN blocked or not.

Parameters

const TPinAddress aPinAddr

-Address to the PIN struct

IsDisabledPINBlocked(const TPinAddress)

TInt

IsDisabledPINBlocked

(

const TPinAddress

aPinAddr

)

Used to check is Disabled PIN blocked or not.

Parameters

const TPinAddress aPinAddr

-Address to the PIN struct

IsOpen(const TWimAddress)

TBool

IsOpen

(

const TWimAddress

aWimAddr

)

Tests whether WIM is open or not.

Parameters

const TWimAddress aWimAddr

- Address to the WIM.

PINCount(const TWimAddress)

TUint

PINCount

(

const TWimAddress

aWimAddr

)

Returns the count of PINs

Parameters

const TWimAddress aWimAddr

PINInfo(const TPinAddress, TWimPinStruct &, TRequestStatus &)

void	PINInfo	(	const TPinAddress	aPinAddr,
			TWimPinStruct &	aPinStruct,
			TRequestStatus &	aStatus
		)

Gets the PIN information in to aPinStruct

Parameters

const TPinAddress aPinAddr	-Address to the PIN structure (IN)
TWimPinStruct & aPinStruct	-Reference to the Structure to containing PIN information (OUT)
TRequestStatus & aStatus

PINRefs(const TWimAddress, TUint32 &, TPinAddressList, TUint8)

TInt	PINRefs	(	const TWimAddress	aWimAddr,
			TUint32 &	aPinLstAddr,
			TPinAddressList	aPinAddrLst,
			TUint8	aCount
		)

Gets the array of PIN structures.

Parameters

const TWimAddress aWimAddr	-Address to the WIM structure
TUint32 & aPinLstAddr	-Reference to PIN list
TPinAddressList aPinAddrLst	-Address to PIN address list
TUint8 aCount	-Count of PINs

PINsInfo(const TWimAddress, CArrayFixFlat< TWimPinStruct > &, TUint8, TRequestStatus &)

void	PINsInfo	(	const TWimAddress	aWimAddr,
			CArrayFixFlat< TWimPinStruct > &	aPinInfoLst,
			TUint8	aCount,
			TRequestStatus &	aStatus
		)

Get all of the pins information on a given SecMod asynchronously. @ param aPinInfoLst array to store the PINs information return void

Parameters

const TWimAddress aWimAddr
CArrayFixFlat< TWimPinStruct > & aPinInfoLst
TUint8 aCount
TRequestStatus & aStatus

PINsInfo(const TWimAddress, CArrayFixFlat< TWimPinStruct > &, TUint8)

TInt	PINsInfo	(	const TWimAddress	aWimAddr,
			CArrayFixFlat< TWimPinStruct > &	aPinInfoLst,
			TUint8	aCount
		)

Get all of the pins information on a given SecMod synchronously. @ param aPinInfoLst array to store the PINs information return void

Parameters

const TWimAddress aWimAddr
CArrayFixFlat< TWimPinStruct > & aPinInfoLst
TUint8 aCount

PinOperationL(const TPinAddress, const TPINParams, const TWimServRqst, TRequestStatus &)

void	PinOperationL	(	const TPinAddress	aPinAddr,
			const TPINParams	aPinParams,
			const TWimServRqst	aOpCode,
			TRequestStatus &	aStatus
		)

PinOperationL handles several PIN operations: it can be verify PIN request, change PIN request or unblock PIN request. The type of request is handled via aOpCode.

Parameters

const TPinAddress aPinAddr	-Address to the PIN struct
const TPINParams aPinParams	-General information about PIN
const TWimServRqst aOpCode	-Code that informs the type of operation
TRequestStatus & aStatus	-Caller's status

SetCloseAfter(const TUint)

void

SetCloseAfter

(

const TUint

aCloseAfter

)

Parameters

const TUint aCloseAfter

TimeRemaining()

TInt

TimeRemaining

(

)

Returns TUint - the timeout in minutes, which tells how long WIM Security Module will be open

WIMCount()

TUint

WIMCount

(

)

Returns TUint - the number of WIMs

WIMInfo(const TWimAddress, TWimSecModuleStruct &)

TInt	WIMInfo	(	const TWimAddress	aWimAddr,
			TWimSecModuleStruct &	aTWimSecModuleStruct
		)

Gets the WIM information in to aTWimSecModuleStruct

Parameters

const TWimAddress aWimAddr	-Address to the WIM structure (IN)
TWimSecModuleStruct & aTWimSecModuleStruct	-Reference to the Structure to contain WIM information (OUT)

WIMRefs(TWimAddressList, TUint8)

TInt	WIMRefs	(	TWimAddressList	aWimAddrLst,
			TUint8	aCount
		)

Gets the array of WIM structures.

Parameters

TWimAddressList aWimAddrLst	- Pointer to a list of allocated WIM structures
TUint8 aCount	- is the number of WIMs

operator=(const RWimMgmt &)

RWimMgmt &

operator=

(

const RWimMgmt &

aParam

)

[private]

Assigment operator

Parameters

const RWimMgmt & aParam

-Reference to class object.

Member Data Documentation

TPtr8 * iPinInfoLstPtr

TPtr8 *

iPinInfoLstPtr

[private]

TPckg< TWimPinStruct > * iPinModule

TPckg< TWimPinStruct > *

iPinModule

[private]

CWimCertPckgBuf< TPINParams > * iPinParamsBuf

CWimCertPckgBuf< TPINParams > *

iPinParamsBuf

[private]

TBool iPinParamsBufAllocated

TBool

iPinParamsBufAllocated

[private]

CWimCertPckgBuf< TPINStateRequest > * iPinStateRequestBuf

CWimCertPckgBuf< TPINStateRequest > *

iPinStateRequestBuf

[private]

TBool iPinStateRequestBufAllocated

TBool

iPinStateRequestBufAllocated

[private]