gi-nm-1.0.1: NM bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.NM.Objects.DeviceTun

Description

No description available in the introspection data.

Since: 1.2

Synopsis

Exported types

newtype DeviceTun Source #

Memory-managed wrapper type.

Instances

Instances details
Eq DeviceTun Source # 
Instance details

Defined in GI.NM.Objects.DeviceTun

GObject DeviceTun Source # 
Instance details

Defined in GI.NM.Objects.DeviceTun

ManagedPtrNewtype DeviceTun Source # 
Instance details

Defined in GI.NM.Objects.DeviceTun

TypedObject DeviceTun Source # 
Instance details

Defined in GI.NM.Objects.DeviceTun

Methods

glibType :: IO GType #

HasParentTypes DeviceTun Source # 
Instance details

Defined in GI.NM.Objects.DeviceTun

IsGValue (Maybe DeviceTun) Source #

Convert DeviceTun to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.NM.Objects.DeviceTun

type ParentTypes DeviceTun Source # 
Instance details

Defined in GI.NM.Objects.DeviceTun

class (GObject o, IsDescendantOf DeviceTun o) => IsDeviceTun o Source #

Type class for types which can be safely cast to DeviceTun, for instance with toDeviceTun.

Instances

Instances details
(GObject o, IsDescendantOf DeviceTun o) => IsDeviceTun o Source # 
Instance details

Defined in GI.NM.Objects.DeviceTun

toDeviceTun :: (MonadIO m, IsDeviceTun o) => o -> m DeviceTun Source #

Cast to DeviceTun, for types for which this is known to be safe. For general casts, use castTo.

Methods

getGroup

deviceTunGetGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceTun a) 
=> a

device: a DeviceTun

-> m Int64

Returns: the gid of the tunnel group, or -1 if it has no owner.

Gets the tunnel group.

Since: 1.2

getMode

deviceTunGetMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceTun a) 
=> a

device: a DeviceTun

-> m Text

Returns: 'tun' or 'tap'

Returns the TUN/TAP mode for the device.

Since: 1.2

getMultiQueue

deviceTunGetMultiQueue Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceTun a) 
=> a

device: a DeviceTun

-> m Bool

Returns: True if the device doesn't have the flag, False otherwise

Returns whether the DeviceTun has the IFF_MULTI_QUEUE flag.

Since: 1.2

getNoPi

deviceTunGetNoPi Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceTun a) 
=> a

device: a DeviceTun

-> m Bool

Returns: True if the device has the flag, False otherwise

Returns whether the DeviceTun has the IFF_NO_PI flag.

Since: 1.2

getOwner

deviceTunGetOwner Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceTun a) 
=> a

device: a DeviceTun

-> m Int64

Returns: the uid of the tunnel owner, or -1 if it has no owner.

Gets the tunnel owner.

Since: 1.2

getVnetHdr

deviceTunGetVnetHdr Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceTun a) 
=> a

device: a DeviceTun

-> m Bool

Returns: True if the device has the flag, False otherwise

Returns whether the DeviceTun has the IFF_VNET_HDR flag.

Since: 1.2

Properties

group

The gid of the tunnel group, or -1 if it has no owner.

Since: 1.2

getDeviceTunGroup :: (MonadIO m, IsDeviceTun o) => o -> m Int64 Source #

Get the value of the “group” property. When overloading is enabled, this is equivalent to

get deviceTun #group

mode

The tunnel mode, either "tun" or "tap".

Since: 1.2

getDeviceTunMode :: (MonadIO m, IsDeviceTun o) => o -> m Text Source #

Get the value of the “mode” property. When overloading is enabled, this is equivalent to

get deviceTun #mode

multiQueue

The tunnel's "TUN_TAP_MQ" flag; true if callers can connect to the tap device multiple times, for multiple send/receive queues.

Since: 1.2

getDeviceTunMultiQueue :: (MonadIO m, IsDeviceTun o) => o -> m Bool Source #

Get the value of the “multi-queue” property. When overloading is enabled, this is equivalent to

get deviceTun #multiQueue

noPi

The tunnel's "TUN_NO_PI" flag; true if no protocol info is prepended to the tunnel packets.

Since: 1.2

getDeviceTunNoPi :: (MonadIO m, IsDeviceTun o) => o -> m Bool Source #

Get the value of the “no-pi” property. When overloading is enabled, this is equivalent to

get deviceTun #noPi

owner

The uid of the tunnel owner, or -1 if it has no owner.

Since: 1.2

getDeviceTunOwner :: (MonadIO m, IsDeviceTun o) => o -> m Int64 Source #

Get the value of the “owner” property. When overloading is enabled, this is equivalent to

get deviceTun #owner

vnetHdr

The tunnel's "TUN_VNET_HDR" flag; true if the tunnel packets include a virtio network header.

Since: 1.2

getDeviceTunVnetHdr :: (MonadIO m, IsDeviceTun o) => o -> m Bool Source #

Get the value of the “vnet-hdr” property. When overloading is enabled, this is equivalent to

get deviceTun #vnetHdr