GI.NM.Objects.SettingTun

Tunnel Settings

Exported types

newtype SettingTun

Memory-managed wrapper type.

Constructors

SettingTun (ManagedPtr SettingTun)

Instances

Eq SettingTun

Defined in GI.NM.Objects.SettingTun

Methods

(==) :: SettingTun -> SettingTun -> Bool

(/=) :: SettingTun -> SettingTun -> Bool

GObject SettingTun

Defined in GI.NM.Objects.SettingTun

ManagedPtrNewtype SettingTun

Defined in GI.NM.Objects.SettingTun

Methods

toManagedPtr :: SettingTun -> ManagedPtr SettingTun

TypedObject SettingTun

Defined in GI.NM.Objects.SettingTun

Methods

glibType :: IO GType

HasParentTypes SettingTun

Defined in GI.NM.Objects.SettingTun

IsGValue (Maybe SettingTun)

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

Defined in GI.NM.Objects.SettingTun

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe SettingTun -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe SettingTun)

type ParentTypes SettingTun

Defined in GI.NM.Objects.SettingTun

type ParentTypes SettingTun = '[Setting, Object]

class (GObject o, IsDescendantOf SettingTun o) => IsSettingTun o

Type class for types which can be safely cast to SettingTun, for instance with toSettingTun.

Instances

(GObject o, IsDescendantOf SettingTun o) => IsSettingTun o

Defined in GI.NM.Objects.SettingTun

toSettingTun :: (MonadIO m, IsSettingTun o) => o -> m SettingTun

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

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, compare, diff, duplicate, enumerateValues, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, optionClearByName, optionGet, optionGetAllNames, optionGetBoolean, optionGetUint32, optionSet, optionSetBoolean, optionSetUint32, ref, refSink, runDispose, stealData, stealQdata, thawNotify, toString, unref, verify, verifySecrets, watchClosure.

Getters

getData, getDbusPropertyType, getGroup, getMode, getMultiQueue, getName, getOwner, getPi, getProperty, getQdata, getSecretFlags, getVnetHdr.

Setters

setData, setDataFull, setProperty, setSecretFlags.

getGroup

settingTunGetGroup

Arguments

:: (HasCallStack, MonadIO m, IsSettingTun a)

=> a

setting: the SettingTun

-> m Text

Returns: the SettingTun:group property of the setting

No description available in the introspection data.

Since: 1.2

getMode

settingTunGetMode

Arguments

:: (HasCallStack, MonadIO m, IsSettingTun a)

=> a

setting: the SettingTun

-> m SettingTunMode

Returns: the SettingTun:mode property of the setting

No description available in the introspection data.

Since: 1.2

getMultiQueue

settingTunGetMultiQueue

Arguments

:: (HasCallStack, MonadIO m, IsSettingTun a)

=> a

setting: the SettingTun

-> m Bool

Returns: the SettingTun:multiQueue property of the setting

No description available in the introspection data.

Since: 1.2

getOwner

settingTunGetOwner

Arguments

:: (HasCallStack, MonadIO m, IsSettingTun a)

=> a

setting: the SettingTun

-> m Text

Returns: the SettingTun:owner property of the setting

No description available in the introspection data.

Since: 1.2

getPi

settingTunGetPi

Arguments

:: (HasCallStack, MonadIO m, IsSettingTun a)

=> a

setting: the SettingTun

-> m Bool

Returns: the SettingTun:pi property of the setting

No description available in the introspection data.

Since: 1.2

getVnetHdr

settingTunGetVnetHdr

Arguments

:: (HasCallStack, MonadIO m, IsSettingTun a)

=> a

setting: the SettingTun

-> m Bool

Returns: the SettingTun:vnet_hdr property of the setting

No description available in the introspection data.

Since: 1.2

new

settingTunNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SettingTun

Returns: the new empty SettingTun object

Creates a new SettingTun object with default values.

Since: 1.2

Properties

group

The group ID which will own the device. If set to Nothing everyone will be able to use the device.

Since: 1.2

clearSettingTunGroup :: (MonadIO m, IsSettingTun o) => o -> m ()

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

clear #group

constructSettingTunGroup :: (IsSettingTun o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “group” property. This is rarely needed directly, but it is used by new.

getSettingTunGroup :: (MonadIO m, IsSettingTun o) => o -> m Text

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

get settingTun #group

setSettingTunGroup :: (MonadIO m, IsSettingTun o) => o -> Text -> m ()

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

set settingTun [ #group := value ]

mode

The operating mode of the virtual device. Allowed values are SettingTunModeTun to create a layer 3 device and SettingTunModeTap to create an Ethernet-like layer 2 one.

Since: 1.2

constructSettingTunMode :: (IsSettingTun o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “mode” property. This is rarely needed directly, but it is used by new.

getSettingTunMode :: (MonadIO m, IsSettingTun o) => o -> m Word32

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

get settingTun #mode

setSettingTunMode :: (MonadIO m, IsSettingTun o) => o -> Word32 -> m ()

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

set settingTun [ #mode := value ]

multiQueue

If the property is set to True, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.

Since: 1.2

constructSettingTunMultiQueue :: (IsSettingTun o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “multi-queue” property. This is rarely needed directly, but it is used by new.

getSettingTunMultiQueue :: (MonadIO m, IsSettingTun o) => o -> m Bool

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

get settingTun #multiQueue

setSettingTunMultiQueue :: (MonadIO m, IsSettingTun o) => o -> Bool -> m ()

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

set settingTun [ #multiQueue := value ]

owner

The user ID which will own the device. If set to Nothing everyone will be able to use the device.

Since: 1.2

clearSettingTunOwner :: (MonadIO m, IsSettingTun o) => o -> m ()

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

clear #owner

constructSettingTunOwner :: (IsSettingTun o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “owner” property. This is rarely needed directly, but it is used by new.

getSettingTunOwner :: (MonadIO m, IsSettingTun o) => o -> m Text

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

get settingTun #owner

setSettingTunOwner :: (MonadIO m, IsSettingTun o) => o -> Text -> m ()

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

set settingTun [ #owner := value ]

pi

If True the interface will prepend a 4 byte header describing the physical interface to the packets.

Since: 1.2

constructSettingTunPi :: (IsSettingTun o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “pi” property. This is rarely needed directly, but it is used by new.

getSettingTunPi :: (MonadIO m, IsSettingTun o) => o -> m Bool

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

get settingTun #pi

setSettingTunPi :: (MonadIO m, IsSettingTun o) => o -> Bool -> m ()

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

set settingTun [ #pi := value ]

vnetHdr

If True the IFF_VNET_HDR the tunnel packets will include a virtio network header.

Since: 1.2

constructSettingTunVnetHdr :: (IsSettingTun o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “vnet-hdr” property. This is rarely needed directly, but it is used by new.

getSettingTunVnetHdr :: (MonadIO m, IsSettingTun o) => o -> m Bool

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

get settingTun #vnetHdr

setSettingTunVnetHdr :: (MonadIO m, IsSettingTun o) => o -> Bool -> m ()

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

set settingTun [ #vnetHdr := value ]