OpenVPN
Data Fields
openvpn_plugin_args_open_return Struct Reference

Arguments used to transport variables from the plug-in back to the OpenVPN process. More...

#include <openvpn-plugin.h>

Collaboration diagram for openvpn_plugin_args_open_return:
Collaboration graph
[legend]

Data Fields

int type_mask
 
openvpn_plugin_handle_t handle
 
struct openvpn_plugin_string_list ** return_list
 

Detailed Description

Arguments used to transport variables from the plug-in back to the OpenVPN process.

The struct openvpn_plugin_args_open_return is only used by the openvpn_plugin_open_v3() function.

STRUCT MEMBERS

type_mask : The plug-in should set this value to the logical OR of all script types which the plug-in wants to intercept. For example, if the script wants to intercept the client-connect and client-disconnect script types:

type_mask = OPENVPN_PLUGIN_MASK(OPENVPN_PLUGIN_CLIENT_CONNECT) | OPENVPN_PLUGIN_MASK(OPENVPN_PLUGIN_CLIENT_DISCONNECT)

handle : Pointer to a global plug-in context, created by the plug-in. This pointer is passed on to the other plug-in calls.

return_list : used to return data back to OpenVPN.

Definition at line 394 of file openvpn-plugin.h.

Field Documentation

◆ handle

openvpn_plugin_handle_t openvpn_plugin_args_open_return::handle

Definition at line 397 of file openvpn-plugin.h.

Referenced by openvpn_plugin_open_v3(), and plugin_open_item().

◆ return_list

struct openvpn_plugin_string_list** openvpn_plugin_args_open_return::return_list

Definition at line 398 of file openvpn-plugin.h.

Referenced by plugin_open_item().

◆ type_mask

int openvpn_plugin_args_open_return::type_mask

Definition at line 396 of file openvpn-plugin.h.

Referenced by openvpn_plugin_open_v3(), and plugin_open_item().


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