Collapse all Symbian^3 Product Developer Library

RHssInterface Class Reference

class RHssInterface : public RSessionBase

Inherits from

RHssInterface
- RSessionBase
  - RHandleBase

Public Member Functions
IMPORT_C void	ActivateNotificationsL(MHssSrvNotifications &)
IMPORT_C TInt	AddIapSsidList(TUint, const CArrayFixFlat< THssSsid > &)
IMPORT_C void	Cancel(const TUint)
IMPORT_C TInt	CancelLogin()
IMPORT_C void	CancelNotifications()
IMPORT_C TInt	CancelStart(const TUint)
void	CancelWaitForNotification()
IMPORT_C TInt	ChangeSettings(const TUint, const THssIapSettings &)
IMPORT_C TUint32	CheckBackgroundScanL()
IMPORT_C void	Close()
IMPORT_C void	CloseConnection(const TUint, TRequestStatus &)
IMPORT_C TInt	Connect()
IMPORT_C void	GetClientIapsL(const TUid, RArray< TUint > &)
IMPORT_C TInt	GetConnectionBssid(THssBssid &)
IMPORT_C TUint32	GetIap(TIpcArgs)
IMPORT_C TInt	GetScanResults(HssScanList &)
TUint	IapId()
IMPORT_C TInt	Join(const TUint)
IMPORT_C TInt	LoginComplete(const TUint, TInt)
IMPORT_C TInt	LogoutComplete(const TUint)
IMPORT_C TUint	Register(const TUid, const TDesC &, const TUint)
IMPORT_C TInt	SetTimerValues(TUid, TUint, TUint)
IMPORT_C void	SetUiState(const TUint, const TUint)
IMPORT_C TInt	ShutdownServerL()
IMPORT_C void	Start(const TUint, TRequestStatus &)
IMPORT_C void	StartAgain(const TUint, TRequestStatus &)
IMPORT_C void	StartBrowser(const TDesC &, const TUint, const TUint, TRequestStatus &)
IMPORT_C void	StartLogin(const TUint, const TUint, TRequestStatus &)
IMPORT_C TInt	Stop(const TUint)
IMPORT_C TInt	UnRegister(const TUint, const TUint, const TUid)
TVersion	Version()
void	WaitForNotification(TRequestStatus &, TDes8 &)

Protected Member Functions
TInt	StartServer()

Private Member Functions
TInt	StopConnectionL(const TUint, const TUint)

Inherited Functions
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	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()

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Private Attributes
TIpcArgs	iArgs
CHssIapHandler *	iIapHandler
TUint	iIapId
CHssSrvNotifications *	iNotify
CHssScanHandler *	iScanHandler

Inherited Attributes
	RHandleBase::iHandle

Member Functions Documentation

ActivateNotificationsL(MHssSrvNotifications &)

IMPORT_C void

ActivateNotificationsL

(

MHssSrvNotifications &

aCallback

)

Activate the notification service.

After the client has enabled the notification service, it can receive asynchronous notifications from the server.

Parameters

MHssSrvNotifications & aCallback

The class that implements the callback interface.

AddIapSsidList(TUint, const CArrayFixFlat< THssSsid > &)

IMPORT_C TInt	AddIapSsidList	(	TUint	aIapId,
			const CArrayFixFlat< THssSsid > &	aSsidList
		)

Add an SSID list to the given IAP.

Parameters

TUint aIapId
const CArrayFixFlat< THssSsid > & aSsidList

Cancel(const TUint)

IMPORT_C void

Cancel

(

const TUint

aIapId

)

Cancel for WLAN agent.

Parameters

const TUint aIapId

CancelLogin()

IMPORT_C TInt

CancelLogin

(

)

CancelLogin for DHCP Configuration Daemon.

CancelNotifications()

IMPORT_C void

CancelNotifications

(

)

Cancel the notification service.

CancelStart(const TUint)

IMPORT_C TInt

CancelStart

(

const TUint

aIapId

)

Cancel start call.

Parameters

const TUint aIapId

CancelWaitForNotification()

void

CancelWaitForNotification

(

)

Cancel pending notification message from server. CHssSrvNotifications class uses this method to cancel pending message at server side.

ChangeSettings(const TUint, const THssIapSettings &)

IMPORT_C TInt	ChangeSettings	(	const TUint	aIapId,
			const THssIapSettings &	aSettings
		)

Change IAP settings.

Parameters

const TUint aIapId
const THssIapSettings & aSettings

CheckBackgroundScanL()

IMPORT_C TUint32

CheckBackgroundScanL

(

)

Check status of BackgroundScan.

Close()

IMPORT_C void

(

)

Close the connection; release the handle to the server.

CloseConnection(const TUint, TRequestStatus &)

IMPORT_C void	CloseConnection	(	const TUint	aIapId,
			TRequestStatus &	aStatus
		)

Close connection for WLAN agent.

Parameters

const TUint aIapId
TRequestStatus & aStatus

Connect()

IMPORT_C TInt

Connect

(

)

Client makes the connection to the server.

GetClientIapsL(const TUid, RArray< TUint > &)

IMPORT_C void	GetClientIapsL	(	const TUid	aUid,
			RArray< TUint > &	aIapIdArray
		)

Gets all Iaps of client

Parameters

const TUid aUid
RArray< TUint > & aIapIdArray

GetConnectionBssid(THssBssid &)

IMPORT_C TInt

GetConnectionBssid

(

THssBssid &

aBssId

)

Get the BSSID of the currently connected AP.

Parameters

THssBssid & aBssId

GetIap(TIpcArgs)

IMPORT_C TUint32

GetIap

(

TIpcArgs

aArgs

)

Parameters

TIpcArgs aArgs

GetScanResults(HssScanList &)

IMPORT_C TInt

GetScanResults

(

HssScanList &

aResults

)

Perform a scan and return the detected WLAN networks.

Parameters

HssScanList & aResults

Results of the scan.

IapId()

TUint

IapId

(

)

[inline]

Get ID of the IAP .

Join(const TUint)

IMPORT_C TInt

Join

(

const TUint

aIapId

)

Associate IAP with network.

Parameters

const TUint aIapId

LoginComplete(const TUint, TInt)

IMPORT_C TInt	LoginComplete	(	const TUint	aIapId,
			TInt	aStatus
		)

End connection.

Parameters

const TUint aIapId
TInt aStatus

LogoutComplete(const TUint)

IMPORT_C TInt

LogoutComplete

(

const TUint

aIapId

)

End connection.

Parameters

const TUint aIapId

Register(const TUid, const TDesC &, const TUint)

IMPORT_C TUint	Register	(	const TUid	aUid,
			const TDesC &	aIapName,
			const TUint	aWaitnote
		)

Create and Protect IAP, register HotSpot Client.

Parameters

const TUid aUid
const TDesC & aIapName
const TUint aWaitnote

SetTimerValues(TUid, TUint, TUint)

IMPORT_C TInt	SetTimerValues	(	TUid	aClientUid,
			TUint	aLoginTimerValue,
			TUint	aLogoutTimerValue
		)

Set login and logout timer values of this client. If given values aren't suitable, the default values are set.

Parameters

TUid aClientUid
TUint aLoginTimerValue
TUint aLogoutTimerValue

SetUiState(const TUint, const TUint)

IMPORT_C void	SetUiState	(	const TUint	aIapId,
			const TUint	aState
		)

Set UI state of HotSpot browser logon application.

Parameters

const TUint aIapId
const TUint aState

ShutdownServerL()

IMPORT_C TInt

ShutdownServerL

(

)

Shutdown server when uninstalling .sis -file.

Start(const TUint, TRequestStatus &)

IMPORT_C void	Start	(	const TUint	aIapId,
			TRequestStatus &	aStatus
		)

Start for WLAN agent.

Parameters

const TUint aIapId
TRequestStatus & aStatus

StartAgain(const TUint, TRequestStatus &)

IMPORT_C void	StartAgain	(	const TUint	aIapId,
			TRequestStatus &	aStatus
		)

Start again for WLAN agent.

Parameters

const TUint aIapId
TRequestStatus & aStatus

StartBrowser(const TDesC &, const TUint, const TUint, TRequestStatus &)

IMPORT_C void	StartBrowser	(	const TDesC &	aString,
			const TUint	aIapId,
			const TUint	aNetId,
			TRequestStatus &	aStatus
		)

Starts HotSpot browser for browser based authentication.

Parameters

const TDesC & aString
const TUint aIapId
const TUint aNetId
TRequestStatus & aStatus

StartLogin(const TUint, const TUint, TRequestStatus &)

IMPORT_C void	StartLogin	(	const TUint	aIapId,
			const TUint	aNetworkId,
			TRequestStatus &	aStatus
		)

StartLogin for NIFMAN Configuration Daemon.

Parameters

const TUint aIapId
const TUint aNetworkId
TRequestStatus & aStatus

StartServer()

TInt

StartServer

(

)

[protected]

Start the server during Connect() if the server is not loaded.

Stop(const TUint)

IMPORT_C TInt

Stop

(

const TUint

aIapId

)

Stop associating IAP.

Parameters

const TUint aIapId

StopConnectionL(const TUint, const TUint)

TInt	StopConnectionL	(	const TUint	aIapId,
			const TUint	aNetworkId
		)	[private]

Stops active connection

Parameters

const TUint aIapId
const TUint aNetworkId

UnRegister(const TUint, const TUint, const TUid)

IMPORT_C TInt	UnRegister	(	const TUint	aIapId,
			const TUint	aNetworkId,
			const TUid	aUid
		)

Delete IAP and unregister HotSpot Client.

Parameters

const TUint aIapId
const TUint aNetworkId
const TUid aUid

Version()

TVersion

Version

(

)

const

Version information.

WaitForNotification(TRequestStatus &, TDes8 &)

void	WaitForNotification	(	TRequestStatus &	aReturnValue,
			TDes8 &	aReturnData
		)

Set a message to pend notification.

Parameters

TRequestStatus & aReturnValue	Status of the calling active object.
TDes8 & aReturnData	(OUT) Data returned by the notification.

Member Data Documentation

TIpcArgs iArgs

TIpcArgs

iArgs

[private]

Parameter array type

CHssIapHandler * iIapHandler

CHssIapHandler *

iIapHandler

[private]

Handler for changing IAP settings

TUint iIapId

TUint

iIapId

[private]

ID of the IAP.

CHssSrvNotifications * iNotify

CHssSrvNotifications *

iNotify

[private]

Callback interface to HSS management.

CHssScanHandler * iScanHandler

CHssScanHandler *

iScanHandler

[private]

Handler for changing IAP settings