Framework API

Connection Manager Framework API

The following lists summarize the Connection Manager Framework APIs and their intended usage. This section includes interaction API with Profile Manager Plug-in and Transport plug-in interface APIs. For Transport Plug-in, API document is only capturing PDP and WLAN Transport Plug-in interface.

CM - PM Plug-in APIs
  1. NetPMGetProfile
  2. NetPMGetDefaultProfileId
CM - PDP Transport Plug-in APIs
  1. NetPDPInit
  2. NetPDPOpenConnection
  3. NetPDPCloseConnection
  4. NetPdpDeInit
  5. NetPdpTunnelRequest
CM - WLAN Transport Plug-in API
  1. NetWlanInit
  2. NetWlanOpenConnection
  3. NetWlanCloseConnection
  4. NetWlanDeInit
  5. NetWlanTunnelRequest

Transport Plug-in Callback Ids

The lists below summarize the Callback Ids returned by registered CM callback functions used by the PDP and WLAN Transport Plug-in interfaces.

PDP Callback Ids
  1. NET_EVENT_PDP_ACTIVATION_RSP
  2. NET_EVENT_PDP_DEACTIVATION_RSP
  3. NET_EVENT_PDP_DEACTIVATION_IND
  4. NET_EVENT_PDP_SUSPEND_IND
  5. NET_EVENT_PDP_RESUME_IND
  6. NET_EVENT_PDP_TUNNEL
WLAN Callback Ids
  1. NET_EVENT_WLAN_CONNECTION_RSP
  2. NET_EVENT_WLAN_DISCONNECTION_RSP
  3. NET_EVENT_WLAN_DISCONNECTION_IND
  4. NET_EVENT_WLAN_TUNNEL

DataType Definitions

Error Values

NetErr_t (Error values)

Callback Event Data Structures

  1. NetEvent_t (Net Event type)
  2. NetEventInfo_t (NET Event Information)
  3. NetDevInfo_t (NET Device Information)

Profile Data Structures

  1. NetProfileType_t (NET Profile Type)
  2. NetPdpProfileInfo_t (NET PDP Profile Information)
  3. NetWlanProfileInfo_t (NET WLAN Profile Info)
  4. NetProfile_t (NET Profile)
  5. NetBssInfo_t (NET WLAN BSS Info)
  6. NetBssType_t (NET BSS type)

Address Data Structures

In LiMo Foundation Platform Release 1, only IPv4 address type shall be supported. IPv6 may be supported in future releases.

  1. NetAddrType_t (NET Address Type )
  2. NetAddr_t (NET Address)

NET CM API Data Structures

  1. NetTransportType_t (NET Transport type)
  2. NetCMTunnelInfo_t (NET Tunnel Info)

Authentication Data Structures

  1. NetAuthType_t (NET Authentication Type)
  2. NetAuthInfo_t (NET Authentication Information)

QOS Data Stuctures

  1. NetPdpQosType_t (NET PDP QOS Type)
  2. NetPdpQosGprs_t (NET PDP GPRS QOS Type)
  3. NetPdpQosUmts_t (NET PDP 3G QOS Type)
  4. NetPdpQosInfo_t (NET PDP QoS information)

Data Constants

CM Defined
NET_CM_FAILURE
NET_CM_SUCCESS
NET_CM_INVALID_ID
Other Defined Constants
NET_DEVICE_NAME_LEN_MAX
NET_CONNECTIONS_MAX
NET_PDP_APN_LEN_MAX
NET_PDP_AUTH_USERNAME_LEN_MAX
NET_PDP_AUTH_PASSWORD_LEN_MAX
NET_DNS_ADDR_MAX

Connection Manager to Profile Manager Plug-in API

This section describes the Profile Manager Plug-in APIs that shall be used by Connection Manager.
  1. NetPMGetProfile
  2. NetPMGetDefaultProfileId

Connection Manager to PDP Transport Plug-in API

  1. NetPDPInit
  2. NetPDPOpenConnection
  3. NetPDPCloseConnection
  4. NetPdpDeInit
  5. NetPdpTunnelRequest

PDP Callback Specification (PDP Transport Plug-in to CM)

Connection Manager needs to register a callback function with PDP transport plug-in to receive asynchronous events. This section describes the callback function which will be used to notify the Connection manager about the PDP Transport Plug-in Asynchronous events.
NetPdpEvtCb
Plug-in will allocate the memory for event data. Once Context returns from callback then plug-in will free the memory allocated to event data.

PDP Asynchronous Events
NetPdpTransportEvent_t
Events are:
  1. NET_EVENT_PDP_ACTIVATION_RSP
  2. NET_EVENT_PDP_DEACTIVATION_RSP
  3. NET_EVENT_PDP_DEACTIVATION_IND
  4. NET_EVENT_PDP_SUSPEND_IND
  5. NET_EVENT_PDP_RESUME_IND
  6. NET_EVENT_PDP_TUNNEL
PDP Connection Information
NetPdpConnInfo_t

Connection Manager to WLAN Transport Plug-in API

  1. NetWlanInit
  2. NetWlanOpenConnection
  3. NetWlanCloseConnection
  4. NetWlanDeInit
  5. NetWlanTunnelRequest

WLAN Callback Event Data Structures

WLAN Callback Specification (WLAN Transport Plug-in to CM)
Connection Manager needs to register a callback function with WLAN transport plug-in to receive asynchronous WLAN events. This section describes the callback function which will be used to notify the Connection manager about the WLAN Transport Plug-in Asynchronous events.

NetWlanEvtCb

The Plug-in will allocate the memory for event data. Once Context returns from callback then plug-in will free the memory allocated to event data.

WLAN Asynchronous Events

NetWlanTransportEvent_t

Events are:
  1. NET_EVENT_WLAN_CONNECTION_RSP
  2. NET_EVENT_WLAN_DISCONNECTION_RSP
  3. NET_EVENT_WLAN_DISCONNECTION_IND
  4. NET_EVENT_WLAN_TUNNEL

WLAN Plug-in Device Information

NetWlanConnInfo_t
Generated on Mon Mar 31 01:01:00 2008 by  doxygen 1.5.4