NMDeviceIPTunnel

NMDeviceIPTunnel

Synopsis

#define             NM_DEVICE_IP_TUNNEL_MODE
#define             NM_DEVICE_IP_TUNNEL_PARENT
#define             NM_DEVICE_IP_TUNNEL_LOCAL
#define             NM_DEVICE_IP_TUNNEL_REMOTE
#define             NM_DEVICE_IP_TUNNEL_TTL
#define             NM_DEVICE_IP_TUNNEL_TOS
#define             NM_DEVICE_IP_TUNNEL_PATH_MTU_DISCOVERY
#define             NM_DEVICE_IP_TUNNEL_INPUT_KEY
#define             NM_DEVICE_IP_TUNNEL_OUTPUT_KEY
#define             NM_DEVICE_IP_TUNNEL_ENCAPSULATION_LIMIT
#define             NM_DEVICE_IP_TUNNEL_FLOW_LABEL
                    NMDeviceIPTunnel;
                    NMDeviceIPTunnelClass;
NMDevice *          nm_device_ip_tunnel_get_parent      (NMDeviceIPTunnel *device);
NMIPTunnelMode      nm_device_ip_tunnel_get_mode        (NMDeviceIPTunnel *device);
const char *        nm_device_ip_tunnel_get_local       (NMDeviceIPTunnel *device);
const char *        nm_device_ip_tunnel_get_remote      (NMDeviceIPTunnel *device);
guint8              nm_device_ip_tunnel_get_ttl         (NMDeviceIPTunnel *device);
guint8              nm_device_ip_tunnel_get_tos         (NMDeviceIPTunnel *device);
gboolean            nm_device_ip_tunnel_get_path_mtu_discovery
                                                        (NMDeviceIPTunnel *device);
const char *        nm_device_ip_tunnel_get_input_key   (NMDeviceIPTunnel *device);
const char *        nm_device_ip_tunnel_get_output_key  (NMDeviceIPTunnel *device);
guint8              nm_device_ip_tunnel_get_encapsulation_limit
                                                        (NMDeviceIPTunnel *device);
guint               nm_device_ip_tunnel_get_flow_label  (NMDeviceIPTunnel *device);

Object Hierarchy

  GObject
   +----NMObject
         +----NMDevice
               +----NMDeviceIPTunnel

Implemented Interfaces

NMDeviceIPTunnel implements GInitable and GAsyncInitable.

Properties

  "encapsulation-limit"      guchar                : Read
  "flow-label"               guint                 : Read
  "input-key"                gchar*                : Read
  "local"                    gchar*                : Read
  "mode"                     guint                 : Read
  "output-key"               gchar*                : Read
  "parent"                   NMDevice*             : Read
  "path-mtu-discovery"       gboolean              : Read
  "remote"                   gchar*                : Read
  "tos"                      guchar                : Read
  "ttl"                      guchar                : Read

Description

Details

NM_DEVICE_IP_TUNNEL_MODE

#define NM_DEVICE_IP_TUNNEL_MODE                "mode"


NM_DEVICE_IP_TUNNEL_PARENT

#define NM_DEVICE_IP_TUNNEL_PARENT              "parent"


NM_DEVICE_IP_TUNNEL_LOCAL

#define NM_DEVICE_IP_TUNNEL_LOCAL               "local"


NM_DEVICE_IP_TUNNEL_REMOTE

#define NM_DEVICE_IP_TUNNEL_REMOTE              "remote"


NM_DEVICE_IP_TUNNEL_TTL

#define NM_DEVICE_IP_TUNNEL_TTL                 "ttl"


NM_DEVICE_IP_TUNNEL_TOS

#define NM_DEVICE_IP_TUNNEL_TOS                 "tos"


NM_DEVICE_IP_TUNNEL_PATH_MTU_DISCOVERY

#define NM_DEVICE_IP_TUNNEL_PATH_MTU_DISCOVERY  "path-mtu-discovery"


NM_DEVICE_IP_TUNNEL_INPUT_KEY

#define NM_DEVICE_IP_TUNNEL_INPUT_KEY           "input-key"


NM_DEVICE_IP_TUNNEL_OUTPUT_KEY

#define NM_DEVICE_IP_TUNNEL_OUTPUT_KEY          "output-key"


NM_DEVICE_IP_TUNNEL_ENCAPSULATION_LIMIT

#define NM_DEVICE_IP_TUNNEL_ENCAPSULATION_LIMIT "encapsulation-limit"


NM_DEVICE_IP_TUNNEL_FLOW_LABEL

#define NM_DEVICE_IP_TUNNEL_FLOW_LABEL          "flow-label"


NMDeviceIPTunnel

typedef struct _NMDeviceIPTunnel NMDeviceIPTunnel;

NMDeviceIPTunnelClass

typedef struct {
	NMDeviceClass parent;
} NMDeviceIPTunnelClass;


nm_device_ip_tunnel_get_parent ()

NMDevice *          nm_device_ip_tunnel_get_parent      (NMDeviceIPTunnel *device);

device :

a NMDeviceIPTunnel

Returns :

the device's parent device. [transfer none]

Since 1.2


nm_device_ip_tunnel_get_mode ()

NMIPTunnelMode      nm_device_ip_tunnel_get_mode        (NMDeviceIPTunnel *device);

device :

a NMDeviceIPTunnel

Returns :

the tunneling mode

Since 1.2


nm_device_ip_tunnel_get_local ()

const char *        nm_device_ip_tunnel_get_local       (NMDeviceIPTunnel *device);

device :

a NMDeviceIPTunnel

Returns :

the local endpoint of the tunnel

Since 1.2


nm_device_ip_tunnel_get_remote ()

const char *        nm_device_ip_tunnel_get_remote      (NMDeviceIPTunnel *device);

device :

a NMDeviceIPTunnel

Returns :

the remote endpoint of the tunnel

Since 1.2


nm_device_ip_tunnel_get_ttl ()

guint8              nm_device_ip_tunnel_get_ttl         (NMDeviceIPTunnel *device);

device :

a NMDeviceIPTunnel

Returns :

the TTL assigned to tunneled packets

Since 1.2


nm_device_ip_tunnel_get_tos ()

guint8              nm_device_ip_tunnel_get_tos         (NMDeviceIPTunnel *device);

device :

a NMDeviceIPTunnel

Returns :

type of service (IPv4) or traffic class (IPv6) assigned to tunneled packets.

Since 1.2


nm_device_ip_tunnel_get_path_mtu_discovery ()

gboolean            nm_device_ip_tunnel_get_path_mtu_discovery
                                                        (NMDeviceIPTunnel *device);

device :

a NMDeviceIPTunnel

Returns :

whether path MTU discovery is enabled

Since 1.2


nm_device_ip_tunnel_get_input_key ()

const char *        nm_device_ip_tunnel_get_input_key   (NMDeviceIPTunnel *device);

device :

a NMDeviceIPTunnel

Returns :

the key used for incoming packets

Since 1.2


nm_device_ip_tunnel_get_output_key ()

const char *        nm_device_ip_tunnel_get_output_key  (NMDeviceIPTunnel *device);

device :

a NMDeviceIPTunnel

Returns :

the key used for outgoing packets

Since 1.2


nm_device_ip_tunnel_get_encapsulation_limit ()

guint8              nm_device_ip_tunnel_get_encapsulation_limit
                                                        (NMDeviceIPTunnel *device);

device :

a NMDeviceIPTunnel

Returns :

the maximum permitted encapsulation level

Since 1.2


nm_device_ip_tunnel_get_flow_label ()

guint               nm_device_ip_tunnel_get_flow_label  (NMDeviceIPTunnel *device);

device :

a NMDeviceIPTunnel

Returns :

the flow label assigned to tunnel packets

Since 1.2

Property Details

The "encapsulation-limit" property

  "encapsulation-limit"      guchar                : Read

How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.

Default value: 0

Since 1.2


The "flow-label" property

  "flow-label"               guint                 : Read

The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.

Allowed values: <= 1048575

Default value: 0

Since 1.2


The "input-key" property

  "input-key"                gchar*                : Read

The key used for tunneled input packets, if applicable.

Default value: NULL

Since 1.2


The "local" property

  "local"                    gchar*                : Read

The local endpoint of the tunnel.

Default value: NULL

Since 1.2


The "mode" property

  "mode"                     guint                 : Read

The tunneling mode of the device.

Default value: 0

Since 1.2


The "output-key" property

  "output-key"               gchar*                : Read

The key used for tunneled output packets, if applicable.

Default value: NULL

Since 1.2


The "parent" property

  "parent"                   NMDevice*             : Read

The devices's parent device.

Since 1.2


The "path-mtu-discovery" property

  "path-mtu-discovery"       gboolean              : Read

Whether path MTU discovery is enabled on this tunnel.

Default value: FALSE

Since 1.2


The "remote" property

  "remote"                   gchar*                : Read

The remote endpoint of the tunnel.

Default value: NULL

Since 1.2


The "tos" property

  "tos"                      guchar                : Read

The type of service (IPv4) or traffic class (IPv6) assigned to tunneled packets.

Default value: 0

Since 1.2


The "ttl" property

  "ttl"                      guchar                : Read

The TTL assigned to tunneled packets. 0 is a special value meaning that packets inherit the TTL value

Default value: 0

Since 1.2