Collapse all Symbian^3 Product Developer Library

CNifIfBase Class Reference

class CNifIfBase : public CBase

Base class for nif binder layers. Classes derived from CNifIfBase act as a binder layer to the layer 3 protocol, and send and receive a specified protocol between the network layer and the link layer

Note:

There should be one CNifIfBase object per protocol, per nif instance

Since: v5.0

Inherits from

CNifIfBase
- CBase

Public Member Functions
	CNifIfBase(CNifIfFactory &)
	CNifIfBase()
	~CNifIfBase()
IMPORT_C void	BindL(TAny *)
IMPORT_C void	Cleanup(TAny *)
IMPORT_C void	Close()
IMPORT_C TInt	Control(TUint, TUint, TDes8 &, TAny *)
void	Info(TNifIfInfo &)
TInt	Notification(TAgentToNifEventType, void *)
MNifIfNotify *	Notify()
IMPORT_C void	Open()
TInt	Send(RMBufChain &, TAny *)
IMPORT_C TInt	State()

Protected Member Functions
	CNifIfBase(CNifIfLink &)

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

Protected Attributes
CNifIfFactory *	iFactory
MNifIfNotify *	iNotify
TInt	iRefCount

Constructor & Destructor Documentation

CNifIfBase(CNifIfFactory &)

IMPORT_C

CNifIfBase

(

CNifIfFactory &

aFactory

)

Constructor

Parameters

CNifIfFactory & aFactory

CNifIfBase()

IMPORT_C

CNifIfBase

(

)

Constructor

CNifIfBase(CNifIfLink &)

IMPORT_C

CNifIfBase

(

CNifIfLink &

aLink

)

[protected]

Constructor

Parameters

CNifIfLink & aLink

~CNifIfBase()

IMPORT_C

~CNifIfBase

(

)

Destructor

Member Functions Documentation

BindL(TAny *)

IMPORT_C void

BindL

(

TAny *

aId

)

[virtual]

Bind to the protocol layer (store the pointer to the CProtocolBase object)

Parameters

TAny * aId

A pointer to the protocol layer (should be cast to a CProtocolBase object)

Cleanup(TAny *)

IMPORT_C void

Cleanup

(

TAny *

aIf

)

[static]

Clean up an interface

Parameters

TAny * aIf

Close()

IMPORT_C void

(

)

[virtual]

Decrement reference count

Control(TUint, TUint, TDes8 &, TAny *)

IMPORT_C TInt	Control	(	TUint	aLevel,
			TUint	aName,
			TDes8 &	aOption,
			TAny *	aSource = 0
		)	[virtual]

Control function for additional control of the nif

Parameters

TUint aLevel	The intended level for this control option
TUint aName	The name of the control option
TDes8 & aOption	Any data associated with this control option, contained within a TPckg(Buf)
TAny * aSource = 0	If provided, an identifier for the source of the control option; by default, zero

Info(TNifIfInfo &)

void

Info

(

TNifIfInfo &

aInfo

)

const [pure virtual]

Retrieve information about an network interface

Parameters

TNifIfInfo & aInfo

On return, contains information about the nif

Notification(TAgentToNifEventType, void *)

TInt	Notification	(	TAgentToNifEventType	aEvent,
			void *	aInfo
		)	[pure virtual]

Notification of an event from the agent

Note:

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

Since

Parameters

TAgentToNifEventType aEvent	The type of event that occured
void * aInfo	Any data associated with the event

Notify()

MNifIfNotify *

Notify

(

)

const [inline]

Accessor method for the iNotify pointer to the MNifIfNotify interface

Open()

IMPORT_C void

Open

(

)

[virtual]

Increment reference count

Send(RMBufChain &, TAny *)

TInt	Send	(	RMBufChain &	aPdu,
			TAny *	aSource = 0
		)	[pure virtual]

Send data through this interface

Parameters

RMBufChain & aPdu	A packet contained within a RMBufChain
TAny * aSource = 0	A pointer to the object that is sending this data

State()

IMPORT_C TInt

State

(

)

[virtual]

Return the current state of the interface

Note:

Return interface as being up for BC

Since: v2.0?

Member Data Documentation

CNifIfFactory * iFactory

CNifIfFactory *

iFactory

[protected]

MNifIfNotify * iNotify

MNifIfNotify *

iNotify

[protected]

TInt iRefCount

TInt

iRefCount

[protected]