Collapse all Symbian^3 Application Developer Library

CWiFiProtDlgsPlugin Class Reference

class CWiFiProtDlgsPlugin : public CBase

CWiFiProtDlgsPlugin class Notifier Framework plugin for Wi-Fi Protected Setup

Inherits from

CWiFiProtDlgsPlugin
- CBase

Public Member Functions
	~CWiFiProtDlgsPlugin ()
void	Cancel ()
void	CompleteL ( TInt )
void	CompleteProcessL ( WiFiProt::TWiFiReturn )
TNotifierInfo	Info ()
CWiFiProtDlgsPlugin *	NewL (const TBool , RCmManagerExt *)
CWiFiProtDlgsPlugin *	NewL (const TBool )
TNotifierInfo	RegisterL ()
void	Release ()
void	SetCancelledFlag ( TBool )
WiFiProt::TWiFiReturn	StartFromUiL (const TWlanSsid &, TBool , RArray < TUint32 > &)
TPtrC8	StartL (const TDesC8 &)
void	StartL (const TDesC8 &, TInt , const RMessagePtr2 &)
TPtrC8	UpdateL (const TDesC8 &)

Private Member Functions
	CWiFiProtDlgsPlugin ()
RCmManagerExt &	CmManagerToUse ()
void	ConstructL (const TDesC &, const TBool , RCmManagerExt *)

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

Private Attributes
TBool	iCancelled
TBool	iCancelledFromInside
TBool	iClientCancelled
RCmManagerExt	iCmManagerExt
TBool	iConnMode
TNotifierInfo	iInfo
RMessagePtr2	iMessage
TWlanProtectedSetupCredentialAttribute	iNetworkSettings
RCmManagerExt *	iPassedCmManagerExt
TInt	iReplySlot
TInt	iResource
TWiFiReturn	iReturn
CWiFiProtActiveRunner *	iRunner
RArray < TUint32 >	iUids

Constructor & Destructor Documentation

CWiFiProtDlgsPlugin()

CWiFiProtDlgsPlugin

(

)

[private]

Constructor

~CWiFiProtDlgsPlugin()

~CWiFiProtDlgsPlugin

(

)

Destructor

Member Functions Documentation

Cancel()

void

Cancel

(

)

Cancel() the notifier

CmManagerToUse()

RCmManagerExt &

CmManagerToUse

(

)

[private]

Returns the correct RCmManagerExt instance's reference it can be an own instance, or a passed reference in case StartFromUiL was called (we are in the same process as the caller) This is necessary because we can't open two CmManagers the same time and the client is possibly using one already.

CompleteL(TInt)

void

CompleteL

(

TInt

aStatus

)

CompleteL the notifier is complete

Parameters

TInt aStatus

status return -

CompleteProcessL(WiFiProt::TWiFiReturn)

void

CompleteProcessL

(

WiFiProt::TWiFiReturn

aReturnValue

)

Asynchronous notifier dialog sequence is completed by calling this function.

Parameters

WiFiProt::TWiFiReturn aReturnValue

- possible return values are ok, cancel process and not use protected setup (No Automatic Setup).

ConstructL(const TDesC &, const TBool, RCmManagerExt *)

void	ConstructL	(	const TDesC &	aResourceFileName,
			const TBool	aResourceFileResponsible,
			RCmManagerExt *	aCmManagerExt = NULL
		)	[private]

CWiFiProtDlgsPlugin second level constructor CWiFiProtDlgsPlugin::CmManagerToUse

Parameters

const TDesC & aResourceFileName	Resource file to open
const TBool aResourceFileResponsible	ETrue if this notifier is responsible for the resource file
RCmManagerExt * aCmManagerExt = NULL	CmManager to use

Info()

TNotifierInfo

Info

(

)

const

Get Notifier information return TNotifierInfo Notifier info

NewL(const TBool, RCmManagerExt *)

CWiFiProtDlgsPlugin *	NewL	(	const TBool	aResourceFileResponsible,
			RCmManagerExt *	aCmManagerExt
		)	[static]

NewL function

Parameters

const TBool aResourceFileResponsible	- ETrue if the plugin handles the resource file
RCmManagerExt * aCmManagerExt	- CmManager to use during Wi-Fi Protected Setup return CWiFiProtDlgsPlugin*

NewL(const TBool)

CWiFiProtDlgsPlugin *

NewL

(

const TBool

aResourceFileResponsible

)

[static]

NewL function

Parameters

const TBool aResourceFileResponsible

- ETrue if the plugin handles the resource file return CWiFiProtDlgsPlugin*

RegisterL()

TNotifierInfo

RegisterL

(

)

RegisterL register the client notifier function return TNotifierInfo Contains uid, channel and priority of the registered notifier

Release()

void

Release

(

)

Release the notifier

SetCancelledFlag(TBool)

void

SetCancelledFlag

(

TBool

aCancelled

)

Sets iCancelled flag that indicates that the notifier was cancelled

Parameters

TBool aCancelled

Not used

StartFromUiL(const TWlanSsid &, TBool, RArray< TUint32 > &)

WiFiProt::TWiFiReturn	StartFromUiL	(	const TWlanSsid &	aSSid,
			TBool	aConnectionNeeded,
			RArray < TUint32 > &	aUidsReturned
		)

Starts Wi-Fi Protected Setup Private interface to be used by applications with ui runs in the same process, so pointers can be passed

Parameters

const TWlanSsid & aSSid	contains SSid of the network we want to configure
TBool aConnectionNeeded	ETrue if we need a connection via the configured network
RArray < TUint32 > & aUidsReturned	uids of the configured connection methods

StartL(const TDesC8 &)

TPtrC8

StartL

(

const TDesC8 &

aBuffer

)

Start the Notifier

Parameters

const TDesC8 & aBuffer

Not used return TPtrC8 Always NULL

StartL(const TDesC8 &, TInt, const RMessagePtr2 &)

void	StartL	(	const TDesC8 &	aBuffer,
			TInt	aReplySlot,
			const RMessagePtr2 &	aMessage
		)

Start the Notifier

Parameters

const TDesC8 & aBuffer	Buffer that stores parameters from client side
TInt aReplySlot	Identifies which message argument to use for the reply. This message argument will refer to a modifiable descriptor, a TDes8 type, into which data can be returned.
const RMessagePtr2 & aMessage	Message