Callback Functions

Classes
struct	vpn_callback_table
	structure for passing callback functions to the vpnapi More...
Typedefs
typedef void(*	vpn_connect_cb )(const struct vpn_connect_error *, const char *banner)
	callback for vpn_connect() results
typedef void(*	vpn_disconnect_cb )(vpn_error_t error)
	callback for vpn_disconnect() result
typedef void(*	vpn_state_change_cb )(vpn_state_t state, const vpn_ip_addr_t *peer, const struct vpn_connect_error *)
	state transition callback
typedef void(*	vpn_stats_cb )(vpn_error_t error, uint32_t stats_groups, vpn_stats_t stats)
	callback for vpn_get_stats() results
typedef void(*	vpn_auth_cb )(vpn_auth_t auth, uint32_t auth_attrs, uint32_t allowed_save_attrs, const char *profile_name)
	callback for authentication
typedef void(*	vpn_auth_stop_cb )(void)
	callback to cancel authentication

---

Typedef Documentation

typedef void(* vpn_auth_cb)(vpn_auth_t auth, uint32_t auth_attrs, uint32_t allowed_save_attrs, const char *profile_name)

callback for authentication Parameters: auth  handle for accessing authentication attributes. This variable may be used until vpn_auth_respond() or vpn_auth_abort() is called, or vpn_auth_stop_cb() is recieved. auth_attrs  bitmask of VPN_AUTH flags indicating which authentication attributes were requested by the headend allowed_save_attrs  bitmask of VPN_AUTH flags indicating which authentication can be saved in the profile. See the save_attrs argument to vpn_auth_respond() profile_name  Definition at line 431 of file vpnapi.h.

typedef void(* vpn_auth_stop_cb)(void)

callback to cancel authentication This callback is called to cancel any in-progress user authentication. All authentication user interfaces should be closed, and any state related to the authentication attempt should be destroyed. Definition at line 441 of file vpnapi.h.

typedef void(* vpn_connect_cb)(const struct vpn_connect_error *, const char *banner)

callback for vpn_connect() results Parameters: error  error code from the vpn_connect() attempt. banner  is a user displayable string that contains the login banner that the headend's administrator requires all users to acknowledge before connecting. Definition at line 385 of file vpnapi.h.

typedef void(* vpn_disconnect_cb)(vpn_error_t error)

callback for vpn_disconnect() result Parameters: error  error code from the vpn_disconnect() attempt Definition at line 392 of file vpnapi.h.

typedef void(* vpn_state_change_cb)(vpn_state_t state, const vpn_ip_addr_t *peer, const struct vpn_connect_error *)

state transition callback Parameters: state  new state of the vpn connection. peer  address of current headend. This may change during a connection attempt due to load balancing or backup servers. error  when a state change happens because a connection attempt failed, this value will indicate the reason for the failure Definition at line 403 of file vpnapi.h.

typedef void(* vpn_stats_cb)(vpn_error_t error, uint32_t stats_groups, vpn_stats_t stats)

callback for vpn_get_stats() results Parameters: error  error code from the vpn_get_stats() attempt. statgroups  bitmask of VPN_STATGROUPS_ flags indicating which portions of the stats are available. stats  handle used for accessing the various stats structures. This variable may be used only inside of this callback function. Definition at line 415 of file vpnapi.h.

---