Data Types and Structures

Classes
union	vpn_ip_addr_t
	datastructure represinting an IP address More...
struct	vpn_route
	datastructure representing a route (secured or unsecured) More...
struct	vpn_routes
	a set of routes. More...
struct	vpn_counters
	IPSec traffic statistics. More...
struct	vpn_tunnel_info
	basic information about a VPN tunnel More...
struct	vpn_connect_error
Typedefs
typedef int32_t	vpn_error_t
	return type for most functions
typedef void *	vpn_channel_t
	opaque representation of a communications channel with the VPN service
typedef void *	vpn_stats_t
	opaque representation VPN connection statistics
typedef void *	vpn_auth_t
	opaque representation VPN authentication information
Enumerations
enum	vpn_state_t {   VPN_MIN_STATE = -1, VPN_STATE_IDLE, VPN_STATE_WAIT_PPP, VPN_STATE_WAIT_CTCP,   VPN_STATE_WAIT_PHASE1, VPN_STATE_WAIT_AUTH, VPN_STATE_WAIT_MODECFG, VPN_STATE_WAIT_PHASE2,   VPN_STATE_CONNECTED, VPN_MAX_STATE }
	Possible states for a VPN connection. More...
enum	vpn_crypto_t {   VPN_MIN_CRYPTO_ALG = 0, VPN_CRYPTO_DES, VPN_CRYPTO_3DES, VPN_CRYPTO_NULL,   VPN_CRYPTO_AES, VPN_MAX_CRYPTO_ALG }
	IPSec encryption algorithms. More...
enum	vpn_hash_t { VPN_MIN_HASH = 0, VPN_HASH_MD5, VPN_HASH_SHA, VPN_MAX_HASH }
	IPSec authentication algorithms. More...
enum	vpn_compress_t { VPN_MIN_COMPRESS_ALG = 0, VPN_COMPRESS_NONE, VPN_COMPRESS_LZS, VPN_MAX_COMPRESS_ALG }
	IP Compression algorithms. More...
enum	vpn_nat_mode_t {   VPN_MIN_NAT_MODE = 0, VPN_NAT_NONE, VPN_NAT_IPSEC_OVER_UDP, VPN_NAT_IPSEC_OVER_CTCP,   VPN_MAX_NAT_MODE }
	NAT pass-through algorithms. More...

---

Typedef Documentation

typedef void* vpn_auth_t

opaque representation VPN authentication information This datastructure is accessed by the functions whose names begin with "vpn_auth" Definition at line 235 of file vpnapi.h.

typedef void* vpn_channel_t

opaque representation of a communications channel with the VPN service This datatype is used to issue commands and receive data from the VPN service. It is intialized by calling vpn_channel_init() and destroyed by calling vpn_channel_destroy() Definition at line 221 of file vpnapi.h.

typedef int32_t vpn_error_t

return type for most functions Definition at line 140 of file vpnapi.h.

typedef void* vpn_stats_t

opaque representation VPN connection statistics This datastructure is accessed by the functions whose names begin with "vpn_stats" Definition at line 228 of file vpnapi.h.

---

Enumeration Type Documentation

enum vpn_compress_t

IP Compression algorithms. Enumerator: VPN_MIN_COMPRESS_ALG  VPN_COMPRESS_NONE  No IP Compression. VPN_COMPRESS_LZS  LZS. VPN_MAX_COMPRESS_ALG  Definition at line 192 of file vpnapi.h.

enum vpn_crypto_t

IPSec encryption algorithms. Enumerator: VPN_MIN_CRYPTO_ALG  VPN_CRYPTO_DES  DES. VPN_CRYPTO_3DES  3DES VPN_CRYPTO_NULL  No Encryption. VPN_CRYPTO_AES  AES. VPN_MAX_CRYPTO_ALG  Definition at line 166 of file vpnapi.h.

enum vpn_hash_t

IPSec authentication algorithms. Enumerator: VPN_MIN_HASH  VPN_HASH_MD5  HMAC-MD5. VPN_HASH_SHA  HMAC-SHA. VPN_MAX_HASH  Definition at line 181 of file vpnapi.h.

enum vpn_nat_mode_t

NAT pass-through algorithms. Enumerator: VPN_MIN_NAT_MODE  VPN_NAT_NONE  Normal IPSec. VPN_NAT_IPSEC_OVER_UDP  IPSec over UDP. VPN_NAT_IPSEC_OVER_CTCP  IPSec over cTCP. VPN_MAX_NAT_MODE  Definition at line 203 of file vpnapi.h.

enum vpn_state_t

Possible states for a VPN connection. Enumerator: VPN_MIN_STATE  VPN_STATE_IDLE  VPN is not connected. VPN_STATE_WAIT_PPP  Waiting for PPP connection to come up. VPN_STATE_WAIT_CTCP  Waiting for cTCP handshake to complete. VPN_STATE_WAIT_PHASE1  Waiting for IKE Phase 1 to complete. VPN_STATE_WAIT_AUTH  Waiting for authentication to complete. VPN_STATE_WAIT_MODECFG  Waiting for MODE-CFG to complete. VPN_STATE_WAIT_PHASE2  Waiting for IKE Phase 2 to complete. VPN_STATE_CONNECTED  VPN is Connected. VPN_MAX_STATE  Definition at line 143 of file vpnapi.h.

---