Collapse all Symbian^3 Application Developer Library

MNifAgentNotify Class Reference

class MNifAgentNotify

Interface from the agent to Nifman

since v9.5. Use MCPRs/CPRs/SCPRs instead of agents.

Public Member Functions
void	AgentEvent ( TNetworkAdaptorEventType , TUint , const TDesC8 &, TAny *)
void	AgentProgress ( TInt , TInt )
void	AgentProgress ( TSubConnectionUniqueId , TInt , TInt )
void	AuthenticateComplete ( TInt )
void	ConnectComplete ( TInt )
void	DisconnectComplete ()
TInt	IncomingConnectionReceived ()
TInt	Notification ( TAgentToNifEventType , TAny *)
void	ReconnectComplete ( TInt )
void	ServiceClosed ()
void	ServiceStarted ()

Member Functions Documentation

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

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

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

Since: v7.0s

Parameters

TNetworkAdaptorEventType aEventType	The type of the event
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

AgentProgress(TInt, TInt)

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

Progress notification from an agent for a connection

Since: v5.0

Parameters

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

AgentProgress(TSubConnectionUniqueId, TInt, TInt)

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

Progress notification from an agent for a subconnection

Note:

This function will not be called until agents support starting subconnections

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

AuthenticateComplete(TInt)

void

AuthenticateComplete

(

TInt

aStatus

)

[pure virtual]

Indication that the agent has finished authenticating

Parameters

TInt aStatus

The error code, if any, from the reconnection attempt

ConnectComplete(TInt)

void

ConnectComplete

(

TInt

aStatus

)

[pure virtual]

Callback to indicate that the agent has finished its connection phase, and is ready to pass control to the nif

Parameters

TInt aStatus

The error code generated by this phase of connection startup

DisconnectComplete()

void

DisconnectComplete

(

)

[pure virtual]

IncomingConnectionReceived()

TInt

IncomingConnectionReceived

(

)

[pure virtual]

Note:

Needs to be called by the agent when it gets an incoming call so that agent can wait for an incoming and do an outgoing at the same time, i.e. it waits for the incoming without NifMan's knowledge

Since: v6.1

Notification(TAgentToNifEventType, TAny *)

TInt	Notification	(	TAgentToNifEventType	aEvent,
			TAny *	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

Since

Parameters

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

ReconnectComplete(TInt)

void

ReconnectComplete

(

TInt

aStatus

)

[pure virtual]

Callback to indicate that the agent has performed the requested reconnection

Note:

Obviously, this is only used in situations where the agent has received a request to reconnect

Parameters

TInt aStatus

The error code, if any, from the reconnection attempt

ServiceClosed()

void

ServiceClosed

(

)

[pure virtual]

ServiceStarted()

void

ServiceStarted

(

)

[pure virtual]

Callback from the agent to indicate that it has successfully started the connection

Note:

This call will cause nifman to load and bind the nif

This does not mean that the connection is ready for use by the nif yet - the nif is handed control after ConnectComplete()