Collapse all Symbian^3 Product Developer Library

CEapType Class Reference

class CEapType : public CBase

The base interface class for EAP plug-in access. Includes methods to create either the configuration interface or the EAP protocol interface.

Inherits from

CEapType
- CBase

Public Member Functions
	~CEapType()
void	CopySettingsL(const TIndexType, const TInt)
void	DeleteConfigurationL()
void	GetConfigurationL(EAPSettings &)
CEapTypeInfo *	GetInfoLC()
TUint	GetInterfaceVersion()
eap_base_type_c *	GetStackInterfaceL(abs_eap_am_tools_c const , abs_eap_base_type_c const , const bool, const eap_am_network_id_c const , abs_eap_configuration_if_c const )
TInt	InvokeUiL()
TBool	IsDisallowedInsidePEAP(const CImplementationInformation &)
TBool	IsDisallowedInsideTTLS(const CImplementationInformation &)
TBool	IsDisallowedOutsidePEAP(const CImplementationInformation &)
CEapType *	NewL(const TDesC8 &, TIndexType, TInt)
void	SetConfigurationL(const EAPSettings &)
void	SetIndexL(const TIndexType, const TInt)
void	SetTunnelingType(const TInt)

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
TUid	iDtor_ID_Key

Constructor & Destructor Documentation

~CEapType()

~CEapType

(

)

[inline, virtual]

Unloads the implementation DLL.

Member Functions Documentation

CopySettingsL(const TIndexType, const TInt)

void	CopySettingsL	(	const TIndexType	aDestinationIndexType,
			const TInt	aDestinationIndex
		)	[pure virtual]

Copies the EAP types configuration

Parameters

const TIndexType aDestinationIndexType	index type of the destination, ELan for WLAN.
const TInt aDestinationIndex	ID to where copy the settings.

DeleteConfigurationL()

void

DeleteConfigurationL

(

)

[pure virtual]

Deletes EAP type configuration

GetConfigurationL(EAPSettings &)

void

GetConfigurationL

(

EAPSettings &

aSettings

)

[pure virtual]

Gets the EAP types configuration

Parameters

EAPSettings & aSettings

Structure containing the settings

GetInfoLC()

CEapTypeInfo *

GetInfoLC

(

)

[pure virtual]

Gets information about EAP type.

GetInterfaceVersion()

TUint

GetInterfaceVersion

(

)

[pure virtual]

Returns the version of the interface that the EAP type implements. The client-side of the interface must always check the version with this function and not call the functions that are not implemented. New functions must be added to the end of the interface so that the order of the old functions does not change.

GetStackInterfaceL(abs_eap_am_tools_c const, abs_eap_base_type_c const, const bool, const eap_am_network_id_c const, abs_eap_configuration_if_c const)

eap_base_type_c *	GetStackInterfaceL	(	abs_eap_am_tools_c *const	aTools,
			abs_eap_base_type_c *const	aPartner,
			const bool	is_client_when_true,
			const eap_am_network_id_c *const	receive_network_id,
			abs_eap_configuration_if_c *const	configuration_if
		)	[pure virtual]

Creates EAP protocol interface implementation. Instances an object that has been derived from eap_base_type_c that handles the communication with EAP stack.

Parameters

abs_eap_am_tools_c *const aTools	Pointer to tools class.
abs_eap_base_type_c *const aPartner	Used for callbacks to the stack.
const bool is_client_when_true	Specifies whether the EAP type acts as a client or server.
const eap_am_network_id_c *const receive_network_id	Network addresses
abs_eap_configuration_if_c *const configuration_if

InvokeUiL()

TInt

InvokeUiL

(

)

[pure virtual]

Invokes the configuration UI. Displays a dialog for configuring the EAP type settings.

IsDisallowedInsidePEAP(const CImplementationInformation &)

TBool

IsDisallowedInsidePEAP

(

const CImplementationInformation &

aImplInfo

)

[static, inline]

Parses the opaque_data field in CImplementationInformation and returns true if string NOT_INSIDE_PEAP is found.

Parameters

const CImplementationInformation & aImplInfo

Implementation info returned by ListImplementations call

IsDisallowedInsideTTLS(const CImplementationInformation &)

TBool

IsDisallowedInsideTTLS

(

const CImplementationInformation &

aImplInfo

)

[static, inline]

Parses the opaque_data field in CImplementationInformation and returns true if string NOT_INSIDE_TTLS is found.

Parameters

const CImplementationInformation & aImplInfo

Implementation info returned by ListImplementations call

IsDisallowedOutsidePEAP(const CImplementationInformation &)

TBool

IsDisallowedOutsidePEAP

(

const CImplementationInformation &

aImplInfo

)

[static, inline]

Parses the opaque_data field in CImplementationInformation and returns true if string NOT_OUTSIDE_PEAP is found.

Parameters

const CImplementationInformation & aImplInfo

Implementation info returned by ListImplementations call

NewL(const TDesC8 &, TIndexType, TInt)

CEapType *	NewL	(	const TDesC8 &	aCue,
			TIndexType	aIndexType,
			TInt	aIndex
		)	[static, inline]

Factory function that loads the EAP type implementation DLL (plug-in). Uses ECom architecture to load the correct EAP type DLL. Calls the initialization function of the EAP type

Parameters

const TDesC8 & aCue	EAP type id that specifies which plugin is loaded.
TIndexType aIndexType	Indicates the bearer used for this connection.
TInt aIndex	Index for the connection. aIndexType and aIndex uniquely specify the connection.

SetConfigurationL(const EAPSettings &)

void

SetConfigurationL

(

const EAPSettings &

aSettings

)

[pure virtual]

Sets the EAP types configuration

Parameters

const EAPSettings & aSettings

Structure containing the settings

SetIndexL(const TIndexType, const TInt)

void	SetIndexL	(	const TIndexType	aIndexType,
			const TInt	aIndex
		)	[pure virtual]

Changes the index of the saved parameters.

Parameters

const TIndexType aIndexType	Indicates the bearer used for this connection.
const TInt aIndex	Index for the connection. aIndexType and aIndex uniquely specify the connection.

SetTunnelingType(const TInt)

void

SetTunnelingType

(

const TInt

aTunnelingType

)

[pure virtual]

Sets the tunneling type. This is used to indicate that this type is run inside another EAP type.

Parameters

const TInt aTunnelingType

Type number for the tunneling type

Member Data Documentation

TUid iDtor_ID_Key

TUid

iDtor_ID_Key

[private]

CEapType Class Reference

Inherits from

Constructor & Destructor Documentation

~CEapType()

Member Functions Documentation

CopySettingsL(const TIndexType, const TInt)

Parameters

DeleteConfigurationL()

GetConfigurationL(EAPSettings &)

Parameters

GetInfoLC()

GetInterfaceVersion()

GetStackInterfaceL(abs_eap_am_tools_c *const, abs_eap_base_type_c *const, const bool, const eap_am_network_id_c *const, abs_eap_configuration_if_c *const)

Parameters

InvokeUiL()

IsDisallowedInsidePEAP(const CImplementationInformation &)

Parameters

IsDisallowedInsideTTLS(const CImplementationInformation &)

Parameters

IsDisallowedOutsidePEAP(const CImplementationInformation &)

Parameters

NewL(const TDesC8 &, TIndexType, TInt)

Parameters

SetConfigurationL(const EAPSettings &)

Parameters

SetIndexL(const TIndexType, const TInt)

Parameters

SetTunnelingType(const TInt)

Parameters

Member Data Documentation

TUid iDtor_ID_Key

GetStackInterfaceL(abs_eap_am_tools_c const, abs_eap_base_type_c const, const bool, const eap_am_network_id_c const, abs_eap_configuration_if_c const)