MNifAgentExtendedManagementInterface Class Reference

class MNifAgentExtendedManagementInterface
Interface for extended RConnection functionality Intended for derivation by agents wishing to support extended connection management functionality Corresponding MNifIfExtendedManagementInterface for nifs wishing to support extended connection management functionality since v9.5. Use MCPRs/CPRs/SCPRs instead of agents.
Note:

Augments CNifAgentBase, which provides basic connection management functionality

To support this interface, clients must accept a Control(KCOLAgent, KCOGetAgentEMIPtr, TPckg<MNifIfExtendedManagementInterface*>) and return a pointer to a class that implements this interface

Until the APIs are correctly defined to support agents that start subconnetions, this class should also be derived in the nif

Member Functions Documentation

EnumerateSubConnections(TUint &)

TInt EnumerateSubConnections(TUint &aCount)[pure virtual]

Discover how many subconnections exist on an interface

Note:

All interfaces must support at least one subconnection

Parameters

TUint & aCountOn return, contains the number of subconnections that currently exist on this interface

GetInterfaceType(TConnectionType &)

TInt GetInterfaceType(TConnectionType &aConnectionType)[pure virtual]

Find out the type of this connection (eg. CSD, GPRS, CDMA, Ethernet, some more specific subtype)

Parameters

TConnectionType & aConnectionTypeOn return, contains the type of the connection

GetSubConnectionInfo(TUint, TDes8 &)

TInt GetSubConnectionInfo(TUintaIndex,
TDes8 &aSubConnectionInfo
)[pure virtual]

Get information about a subconnection with no prior knowledge of the unique id of any subconnetion

Note:

aSubConnectionInfo should contain a class derived from TSubConnectionInfo; the class should be suitable for type of interface being queried, however it is up to the interface to check this.

The type of the class can be determined by checking the iConnectionType member

Unique IDs for subconnections are on a per-nif basis. It is the responsibility of the nif or agent to generate these IDs and to ensure they are unique across the connection

Parameters

TUint aIndexA number between one and the total number of subconnections returned by EnumerateSubConnections()
TDes8 & aSubConnectionInfoShould contain a class derived from TSubConnectionInfo and suitable for the type of the interface being queried; on return, contains the class with all its members filled in

GetSubConnectionInfo(TDes8 &)

TInt GetSubConnectionInfo(TDes8 &aSubConnectionInfo)[pure virtual]

Get information about the subconnection with the supplied unique ID

Note:

aSubConnectionInfo should contain a class derived from TSubConnectionInfo; the class should be suitable for type of interface being queried, however it is up to the interface to check this.

The type of the class can be determined by checking the iConnectionType member

Parameters

TDes8 & aSubConnectionInfoShould contain a class derived from TSubConnectionInfo and suitable for the type of the interface being queried, and with the iSubConnectionUniqueId member set to the appropriate unique ID