Command functions

types of messages that client wants to send/recieve More...

Functions
DLL_EXPORT_NAME vpn_error_t CDECLAPI	vpn_connect (vpn_channel_t channel, const char *profile, const char *group_name, const char *password, uint32_t option_flags)
	try to connect using a given profile.
DLL_EXPORT_NAME vpn_error_t CDECLAPI	vpn_acknowledge_banner (vpn_channel_t channel, int banner_accepted)
	used to return users response to the banner given in vpn_connect_cb()
DLL_EXPORT_NAME vpn_error_t CDECLAPI	vpn_disconnect (vpn_channel_t channel)
	disconnect the vpn tunnel.
DLL_EXPORT_NAME vpn_error_t CDECLAPI	vpn_get_stats (vpn_channel_t channel, uint32_t stats_groups)
	request statistics to be sent
DLL_EXPORT_NAME vpn_error_t CDECLAPI	vpn_reset_stats (vpn_channel_t channel)
	Reset byte and packet counts in the statistics.
DLL_EXPORT_NAME vpn_error_t CDECLAPI	vpn_auth_respond (vpn_channel_t channel, vpn_auth_t auth, uint32_t save_attrs)
	reply to a fp_auth callback.
DLL_EXPORT_NAME vpn_error_t CDECLAPI	vpn_auth_abort (vpn_channel_t channel, vpn_auth_t auth)
	negative reply to a fp_auth callback.

---

Detailed Description

types of messages that client wants to send/recieve

---

Function Documentation

DLL_EXPORT_NAME vpn_error_t CDECLAPI vpn_acknowledge_banner (  vpn_channel_t  channel, int  banner_accepted )

used to return users response to the banner given in vpn_connect_cb() Parameters: channel  banner_accepted  TRUE if the user agrees to the banner, FALSE if the user disagrees.

DLL_EXPORT_NAME vpn_error_t CDECLAPI vpn_auth_abort (  vpn_channel_t  channel, vpn_auth_t  auth )

negative reply to a fp_auth callback. This function is called to cancel an authentication attempt. msgtype VPN_MSGTYPE_AUTH is needed to send. Parameters: channel  auth

DLL_EXPORT_NAME vpn_error_t CDECLAPI vpn_auth_respond (  vpn_channel_t  channel, vpn_auth_t  auth, uint32_t  save_attrs )

reply to a fp_auth callback. This function is called to pass back authentication attributes to the headend. msgtype VPN_MSGTYPE_AUTH is needed to send. Parameters: channel  auth  save_attrs  a bitmask of VPN_AUTH flags indicating which attributes should be saved in the profile. Attributes that were not set in the allowed_save_attrs argument to vpn_auth_cb will be ignored.

DLL_EXPORT_NAME vpn_error_t CDECLAPI vpn_connect (  vpn_channel_t  channel, const char *  profile, const char *  group_name, const char *  password, uint32_t  option_flags )

try to connect using a given profile. Parameters: channel  the channel to use for sending the command profile  the name of the profile group_name  the name of the profile. May be NULL if the group name is saved in the profile password  is the group password or the certificate password, depending on the setting of AuthType value in the profile. may be NULL if the group password is saved in the profile. option_flags  bitmask of VPN_OPT_* flags. Calling this function will cause fp_connect to be called when the connection attempt suceeds. Additionally, fp_stats will be called for state changes during the connection attempt and fp_auth/fp_auth_stop will be called to handle authentication.

DLL_EXPORT_NAME vpn_error_t CDECLAPI vpn_disconnect (  vpn_channel_t  channel  )

disconnect the vpn tunnel. causes fp_disconnect to be called with the result of the disconnect attempt. No VPN_MSGTYPE flag is needed to send.

DLL_EXPORT_NAME vpn_error_t CDECLAPI vpn_get_stats (  vpn_channel_t  channel, uint32_t  stats_groups )

request statistics to be sent causes fp_statistics to be called. no mstype needed to send. Parameters: channel  stats_groups  flags describing which statistics to send. use VPN_STATGROUP flags

DLL_EXPORT_NAME vpn_error_t CDECLAPI vpn_reset_stats (  vpn_channel_t  channel  )

Reset byte and packet counts in the statistics. no mstype needed to send. Parameters: channel

---