OpenVPN: tuntap Struct Reference

OpenVPN

#include <tun.h>

Collaboration diagram for tuntap:

Collaboration graph

[legend]

Data Fields
int	type

int	topology

enum tun_driver_type	backend_driver
	The backend driver that used for this tun/tap device.

bool	did_ifconfig_setup
	if the internal variables related to ifconfig of this struct have been set up.

bool	did_ifconfig_ipv6_setup
	if the internal variables related to ifconfig-ipv6 of this struct have been set up.

bool	persistent_if

struct tuntap_options	options

char *	actual_name

in_addr_t	local

in_addr_t	remote_netmask

struct in6_addr	local_ipv6

struct in6_addr	remote_ipv6

int	netbits_ipv6

HANDLE	hand

struct overlapped_io	reads

struct overlapped_io	writes

struct rw_handle	rw_handle

bool	ipapi_context_defined

ULONG	ipapi_context

ULONG	ipapi_instance

in_addr_t	adapter_netmask

DWORD	adapter_index

int	standby_iter

HANDLE	wintun_send_ring_handle

HANDLE	wintun_receive_ring_handle

struct tun_ring *	wintun_send_ring

struct tun_ring *	wintun_receive_ring

unsigned int	rwflags_debug

dco_context_t	dco

afunix_context_t	afunix

Detailed Description

Definition at line 180 of file tun.h.

Field Documentation

◆ actual_name

char* tuntap::actual_name

◆ adapter_index

DWORD tuntap::adapter_index

◆ adapter_netmask

in_addr_t tuntap::adapter_netmask

Definition at line 226 of file tun.h.

Referenced by do_address_service(), do_ifconfig_ipv4(), init_tun(), is_adapter_up(), tuntap_dhcp_mask(), tuntap_set_ip_addr(), and tuntap_set_ip_props().

◆ afunix

afunix_context_t tuntap::afunix

Definition at line 250 of file tun.h.

Referenced by close_tun_afunix(), read_tun_afunix(), tun_afunix_exec_child(), and write_tun_afunix().

◆ backend_driver

enum tun_driver_type tuntap::backend_driver

The backend driver that used for this tun/tap device.

This can be one of the various windows drivers, "normal" tun/tap, utun, dco, ...

Definition at line 191 of file tun.h.

Referenced by can_preserve_tun(), close_tun_handle(), create_socket_dco_win(), do_close_tun_simple(), do_init_tun(), ifconfig_noexec_enabled(), ifconfig_order(), init_tun_post(), open_tun(), open_tun_backend(), process_outgoing_tun(), read_incoming_tun(), route_noexec_enabled(), route_order(), tap_win_getinfo(), tun_open_device(), tun_set(), tun_try_open_device(), tuntap_is_dco_win(), tuntap_is_wintun(), tuntap_post_open(), tuntap_set_ip_addr(), undo_ifconfig(), and write_tun_buffered().

◆ dco

dco_context_t tuntap::dco

Definition at line 249 of file tun.h.

Referenced by check_dco_key_status(), dco_event_set(), do_deferred_options_part2(), do_deferred_p2p_ncp(), do_init_crypto_tls(), do_open_tun(), init_tun_post(), io_wait_dowork(), multi_client_generate_tls_keys(), multi_io_wait(), multi_print_status(), process_incoming_dco(), and setenv_stats().

◆ did_ifconfig_ipv6_setup

bool tuntap::did_ifconfig_ipv6_setup

if the internal variables related to ifconfig-ipv6 of this struct have been set up.

This does NOT mean ifconfig has been called

Definition at line 199 of file tun.h.

Referenced by add_routes(), close_tun(), do_ifconfig(), do_ifconfig_setenv(), init_tun(), tuntap_set_ptp(), and undo_ifconfig().

◆ did_ifconfig_setup

bool tuntap::did_ifconfig_setup

if the internal variables related to ifconfig of this struct have been set up.

This does NOT mean ifconfig has been called

Definition at line 195 of file tun.h.

Referenced by add_routes(), close_tun(), do_ifconfig(), do_ifconfig_ipv6(), do_ifconfig_setenv(), init_tun(), test_routes(), tuntap_post_open(), tuntap_set_ip_addr(), tuntap_set_ptp(), and undo_ifconfig().

◆ hand

HANDLE tuntap::hand

◆ ipapi_context

ULONG tuntap::ipapi_context

Definition at line 224 of file tun.h.

Referenced by close_tun(), and tuntap_set_ip_addr().

◆ ipapi_context_defined

bool tuntap::ipapi_context_defined

Definition at line 223 of file tun.h.

Referenced by close_tun(), and tuntap_set_ip_addr().

◆ ipapi_instance

ULONG tuntap::ipapi_instance

Definition at line 225 of file tun.h.

Referenced by tuntap_set_ip_addr().

◆ local

in_addr_t tuntap::local

Definition at line 208 of file tun.h.

Referenced by do_address_service(), do_close_tun(), do_ifconfig(), do_ifconfig_ipv4(), do_ifconfig_setenv(), do_open_tun(), init_tun(), initialization_sequence_completed(), is_adapter_up(), multi_init(), multi_select_virtual_addr(), netsh_delete_address_dns(), tuntap_dhcp_mask(), tuntap_set_ip_addr(), tuntap_set_ip_props(), tuntap_set_ptp(), and undo_ifconfig_ipv4().

◆ local_ipv6

struct in6_addr tuntap::local_ipv6

Definition at line 211 of file tun.h.

Referenced by add_route_connected_v6_net(), delete_route_connected_v6_net(), do_address_service(), do_ifconfig(), do_ifconfig_ipv6(), do_ifconfig_setenv(), init_tun(), initialization_sequence_completed(), multi_select_virtual_addr(), netsh_delete_address_dns(), and undo_ifconfig_ipv6().

◆ netbits_ipv6

int tuntap::netbits_ipv6

Definition at line 213 of file tun.h.

Referenced by add_route_connected_v6_net(), delete_route_connected_v6_net(), do_address_service(), do_ifconfig_ipv6(), do_ifconfig_setenv(), init_tun(), and undo_ifconfig_ipv6().

◆ options

◆ persistent_if

bool tuntap::persistent_if

Definition at line 201 of file tun.h.

◆ reads

struct overlapped_io tuntap::reads

Definition at line 217 of file tun.h.

Referenced by close_tun_handle(), init_tun_post(), read_incoming_tun(), read_wintun(), and tun_read_queue().

◆ remote_ipv6

struct in6_addr tuntap::remote_ipv6

Definition at line 212 of file tun.h.

Referenced by do_ifconfig_ipv6(), do_ifconfig_setenv(), and init_tun().

◆ remote_netmask

in_addr_t tuntap::remote_netmask

Definition at line 209 of file tun.h.

Referenced by do_close_tun(), do_ifconfig_ipv4(), do_ifconfig_setenv(), do_open_tun(), init_tun(), multi_select_virtual_addr(), tuntap_dhcp_mask(), tuntap_set_ptp(), and undo_ifconfig_ipv4().

◆ rw_handle

struct rw_handle tuntap::rw_handle

Definition at line 219 of file tun.h.

Referenced by close_tun_handle(), init_tun_post(), service_register_ring_buffers(), tun_event_handle(), wintun_register_ring_buffer(), and write_wintun().

◆ rwflags_debug

unsigned int tuntap::rwflags_debug

Definition at line 247 of file tun.h.

Referenced by tun_set().

◆ standby_iter

int tuntap::standby_iter

Definition at line 232 of file tun.h.

◆ topology

int tuntap::topology

Definition at line 186 of file tun.h.

Referenced by do_ifconfig_ipv4(), init_tun(), tuntap_dhcp_mask(), and tuntap_set_ptp().

◆ type

int tuntap::type

Definition at line 183 of file tun.h.

Referenced by add_route_ipv6(), delete_route_ipv6(), do_address_service(), do_ifconfig_ipv4(), do_ifconfig_ipv6(), do_route_ipv6_service(), init_tun(), is_tun_type_set(), netsh_delete_address_dns(), open_tun(), route_ipv6_ipapi(), tuntap_dhcp_mask(), tuntap_get_version_info(), and tuntap_post_open().

◆ wintun_receive_ring

struct tun_ring* tuntap::wintun_receive_ring

Definition at line 237 of file tun.h.

Referenced by close_tun_handle(), wintun_register_ring_buffer(), and write_wintun().

◆ wintun_receive_ring_handle

HANDLE tuntap::wintun_receive_ring_handle

Definition at line 235 of file tun.h.

Referenced by close_tun_handle(), init_tun_post(), service_register_ring_buffers(), and wintun_register_ring_buffer().

◆ wintun_send_ring

struct tun_ring* tuntap::wintun_send_ring

Definition at line 236 of file tun.h.

Referenced by close_tun_handle(), read_wintun(), tuntap_ring_empty(), and wintun_register_ring_buffer().

◆ wintun_send_ring_handle

HANDLE tuntap::wintun_send_ring_handle

Definition at line 234 of file tun.h.

Referenced by close_tun_handle(), init_tun_post(), service_register_ring_buffers(), and wintun_register_ring_buffer().

◆ writes

struct overlapped_io tuntap::writes

Definition at line 218 of file tun.h.

Referenced by close_tun_handle(), init_tun_post(), tun_write_queue(), and tun_write_win32().

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

src/openvpn/tun.h