ICd2 D-Bus API


Defines

#define ICD_DBUS_API_INTERFACE   "com.nokia.icd2"
#define ICD_DBUS_API_PATH   "/com/nokia/icd2"
#define ICD_DBUS_API_SCAN_REQ   "scan_req"
#define ICD_DBUS_API_SCAN_CANCEL   "scan_cancel_req"
#define ICD_DBUS_API_SCAN_SIG   "scan_result_sig"
#define ICD_DBUS_API_CONNECT_REQ   "connect_req"
#define ICD_DBUS_API_SELECT_REQ   "select_req"
#define ICD_DBUS_API_CONNECT_SIG   "connect_sig"
#define ICD_DBUS_API_DISCONNECT_REQ   "disconnect_req"
#define ICD_DBUS_API_STATE_REQ   "state_req"
#define ICD_DBUS_API_STATE_SIG   "state_sig"
#define ICD_DBUS_API_STATISTICS_REQ   "statistics_req"
#define ICD_DBUS_API_STATISTICS_SIG   "statistics_sig"
#define ICD_DBUS_API_ADDRINFO_REQ   "addrinfo_req"
#define ICD_DBUS_API_ADDRINFO_SIG   "addrinfo_sig"

Enumerations

enum  icd_scan_request_flags { ICD_SCAN_REQUEST_ACTIVE = 0, ICD_SCAN_REQUEST_ACTIVE_SAVED = 1, ICD_SCAN_REQUEST_PASSIVE = 2 }
enum  icd_scan_status {
  ICD_SCAN_NEW = 0, ICD_SCAN_UPDATE = 1, ICD_SCAN_NOTIFY = 2, ICD_SCAN_EXPIRE = 3,
  ICD_SCAN_COMPLETE = 4
}
enum  icd_connection_flags { ICD_CONNECTION_FLAG_NONE = 0, ICD_CONNECTION_FLAG_APPLICATION_EVENT = 0, ICD_CONNECTION_FLAG_USER_EVENT = 1, ICD_CONNECTION_FLAG_UI_EVENT = 0x8000 }
enum  icd_connect_status { ICD_CONNECTION_SUCCESSFUL = 0, ICD_CONNECTION_NOT_CONNECTED = 1, ICD_CONNECTION_DISCONNECTED = 2 }
enum  icd_connection_state {
  ICD_STATE_DISCONNECTED = 0, ICD_STATE_CONNECTING = 1, ICD_STATE_CONNECTED = 2, ICD_STATE_DISCONNECTING = 3,
  ICD_STATE_LIMITED_CONN_ENABLED = 4, ICD_STATE_LIMITED_CONN_DISABLED = 5, ICD_STATE_SEARCH_START = 8, ICD_STATE_SEARCH_STOP = 9,
  ICD_STATE_INTERNAL_ADDRESS_ACQUIRED = 15
}

Detailed Description

This is an internal API and considered alpha quality. It may change without further notice.

Define Documentation

#define ICD_DBUS_API_ADDRINFO_REQ   "addrinfo_req"

Request specific connection address info. Note that the address information returned is what was assigned to the connection, any VPNs or tunnels set up later will not get reported.

Arguments: 

 DBUS_TYPE_STRING              service type
 DBUS_TYPE_UINT32              service attributes, see Service Provider API
 DBUS_TYPE_STRING              service id
 DBUS_TYPE_STRING              network type
 DBUS_TYPE_UINT32              network attributes, see Network module API
 DBUS_TYPE_ARRAY (BYTE)        network id

Request address info for all connections.

Arguments: 

 none

Return arguments: 

 DBUS_TYPE_UINT32              number of ICD_DBUS_API_ADDRINFO_SIG sent,
                               zero if no connections are ongoing

Note that the address information returned is what was assigned to the connection, any VPNs or tunnels set up later will not get reported.

#define ICD_DBUS_API_ADDRINFO_SIG   "addrinfo_sig"

Address info signal, sent in response to ICD_DBUS_API_ADDRINFO_REQ if there are ongoing connections.

Arguments: 

 DBUS_TYPE_STRING              service type or empty string
 DBUS_TYPE_UINT32              service attributes, see Service Provider API
 DBUS_TYPE_STRING              service id or empty string
 DBUS_TYPE_STRING              network type or empty string
 DBUS_TYPE_UINT32              network attributes, see Network module API
 DBUS_TYPE_ARRAY (BYTE)        network id or empty string
 DBUS_TYPE_ARRAY (
   DBUS_TYPE_STRING              IP address
   DBUS_TYPE_STRING              IP netmask
   DBUS_TYPE_STRING              IP default gateway
   DBUS_TYPE_STRING              IP address of DNS server #1
   DBUS_TYPE_STRING              IP address of DNS server #2
   DBUS_TYPE_STRING              IP address of DNS server #3
 )

Referenced by icd_dbus_api_addrinfo_send().

#define ICD_DBUS_API_CONNECT_REQ   "connect_req"

Request a network connection Make ICd2 select a suitable connection; normally this should be used.

Arguments: 

 DBUS_TYPE_UINT32              connection flags, see icd_connection_flags

Make ICd2 try the specified connection(s); use only in special cases.

Arguments: 

 DBUS_TYPE_UINT32              connection flags, see icd_connection_flags
 DBUS_TYPE_ARRAY (
   DBUS_TYPE_STRING              service type or empty string
   DBUS_TYPE_UINT32              service attributes, see Service Provider API
   DBUS_TYPE_STRING              service id or empty string
   DBUS_TYPE_STRING              network type
   DBUS_TYPE_UINT32              network attributes, see Network module API
   DBUS_TYPE_ARRAY (BYTE)        network id
 )

Return arguments: 

 none

#define ICD_DBUS_API_CONNECT_SIG   "connect_sig"

Connection result signal for ICD_DBUS_API_CONNECT_REQ and ICD_DBUS_API_SELECT_REQ requests.

Arguments: 

 DBUS_TYPE_STRING              service type or empty string
 DBUS_TYPE_UINT32              service attributes, see Service Provider API
 DBUS_TYPE_STRING              service id or empty string
 DBUS_TYPE_STRING              network type or empty string
 DBUS_TYPE_UINT32              network attributes, see Network module API
 DBUS_TYPE_ARRAY (BYTE)        network id or empty string
 DBUS_TYPE_UINT32              status, see icd_connect_status

Referenced by icd_dbus_api_send_connect_sig().

#define ICD_DBUS_API_DISCONNECT_REQ   "disconnect_req"

Request to disconnect an ongoing connection.

Arguments: 

 DBUS_TYPE_UINT32              connection flags, see icd_connection_flags
 DBUS_TYPE_STRING              service type or empty string
 DBUS_TYPE_UINT32              service attributes, see Service Provider API
 DBUS_TYPE_STRING              service id or empty string
 DBUS_TYPE_STRING              network type or empty string
 DBUS_TYPE_UINT32              network attributes, see Network module API
 DBUS_TYPE_ARRAY (BYTE)        network id or empty string

Request to disconnect the last connection.

Arguments: 

 DBUS_TYPE_UINT32              connection flags, see icd_connection_flags

Return arguments: 

 none

#define ICD_DBUS_API_INTERFACE   "com.nokia.icd2"

D-Bus API interface

Referenced by icd_dbus_api_addrinfo_send(), icd_dbus_api_deinit(), icd_dbus_api_init(), icd_dbus_api_request(), icd_dbus_api_scan_result(), icd_dbus_api_send_connect_sig(), icd_dbus_api_state_scan_send(), icd_dbus_api_statistics_ip_cb(), icd_dbus_api_update_search(), and icd_dbus_api_update_state().

#define ICD_DBUS_API_PATH   "/com/nokia/icd2"

Well-known path for D-Bus API

Referenced by icd_dbus_api_addrinfo_send(), icd_dbus_api_deinit(), icd_dbus_api_init(), icd_dbus_api_scan_result(), icd_dbus_api_send_connect_sig(), icd_dbus_api_state_scan_send(), icd_dbus_api_statistics_ip_cb(), icd_dbus_api_update_search(), and icd_dbus_api_update_state().

#define ICD_DBUS_API_SCAN_CANCEL   "scan_cancel_req"

Cancel a scan.

Arguments: 

 none
Return arguments: 
 none

#define ICD_DBUS_API_SCAN_REQ   "scan_req"

Initiate a scan.

Arguments: 

 DBUS_TYPE_UINT32               passively listen/actively request scan
                                results, see icd_scan_request_flags
 array of DBUS_TYPE_STRING      network types to scan; no array or empty
                                array to scan all network types
Return arguments: 
 array of DBUS_TYPE_STRING      network types which are going to be scanned

#define ICD_DBUS_API_SCAN_SIG   "scan_result_sig"

Scan results signal.

Arguments: 

 DBUS_TYPE_UINT32              status, see icd_scan_status
 DBUS_TYPE_UINT32              timestamp when last seen
 DBUS_TYPE_STRING              service type
 DBUS_TYPE_STRING              service name
 DBUS_TYPE_UINT32              service attributes, see Service Provider API
 DBUS_TYPE_STRING              service id
 DBUS_TYPE_INT32               service priority within a service type
 DBUS_TYPE_STRING              network type
 DBUS_TYPE_STRING              network name
 DBUS_TYPE_UINT32              network attributes, see Network module API
 DBUS_TYPE_ARRAY (BYTE)        network id
 DBUS_TYPE_INT32               network priority for different network types
 DBUS_TYPE_INT32               signal strength/quality, 0 (none) - 10 (good)
 DBUS_TYPE_STRING              station id, e.g. MAC address or similar id
                               you can safely ignore this argument
 DBUS_TYPE_INT32               signal value in dB; use signal strength above
                               unless you know what you are doing

Referenced by icd_dbus_api_scan_result().

#define ICD_DBUS_API_SELECT_REQ   "select_req"

Request the 'Select connection' dialog; only connectiviy UIs should be using this function.

Arguments: 

 DBUS_TYPE_UINT32              connection flags, see icd_connection_flags

Return arguments: 

 none

#define ICD_DBUS_API_STATE_REQ   "state_req"

Request state for a connection.

Arguments: 

 DBUS_TYPE_STRING              service type
 DBUS_TYPE_UINT32              service attributes, see Service Provider API
 DBUS_TYPE_STRING              service id
 DBUS_TYPE_STRING              network type
 DBUS_TYPE_UINT32              network attributes, see Network module API
 DBUS_TYPE_ARRAY (BYTE)        network id

Return arguments: 

 DBUS_TYPE_UINT32              number of ICD_DBUS_API_STATE_SIG signals that
                               will be sent

Request state for all connections.

Arguments: 

 none

Return arguments: 

 DBUS_TYPE_UINT32              number of ICD_DBUS_API_STATE_SIG signals that
                               will be sent

#define ICD_DBUS_API_STATE_SIG   "state_sig"

State signal, sent in response to ICD_DBUS_API_STATE_REQ or broadcasted whenever the state of a connection changes.

Arguments: 

 DBUS_TYPE_STRING              service type or empty string
 DBUS_TYPE_UINT32              service attributes, see Service Provider API
 DBUS_TYPE_STRING              service id or empty string
 DBUS_TYPE_STRING              network type or empty string
 DBUS_TYPE_UINT32              network attributes, see Network module API
 DBUS_TYPE_ARRAY (BYTE)        network id or empty string
 DBUS_TYPE_STRING              error that occured; empty string on success
 DBUS_TYPE_UINT32              state of the network connection, see
                               icd_connection_state

State signal, broadcasted at startup if there are no connections ongoing.

Arguments: 

 DBUS_TYPE_UINT32              ICD_STATE_DISCONNECTED

State signal, sent in response to ICD_DBUS_API_STATE_REQ or broadcasted whenever network search begins or ends.

Arguments: 

 DBUS_TYPE_STRING              the network type for which search is done
 DBUS_TYPE_UINT32              state of the network connection, see
                               icd_connection_state

Referenced by icd_dbus_api_state_scan_send(), icd_dbus_api_update_search(), and icd_dbus_api_update_state().

#define ICD_DBUS_API_STATISTICS_REQ   "statistics_req"

Request specific connection statistics.

Arguments: 

 DBUS_TYPE_STRING              service type
 DBUS_TYPE_UINT32              service attributes, see Service Provider API
 DBUS_TYPE_STRING              service id
 DBUS_TYPE_STRING              network type
 DBUS_TYPE_UINT32              network attributes, see Network module API
 DBUS_TYPE_ARRAY (BYTE)        network id

Request statistics for all connections.

Arguments: 

 none

Return arguments: 

 DBUS_TYPE_UINT32              number of ICD_DBUS_API_STATISTICS_SIG sent,
                               zero if no connections are ongoing

#define ICD_DBUS_API_STATISTICS_SIG   "statistics_sig"

Statistics signal, sent in response to ICD_DBUS_API_STATISTICS_REQ if there are ongoing connections.

Arguments: 

 DBUS_TYPE_STRING              service type or empty string
 DBUS_TYPE_UINT32              service attributes, see Service Provider API
 DBUS_TYPE_STRING              service id or empty string
 DBUS_TYPE_STRING              network type or empty string
 DBUS_TYPE_UINT32              network attributes, see Network module API
 DBUS_TYPE_ARRAY (BYTE)        network id or empty string
 DBUS_TYPE_UINT32              time active, measured in seconds
 DBUS_TYPE_INT32               signal strength/quality, see icd_nw_levels
 DBUS_TYPE_UINT32              bytes sent
 DBUS_TYPE_UINT32              bytes received

Referenced by icd_dbus_api_statistics_ip_cb().

Enumeration Type Documentation

enum icd_connect_status

status of the ICD_DBUS_API_CONNECT_REQ or ICD_DBUS_API_SELECT_REQ connection requests

Enumerator:
ICD_CONNECTION_SUCCESSFUL  the network connection has connected successfully
ICD_CONNECTION_NOT_CONNECTED  the network connection did not connect
ICD_CONNECTION_DISCONNECTED  the connected network connection was disconnected

enum icd_connection_flags

flags for ICD_DBUS_API_CONNECT_REQ

Enumerator:
ICD_CONNECTION_FLAG_NONE  no flags requested
ICD_CONNECTION_FLAG_APPLICATION_EVENT  requested by application
ICD_CONNECTION_FLAG_USER_EVENT  requested due to an user event/action
ICD_CONNECTION_FLAG_UI_EVENT  request comes for a connectivity UI; DO NOT use in applications

enum icd_connection_state

Connection state

Enumerator:
ICD_STATE_DISCONNECTED  Network is or became disconnected
ICD_STATE_CONNECTING  Establishing network connection
ICD_STATE_CONNECTED  Network is connected
ICD_STATE_DISCONNECTING  Network is being disconnected
ICD_STATE_LIMITED_CONN_ENABLED  service provider module informs about enabled limited connectivity
ICD_STATE_LIMITED_CONN_DISABLED  service provider module informs about disabled limited connectivity
ICD_STATE_SEARCH_START  Network searching started
ICD_STATE_SEARCH_STOP  Network searching stopped
ICD_STATE_INTERNAL_ADDRESS_ACQUIRED  Internal network state, IP address(es) has/have been acquired

enum icd_scan_request_flags

flags for ICD_DBUS_API_SCAN_REQ

Enumerator:
ICD_SCAN_REQUEST_ACTIVE  request ICd2 to actively scan all networks
ICD_SCAN_REQUEST_ACTIVE_SAVED  request ICd2 to actively scan saved networks
ICD_SCAN_REQUEST_PASSIVE  passively receive scan results when other apps are requesting them; don't start a network scan because of this application; not yet implemented

enum icd_scan_status

status of the scan

Enumerator:
ICD_SCAN_NEW  the returned network was found
ICD_SCAN_UPDATE  an existing network with better signal strength is found, applications may want to update any saved data concerning signal strength
ICD_SCAN_NOTIFY  other network details have been updated but will not be stored by ICd2; normally networks with this status are best ignored
ICD_SCAN_EXPIRE  the returned network has expired
ICD_SCAN_COMPLETE  this round of scanning is complete and a new scan will be started after the module scan timeout

Generated on Thu Mar 11 09:04:50 2010 for ICd2 by  doxygen 1.5.6