icd_nw_api Struct Reference
[Network module API]

#include <network_api.h>

List of all members.

Public Attributes
gchar *	version
gpointer	private
icd_nw_ip_down_fn	ip_down
icd_nw_ip_up_fn	ip_up
icd_nw_ip_addr_info_fn	ip_addr_info
icd_nw_ip_stats_fn	ip_stats
icd_nw_link_pre_down_fn	link_pre_down
icd_nw_link_post_up_fn	link_post_up
icd_nw_link_post_stats_fn	link_post_stats
icd_nw_link_down_fn	link_down
icd_nw_link_up_fn	link_up
icd_nw_link_stats_fn	link_stats
guint	search_lifetime
guint	search_interval
icd_nw_start_search_fn	start_search
icd_nw_stop_search_fn	stop_search
icd_nw_child_exit_fn	child_exit
icd_nw_network_destruct_fn	network_destruct
icd_nw_layer_renew_fn	ip_renew
icd_nw_layer_renew_fn	link_post_renew
icd_nw_layer_renew_fn	link_renew

---

Detailed Description

The icd_nw_api defines the network connection functions implementable by the modules.

When connecting to the network ICd will call the '_up' functions one after another beginning from the bottom and moving upwards to the next non-NULL ones as long as the status of the callback is ICD_NW_SUCCESS. If any error or ICD_NW_RESTART is signalled through the callback, disconnection will start. With ICD_NW_RESTART the same connection will be retried after disconnection.

When disconnecting, the non-NULL '_down' functions will be called in the opposite order from top to bottom.

---

Member Data Documentation

gchar * icd_nw_api::version

ICd2 version this module is compiled against, set to ICD_NW_MODULE_VERSION

Referenced by icd_network_api_init_cb().

gpointer icd_nw_api::private

private data usable by the module

Referenced by icd_iap_disconnect(), icd_iap_get_ip_stats(), icd_iap_get_ipinfo(), icd_iap_get_link_post_stats(), icd_iap_get_link_stats(), icd_iap_module_next(), icd_iap_run_renew(), icd_iap_up_callback(), icd_network_api_foreach_module_pid(), icd_network_api_init_cb(), icd_network_api_unload_modules(), and icd_nw_init().

icd_nw_ip_down_fn icd_nw_api::ip_down

ip layer address acquisition; normally this is not provided by the module

Referenced by icd_iap_disconnect(), and icd_iap_up_callback().

icd_nw_ip_up_fn icd_nw_api::ip_up

ip layer address acquisition; normally this is not provided by the module

Referenced by icd_iap_module_next(), icd_iap_next_ip_up_module(), icd_network_api_init_cb(), and icd_nw_init().

icd_nw_ip_addr_info_fn icd_nw_api::ip_addr_info

ip address info

Referenced by icd_iap_get_ipinfo(), and icd_network_api_init_cb().

icd_nw_ip_stats_fn icd_nw_api::ip_stats

ip statistics

Referenced by icd_iap_get_ip_stats(), and icd_network_api_init_cb().

icd_nw_link_pre_down_fn icd_nw_api::link_pre_down

link layer deauthentication, if needed

Referenced by icd_iap_disconnect(), and icd_iap_up_callback().

icd_nw_link_post_up_fn icd_nw_api::link_post_up

link layer authentication, if needed

Referenced by icd_iap_module_next(), icd_iap_next_link_post_up_module(), icd_network_api_init_cb(), and icd_nw_init().

icd_nw_link_post_stats_fn icd_nw_api::link_post_stats

link layer authentication statistics

Referenced by icd_iap_get_link_post_stats(), and icd_network_api_init_cb().

icd_nw_link_down_fn icd_nw_api::link_down

bring down the link layer

Referenced by icd_iap_disconnect(), and icd_iap_up_callback().

icd_nw_link_up_fn icd_nw_api::link_up

bring up the link layer

Referenced by icd_iap_module_next(), icd_iap_next_link_up_module(), icd_network_api_init_cb(), and icd_nw_init().

icd_nw_link_stats_fn icd_nw_api::link_stats

link layer statistics

Referenced by icd_iap_get_link_stats(), and icd_network_api_init_cb().

guint icd_nw_api::search_lifetime

Cache lifetime in seconds for a network

Referenced by icd_network_api_init_cb(), icd_nw_init(), icd_scan_cache_expire(), and icd_scan_cb().

guint icd_nw_api::search_interval

Seconds to wait until a new scan is done; must be smaller than search_lifetime

Referenced by icd_network_api_init_cb(), icd_nw_init(), and icd_scan_cb().

icd_nw_start_search_fn icd_nw_api::start_search

search for IAPs

Referenced by icd_dbus_api_scan_all_types(), icd_network_api_init_cb(), icd_nw_init(), icd_scan_network(), icd_scan_results_request(), icd_scan_status_start(), and icd_scan_status_stop().

icd_nw_stop_search_fn icd_nw_api::stop_search

stop (ongoing) search

Referenced by icd_network_api_init_cb(), and icd_nw_init().

icd_nw_child_exit_fn icd_nw_api::child_exit

child process exit

Referenced by icd_network_api_foreach_module_pid().

icd_nw_network_destruct_fn icd_nw_api::network_destruct

function to clean up after this module; no calls to any functions will be made after this

Referenced by icd_network_api_init_cb(), icd_network_api_unload_modules(), and icd_nw_init().

icd_nw_layer_renew_fn icd_nw_api::ip_renew

ip layer address renewal, if needed

Referenced by icd_iap_run_renew().

icd_nw_layer_renew_fn icd_nw_api::link_post_renew

link layer authentication renewal, if needed

Referenced by icd_iap_run_renew().

icd_nw_layer_renew_fn icd_nw_api::link_renew

link layer renewal, if needed

Referenced by icd_iap_run_renew().

---

The documentation for this struct was generated from the following files:

• icd/network_api.h.in
• icd/network_api.h