Network module API definitions


Defines

#define ICD_NW_ATTR_IAPNAME   0x01000000
#define ICD_NW_ATTR_SILENT   0x02000000
#define ICD_NW_ATTR_AUTOCONNECT   0x04000000
#define ICD_NW_ATTR_SRV_PROVIDER   0x10000000
#define ICD_NW_ATTR_LOCALMASK   0x00FFFFFF
#define ICD_NW_SEARCH_SCOPE_ALL   0x0
#define ICD_NW_SEARCH_SCOPE_SAVED   0x1

Enumerations

enum  icd_nw_status {
  ICD_NW_SUCCESS = 0, ICD_NW_SUCCESS_NEXT_LAYER = 1, ICD_NW_RESTART = 2, ICD_NW_ERROR = 3,
  ICD_NW_TOO_MANY_CONNECTIONS = 4, ICD_NW_ERROR_USER_ACTION_DONE = 5, ICD_NW_RESTART_IP = 6, ICD_NW_RESTART_LINK_POST = 7,
  ICD_NW_RESTART_LINK = 8
}
enum  icd_nw_renew_status { ICD_NW_RENEW_NO_CHANGES = 0, ICD_NW_RENEW_CHANGES_MADE = 1 }
enum  icd_nw_levels {
  ICD_NW_LEVEL_NONE = 0, ICD_NW_LEVEL_1, ICD_NW_LEVEL_2, ICD_NW_LEVEL_3,
  ICD_NW_LEVEL_4, ICD_NW_LEVEL_5, ICD_NW_LEVEL_6, ICD_NW_LEVEL_7,
  ICD_NW_LEVEL_8, ICD_NW_LEVEL_9, ICD_NW_LEVEL_10
}
enum  icd_network_search_status { ICD_NW_SEARCH_CONTINUE = 0, ICD_NW_SEARCH_COMPLETE = 1, ICD_NW_SEARCH_EXPIRE = 2 }
enum  icd_nw_layer {
  ICD_NW_LAYER_NONE = 0, ICD_NW_LAYER_LINK = 1, ICD_NW_LAYER_LINK_POST = 2, ICD_NW_LAYER_IP = 3,
  ICD_NW_LAYER_SERVICE = 4, ICD_NW_LAYER_ALL = 5
}

Detailed Description

This file contains general network API definitions.

Define Documentation

#define ICD_NW_ATTR_AUTOCONNECT   0x04000000

Whether we have all required credentials to authenticate ourselves to the network automatically without any user interaction

#define ICD_NW_ATTR_IAPNAME   0x01000000

Type of network id; set for IAP name, unset for local id, e.g. WLAN SSID

#define ICD_NW_ATTR_LOCALMASK   0x00FFFFFF

Mask for network attribute local values, e.g. security settings, WLAN mode, etc. These values might be evaluated by relevant UI components

#define ICD_NW_ATTR_SILENT   0x02000000

UI and user interaction forbidden if set, allowed if unset

#define ICD_NW_ATTR_SRV_PROVIDER   0x10000000

Whether this network always needs service provider support in order to get connected

#define ICD_NW_SEARCH_SCOPE_ALL   0x0

Search for all available networks in range

#define ICD_NW_SEARCH_SCOPE_SAVED   0x1

Search for saved IAPs


Enumeration Type Documentation

search function callback status

Enumerator:
ICD_NW_SEARCH_CONTINUE  Search continues, more values to be expected soon
ICD_NW_SEARCH_COMPLETE  Search is completed or the module cannot continue due to some error; the search callback values are ignored
ICD_NW_SEARCH_EXPIRE  Search result is expired due to external reasons and needs to be removed immediately from the cache

Network module layer

Enumerator:
ICD_NW_LAYER_NONE  No layer
ICD_NW_LAYER_LINK  Link layer
ICD_NW_LAYER_LINK_POST  Post-link or link authentication layer
ICD_NW_LAYER_IP  IP network layer
ICD_NW_LAYER_SERVICE  Service layer provided by a service module, see Service Provider API
ICD_NW_LAYER_ALL  All layers

signal level from lowest (_NONE) to highest (_10)

Enumerator:
ICD_NW_LEVEL_NONE  no signal
ICD_NW_LEVEL_1  signal level 1
ICD_NW_LEVEL_2  signal level 2
ICD_NW_LEVEL_3  signal level 3
ICD_NW_LEVEL_4  signal level 4
ICD_NW_LEVEL_5  signal level 5
ICD_NW_LEVEL_6  signal level 6
ICD_NW_LEVEL_7  signal level 7
ICD_NW_LEVEL_8  signal level 8
ICD_NW_LEVEL_9  signal level 9
ICD_NW_LEVEL_10  signal level 10

Renew status codes

Enumerator:
ICD_NW_RENEW_NO_CHANGES  No visible changes in any network parameters changed, no further action required
ICD_NW_RENEW_CHANGES_MADE  Network parameters have changed, restart this and above network layers

status of the icd_nw_api function call returned in respective callbacks

Enumerator:
ICD_NW_SUCCESS  function call succeeded; ICd will now call the next non-NULL icd_nw_api '_up' function on the same layer from any other module that has the same type but greater priority number
ICD_NW_SUCCESS_NEXT_LAYER  function call succeeded; ICd will now call the next non-NULL icd_nw_api '_up' function from the layer above. This status code is ignored on disconnect.
ICD_NW_RESTART  restart this IAP; ICd will first call the all icd_nw_api '_down' functions starting with the one for this level and then restart from link_up. This status code is ignored on disconnect.
ICD_NW_ERROR  generic error condition; the network will be closed down and the corresponding 'err_str' should contain more information on the error. The 'err_str' is currently formatted as a D-Bus error, e.g. "com.nokia.icd.error.somedescriptivestring". This status code is ignored on disconnect.
ICD_NW_TOO_MANY_CONNECTIONS  network module is already in use by another connection. This status code is ignored on disconnect.
ICD_NW_ERROR_USER_ACTION_DONE  network module has done all the needed user interaction, no need to show retry dialogs or similar. This status code is ignored on disconnect.
ICD_NW_RESTART_IP  Restart the IP layer of this IAP; ICd will first call the icd_srv_disconnect_fn if needed and then call any required icd_nw_ip_down_fn functions. When done, any required icd_nw_ip_up and icd_srv_connect_fn functions will be called normally. This status code is ignored on disconnection.
ICD_NW_RESTART_LINK_POST  Restart up to link post layer of this IAP; works similarly to ICD_NW_RESTART_IP. This status code is ignored on disconnect.
ICD_NW_RESTART_LINK  Restart up to link layer of this IAP; works similarly to ICD_NW_RESTART_IP. This status code is ignored on disconnect.


Generated on Wed Sep 30 22:16:01 2009 for ICd2 by  doxygen 1.5.6