Collapse all Symbian^3 Product Developer Library

MNifIfNotify Class Reference

class MNifIfNotify

Interface from the nif and the protocol layers to Nifman

Public Member Functions
TInt	Authenticate(TDes &, TDes &)
void	BinderLayerDown(CNifIfBase *, TInt, TAction)
void	CancelAuthenticate()
void	CloseRoute()
TInt	GetExcessData(TDes8 &)
void	IfProgress(TInt, TInt)
void	IfProgress(TSubConnectionUniqueId, TInt, TInt)
void	LinkLayerDown(TInt, TAction)
void	LinkLayerUp()
void	NegotiationFailed(CNifIfBase *, TInt)
void	NifEvent(TNetworkAdaptorEventType, TUint, const TDesC8 &, TAny *)
TInt	Notification(TNifToAgentEventType, void *)
void	NotifyDataReceived(TSubConnectionUniqueId, TUint)
void	NotifyDataSent(TSubConnectionUniqueId, TUint)
void	OpenRoute()
TInt	PacketActivity(TDataTransferDirection, TUint, TBool)
IMPORT_C TInt	ReadBool(const TDesC &, TBool &, const RMessagePtr2 *)
IMPORT_C TInt	ReadBool(const TDesC &, TBool &)
IMPORT_C TInt	ReadDes(const TDesC &, TDes8 &, const RMessagePtr2 *)
IMPORT_C TInt	ReadDes(const TDesC &, TDes8 &)
IMPORT_C TInt	ReadDes(const TDesC &, TDes16 &, const RMessagePtr2 *)
IMPORT_C TInt	ReadDes(const TDesC &, TDes16 &)
IMPORT_C TInt	ReadInt(const TDesC &, TUint32 &, const RMessagePtr2 *)
IMPORT_C TInt	ReadInt(const TDesC &, TUint32 &)
IMPORT_C TInt	WriteBool(const TDesC &, TBool, const RMessagePtr2 *)
IMPORT_C TInt	WriteBool(const TDesC &, TBool)
IMPORT_C TInt	WriteDes(const TDesC &, const TDesC8 &, const RMessagePtr2 *)
IMPORT_C TInt	WriteDes(const TDesC &, const TDesC8 &)
IMPORT_C TInt	WriteDes(const TDesC &, const TDesC16 &, const RMessagePtr2 *)
IMPORT_C TInt	WriteDes(const TDesC &, const TDesC16 &)
IMPORT_C TInt	WriteInt(const TDesC &, TUint32, const RMessagePtr2 *)
IMPORT_C TInt	WriteInt(const TDesC &, TUint32)

Protected Member Functions
TInt	DoReadBool(const TDesC &, TBool &, const RMessagePtr2 *)
TInt	DoReadDes(const TDesC &, TDes8 &, const RMessagePtr2 *)
TInt	DoReadDes(const TDesC &, TDes16 &, const RMessagePtr2 *)
TInt	DoReadInt(const TDesC &, TUint32 &, const RMessagePtr2 *)
TInt	DoWriteBool(const TDesC &, TBool, const RMessagePtr2 *)
TInt	DoWriteDes(const TDesC &, const TDesC8 &, const RMessagePtr2 *)
TInt	DoWriteDes(const TDesC &, const TDesC16 &, const RMessagePtr2 *)
TInt	DoWriteInt(const TDesC &, TUint32, const RMessagePtr2 *)

Public Member Enumerations
enum	TAction { EReconnect, ECallBack, EDisconnect, ENoAction }

Member Functions Documentation

Authenticate(TDes &, TDes &)

TInt	Authenticate	(	TDes &	aUsername,
			TDes &	aPassword
		)	[pure virtual]

Request to the agent to return the data required for authentication

Note:

The return values in aUsername and aPassword should not be considered valid until CNifIfLink::AuthenticateComplete() has been called

Parameters

TDes & aUsername	On return, contains the username to be used for authentication
TDes & aPassword	On return, contains the password to be used for authentication

BinderLayerDown(CNifIfBase *, TInt, TAction)

void	BinderLayerDown	(	CNifIfBase *	aBinderIf,
			TInt	aReason,
			TAction	aAction
		)	[pure virtual]

Notification from the nif that a binder layer has gone down

Since: v7.0s

Parameters

CNifIfBase * aBinderIf	An identifier for the binder layer that went down
TInt aReason	The reason for the binder layer failure
TAction aAction	The action to be taken as a result, eg. disconnect, reconnect

CancelAuthenticate()

void

CancelAuthenticate

(

)

[pure virtual]

Request to the agent to cancel a pending authentication

CloseRoute()

void

CloseRoute

(

)

[pure virtual]

Decrement the count of users of this nif

DoReadBool(const TDesC &, TBool &, const RMessagePtr2 *)

TInt	DoReadBool	(	const TDesC &	aField,
			TBool &	aValue,
			const RMessagePtr2 *	aMessage
		)	[protected, pure virtual]

Read an boolean field from the connection settings provider

Parameters

const TDesC & aField	The name of the field to read
TBool & aValue	On return, contains the value of the field read
const RMessagePtr2 * aMessage	for capability checking

DoReadDes(const TDesC &, TDes8 &, const RMessagePtr2 *)

TInt	DoReadDes	(	const TDesC &	aField,
			TDes8 &	aValue,
			const RMessagePtr2 *	aMessage
		)	[protected, pure virtual]

Read a 8-bit descriptor field from the connection settings provider

Parameters

const TDesC & aField	The name of the field to read
TDes8 & aValue	On return, contains the value of the field read
const RMessagePtr2 * aMessage	for capability checking

DoReadDes(const TDesC &, TDes16 &, const RMessagePtr2 *)

TInt	DoReadDes	(	const TDesC &	aField,
			TDes16 &	aValue,
			const RMessagePtr2 *	aMessage
		)	[protected, pure virtual]

Read a 16-bit descriptor field from the connection settings provider

Parameters

const TDesC & aField	The name of the field to read
TDes16 & aValue	On return, contains the value of the field read
const RMessagePtr2 * aMessage	for capability checking

DoReadInt(const TDesC &, TUint32 &, const RMessagePtr2 *)

TInt	DoReadInt	(	const TDesC &	aField,
			TUint32 &	aValue,
			const RMessagePtr2 *	aMessage
		)	[protected, pure virtual]

Read an integer field from the connection settings provider

Parameters

const TDesC & aField	The name of the field to read
TUint32 & aValue	On return, contains the value of the field read
const RMessagePtr2 * aMessage	for capability checking

DoWriteBool(const TDesC &, TBool, const RMessagePtr2 *)

TInt	DoWriteBool	(	const TDesC &	aField,
			TBool	aValue,
			const RMessagePtr2 *	aMessage
		)	[protected, pure virtual]

Write an boolean field to the connection settings provider

Parameters

const TDesC & aField	The name of the field to which to write
TBool aValue	The value to be written to the field
const RMessagePtr2 * aMessage	for capability checking

DoWriteDes(const TDesC &, const TDesC8 &, const RMessagePtr2 *)

TInt	DoWriteDes	(	const TDesC &	aField,
			const TDesC8 &	aValue,
			const RMessagePtr2 *	aMessage
		)	[protected, pure virtual]

Write an 8-bit descriptor field to the connection settings provider

Parameters

const TDesC & aField	The name of the field to which to write
const TDesC8 & aValue	The value to be written to the field
const RMessagePtr2 * aMessage	for capability checking

DoWriteDes(const TDesC &, const TDesC16 &, const RMessagePtr2 *)

TInt	DoWriteDes	(	const TDesC &	aField,
			const TDesC16 &	aValue,
			const RMessagePtr2 *	aMessage
		)	[protected, pure virtual]

Write an 16-bit descriptor field to the connection settings provider

Parameters

const TDesC & aField	The name of the field to which to write
const TDesC16 & aValue	The value to be written to the field
const RMessagePtr2 * aMessage	for capability checking

DoWriteInt(const TDesC &, TUint32, const RMessagePtr2 *)

TInt	DoWriteInt	(	const TDesC &	aField,
			TUint32	aValue,
			const RMessagePtr2 *	aMessage
		)	[protected, pure virtual]

Write an integer field to the connection settings provider

Parameters

const TDesC & aField	The name of the field to which to write
TUint32 aValue	The value to be written to the field
const RMessagePtr2 * aMessage	for capability checking

GetExcessData(TDes8 &)

TInt

GetExcessData

(

TDes8 &

aBuffer

)

[pure virtual]

Fetch any excess data from the agent that it received during connection setup

Parameters

TDes8 & aBuffer

On return, the buffer contains the excess data from the agent

IfProgress(TInt, TInt)

void	IfProgress	(	TInt	aStage,
			TInt	aError
		)	[pure virtual]

Upcall from the nif indicating that a new progress state has been reached on this connection

Pre-condition: The stage value is within the range assigned to nifs i.e. KMinNifProgress <= aStage <= KMaxNifProgress

Since: v5.0

Parameters

TInt aStage	The progress stage that has been reached
TInt aError	Any errors that have occured

IfProgress(TSubConnectionUniqueId, TInt, TInt)

void	IfProgress	(	TSubConnectionUniqueId	aSubConnectionUniqueId,
			TInt	aStage,
			TInt	aError
		)	[pure virtual]

Upcall from the nif indicating that a new progress state has been reached on this subconnection

Pre-condition: The stage value is within the range assigned to nifs i.e. KMinNifProgress <= aStage <= KMaxNifProgress

Since: v7.0s

Parameters

TSubConnectionUniqueId aSubConnectionUniqueId	The subconnection to which this notification refers
TInt aStage	The progress stage that has been reached
TInt aError	Any errors that have occured

LinkLayerDown(TInt, TAction)

void	LinkLayerDown	(	TInt	aReason,
			TAction	aAction
		)	[pure virtual]

Notification from the nif that the link layer has gone down.

Parameters

TInt aReason	A Symbian OS error code indicating the reason for the link closing down
TAction aAction	The action that should be taken as a result of link layer down being signalled

LinkLayerUp()

void

LinkLayerUp

(

)

[pure virtual]

Notification from the nif that the link layer is up

NegotiationFailed(CNifIfBase *, TInt)

void	NegotiationFailed	(	CNifIfBase *	aIf,
			TInt	aReason
		)	[pure virtual]

Indicate that link negotiation failed on this nif to allow nifman to take appropriate action

Parameters

CNifIfBase * aIf	The address of the CNifIfBase/Link object for which negotiation failed
TInt aReason	An error code denoting the reason for failure

NifEvent(TNetworkAdaptorEventType, TUint, const TDesC8 &, TAny *)

void	NifEvent	(	TNetworkAdaptorEventType	aEventType,
			TUint	aEvent,
			const TDesC8 &	aEventData,
			TAny *	aSource = 0
		)	[pure virtual]

Indication that some parameter relating to a subconnection has changed in the nif eg. subconnection closed, opened, QoS changed

Since: v7.0s

TodoIn the future, migrate GUQoS event handler and agent/nif notifications to this generic event handler - Nifman can then act as an event distributor

Parameters

TNetworkAdaptorEventType aEventType	The type of event which has occured - used to direct the event notification to the appropriate component(s)
TUint aEvent	The event which has occured
const TDesC8 & aEventData	Any arguments or additional data to do with the event; the interpretation of this depends on the event
TAny * aSource = 0	An appropriate identifier of the source of the event - this will be used when one receiver is receiving events from many producers

Notification(TNifToAgentEventType, void *)

TInt	Notification	(	TNifToAgentEventType	aEvent,
			void *	aInfo = NULL
		)	[pure virtual]

Notification of an event from the nif

Note:

SC with previous releases broken in v6.1 when first argument changed type

Parameters

TNifToAgentEventType aEvent	The type of event that occured
void * aInfo = NULL	Any data associated with the event

NotifyDataReceived(TSubConnectionUniqueId, TUint)

void	NotifyDataReceived	(	TSubConnectionUniqueId	aSubConnectionUniqueId,
			TUint	aDownlinkVolume
		)	[pure virtual]

Indication that the received bytes threshold for a subconnection has been met or exceeded in the nif

Since: v7.0s

Parameters

TSubConnectionUniqueId aSubConnectionUniqueId	The subconnection to which this notification refers
TUint aDownlinkVolume	The total number of bytes sent by this subconnection

NotifyDataSent(TSubConnectionUniqueId, TUint)

void	NotifyDataSent	(	TSubConnectionUniqueId	aSubConnectionUniqueId,
			TUint	aUplinkVolume
		)	[pure virtual]

Indication that the sent bytes threshold for a subconnection has been met or exceeded in the nif

Since: v7.0s

Parameters

TSubConnectionUniqueId aSubConnectionUniqueId	The subconnection to which this notification refers
TUint aUplinkVolume	The total number of bytes sent by this subconnection

OpenRoute()

void

OpenRoute

(

)

[pure virtual]

Increment the count of users of this nif

PacketActivity(TDataTransferDirection, TUint, TBool)

TInt	PacketActivity	(	TDataTransferDirection	aDirection,
			TUint	aBytes,
			TBool	aResetTimer
		)	[pure virtual]

Indication from network layer that a packet has been transmitted or received

Since: v7.0s

Parameters

TDataTransferDirection aDirection	Whether the packet was transmitted or received
TUint aBytes	The size of the packet
TBool aResetTimer	Whether the idle timer should be reset

ReadBool(const TDesC &, TBool &, const RMessagePtr2 *)

IMPORT_C TInt	ReadBool	(	const TDesC &	aField,
			TBool &	aValue,
			const RMessagePtr2 *	aMessage
		)

Read an boolean field from the connection settings provider Read a boolean field from the connection settings provider DoReadBool

Parameters

const TDesC & aField	The name of the field to read
TBool & aValue	On return, contains the value of the field read
const RMessagePtr2 * aMessage	Message containing security capabilites to be checked

ReadBool(const TDesC &, TBool &)

IMPORT_C TInt	ReadBool	(	const TDesC &	aField,
			TBool &	aValue
		)

Read a boolean field from the connection settings provider DoReadBool

Parameters

const TDesC & aField	The name of the field to read
TBool & aValue	On return, contains the value of the field read

ReadDes(const TDesC &, TDes8 &, const RMessagePtr2 *)

IMPORT_C TInt	ReadDes	(	const TDesC &	aField,
			TDes8 &	aValue,
			const RMessagePtr2 *	aMessage
		)

Read a 8-bit descriptor field from the connection settings provider Read an 8-bit descriptor field from the connection settings provider DoReadDes

Parameters

const TDesC & aField	The name of the field to read
TDes8 & aValue	On return, contains the value of the field read
const RMessagePtr2 * aMessage	Message containing security capabilites to be checked

ReadDes(const TDesC &, TDes8 &)

IMPORT_C TInt	ReadDes	(	const TDesC &	aField,
			TDes8 &	aValue
		)

Read an 8-bit descriptor field from the connection settings provider DoReadDes

Parameters

const TDesC & aField	The name of the field to read
TDes8 & aValue	On return, contains the value of the field read

ReadDes(const TDesC &, TDes16 &, const RMessagePtr2 *)

IMPORT_C TInt	ReadDes	(	const TDesC &	aField,
			TDes16 &	aValue,
			const RMessagePtr2 *	aMessage
		)

Read a 16-bit descriptor field from the connection settings provider Read a 16-bit descriptor field from the connection settings provider DoReadDes

Parameters

const TDesC & aField	The name of the field to read
TDes16 & aValue	On return, contains the value of the field read
const RMessagePtr2 * aMessage	Message containing security capabilites to be checked

ReadDes(const TDesC &, TDes16 &)

IMPORT_C TInt	ReadDes	(	const TDesC &	aField,
			TDes16 &	aValue
		)

Read a 16-bit descriptor field from the connection settings provider DoReadDes

Parameters

const TDesC & aField	The name of the field to read
TDes16 & aValue	On return, contains the value of the field read

ReadInt(const TDesC &, TUint32 &, const RMessagePtr2 *)

IMPORT_C TInt	ReadInt	(	const TDesC &	aField,
			TUint32 &	aValue,
			const RMessagePtr2 *	aMessage
		)

Read an integer field from the connection settings provider Read an integer field from the connection settings provider DoReadInt

Parameters

const TDesC & aField	The name of the field to read
TUint32 & aValue	On return, contains the value of the field read
const RMessagePtr2 * aMessage	Message containing security capabilites to be checked

ReadInt(const TDesC &, TUint32 &)

IMPORT_C TInt	ReadInt	(	const TDesC &	aField,
			TUint32 &	aValue
		)

Read an integer field from the connection settings provider DoReadInt

Parameters

const TDesC & aField	The name of the field to read
TUint32 & aValue	On return, contains the value of the field read

WriteBool(const TDesC &, TBool, const RMessagePtr2 *)

IMPORT_C TInt	WriteBool	(	const TDesC &	aField,
			TBool	aValue,
			const RMessagePtr2 *	aMessage
		)

Write an boolean field to the connection settings provider Write a boolean field to the connection settings provider DoWriteBool

Parameters

const TDesC & aField	The name of the field to which to write
TBool aValue	The value to be written to the field
const RMessagePtr2 * aMessage	Message containing security capabilites to be checked

WriteBool(const TDesC &, TBool)

IMPORT_C TInt	WriteBool	(	const TDesC &	aField,
			TBool	aValue
		)

Write a boolean field to the connection settings provider DoWriteBool

Parameters

const TDesC & aField	The name of the field to which to write
TBool aValue	The value to be written to the field

WriteDes(const TDesC &, const TDesC8 &, const RMessagePtr2 *)

IMPORT_C TInt	WriteDes	(	const TDesC &	aField,
			const TDesC8 &	aValue,
			const RMessagePtr2 *	aMessage
		)

Write an 8-bit descriptor field to the connection settings provider Write an 8-bit descriptor field to the connection settings provider DoWriteDes

Parameters

const TDesC & aField	The name of the field to which to write
const TDesC8 & aValue	The value to be written to the field
const RMessagePtr2 * aMessage	Message containing security capabilites to be checked

WriteDes(const TDesC &, const TDesC8 &)

IMPORT_C TInt	WriteDes	(	const TDesC &	aField,
			const TDesC8 &	aValue
		)

Write an 8-bit descriptor field to the connection settings provider DoWriteDes

Parameters

const TDesC & aField	The name of the field to which to write
const TDesC8 & aValue	The value to be written to the field

WriteDes(const TDesC &, const TDesC16 &, const RMessagePtr2 *)

IMPORT_C TInt	WriteDes	(	const TDesC &	aField,
			const TDesC16 &	aValue,
			const RMessagePtr2 *	aMessage
		)

Write an 16-bit descriptor field to the connection settings provider Write a 16-bit descriptor field to the connection settings provider DoWriteDes

Parameters

const TDesC & aField	The name of the field to which to write
const TDesC16 & aValue	The value to be written to the field
const RMessagePtr2 * aMessage	Message containing security capabilites to be checked

WriteDes(const TDesC &, const TDesC16 &)

IMPORT_C TInt	WriteDes	(	const TDesC &	aField,
			const TDesC16 &	aValue
		)

Write a 16-bit descriptor field to the connection settings provider DoWriteDes

Parameters

const TDesC & aField	The name of the field to which to write
const TDesC16 & aValue	The value to be written to the field

WriteInt(const TDesC &, TUint32, const RMessagePtr2 *)

IMPORT_C TInt	WriteInt	(	const TDesC &	aField,
			TUint32	aValue,
			const RMessagePtr2 *	aMessage
		)

Write an integer field to the connection settings provider Write an integer field to the connection settings provider DoWriteInt

Parameters

const TDesC & aField	The name of the field to which to write
TUint32 aValue	The value to be written to the field
const RMessagePtr2 * aMessage	Message containing security capabilites to be checked

WriteInt(const TDesC &, TUint32)

IMPORT_C TInt	WriteInt	(	const TDesC &	aField,
			TUint32	aValue
		)

Write an integer field to the connection settings provider DoWriteInt

Parameters

const TDesC & aField	The name of the field to which to write
TUint32 aValue	The value to be written to the field

Member Enumerations Documentation

Enum TAction

Enumerators

EReconnect
ECallBack
EDisconnect
ENoAction