GI.NM.Objects.SettingInfiniband

Infiniband Settings

Exported types

newtype SettingInfiniband

Memory-managed wrapper type.

Constructors

SettingInfiniband (ManagedPtr SettingInfiniband)

Instances

Eq SettingInfiniband

Defined in GI.NM.Objects.SettingInfiniband

Methods

(==) :: SettingInfiniband -> SettingInfiniband -> Bool

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

GObject SettingInfiniband

Defined in GI.NM.Objects.SettingInfiniband

ManagedPtrNewtype SettingInfiniband

Defined in GI.NM.Objects.SettingInfiniband

Methods

toManagedPtr :: SettingInfiniband -> ManagedPtr SettingInfiniband

TypedObject SettingInfiniband

Defined in GI.NM.Objects.SettingInfiniband

Methods

glibType :: IO GType

HasParentTypes SettingInfiniband

Defined in GI.NM.Objects.SettingInfiniband

IsGValue (Maybe SettingInfiniband)

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

Defined in GI.NM.Objects.SettingInfiniband

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes SettingInfiniband

Defined in GI.NM.Objects.SettingInfiniband

type ParentTypes SettingInfiniband = '[Setting, Object]

class (GObject o, IsDescendantOf SettingInfiniband o) => IsSettingInfiniband o

Type class for types which can be safely cast to SettingInfiniband, for instance with toSettingInfiniband.

Instances

(GObject o, IsDescendantOf SettingInfiniband o) => IsSettingInfiniband o

Defined in GI.NM.Objects.SettingInfiniband

toSettingInfiniband :: (MonadIO m, IsSettingInfiniband o) => o -> m SettingInfiniband

Cast to SettingInfiniband, 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, getMacAddress, getMtu, getName, getPKey, getParent, getProperty, getQdata, getSecretFlags, getTransportMode, getVirtualInterfaceName.

Setters

setData, setDataFull, setProperty, setSecretFlags.

getMacAddress

settingInfinibandGetMacAddress

Arguments

:: (HasCallStack, MonadIO m, IsSettingInfiniband a)

=> a

setting: the SettingInfiniband

-> m Text

Returns: the SettingInfiniband:macAddress property of the setting

No description available in the introspection data.

getMtu

settingInfinibandGetMtu

Arguments

:: (HasCallStack, MonadIO m, IsSettingInfiniband a)

=> a

setting: the SettingInfiniband

-> m Word32

Returns: the SettingInfiniband:mtu property of the setting

No description available in the introspection data.

getPKey

settingInfinibandGetPKey

Arguments

:: (HasCallStack, MonadIO m, IsSettingInfiniband a)

=> a

setting: the SettingInfiniband

-> m Int32

Returns: the IPoIB P_Key

Returns the P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit unsigned integer.

getParent

settingInfinibandGetParent

Arguments

:: (HasCallStack, MonadIO m, IsSettingInfiniband a)

=> a

setting: the SettingInfiniband

-> m Text

Returns: the parent interface name

Returns the parent interface name for this device, if set.

getTransportMode

settingInfinibandGetTransportMode

Arguments

:: (HasCallStack, MonadIO m, IsSettingInfiniband a)

=> a

setting: the SettingInfiniband

-> m Text

Returns: the IPoIB transport mode

Returns the transport mode for this device. Either 'datagram' or 'connected'.

getVirtualInterfaceName

settingInfinibandGetVirtualInterfaceName

Arguments

:: (HasCallStack, MonadIO m, IsSettingInfiniband a)

=> a

setting: the SettingInfiniband

-> m Text

Returns: the interface name, or Nothing

Returns the interface name created by combining SettingInfiniband:parent and SettingInfiniband:pKey. (If either property is unset, this will return Nothing.)

new

settingInfinibandNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SettingInfiniband

Returns: the new empty SettingInfiniband object

Creates a new SettingInfiniband object with default values.

Properties

macAddress

If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).

clearSettingInfinibandMacAddress :: (MonadIO m, IsSettingInfiniband o) => o -> m ()

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

clear #macAddress

constructSettingInfinibandMacAddress :: (IsSettingInfiniband o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingInfinibandMacAddress :: (MonadIO m, IsSettingInfiniband o) => o -> m Text

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

get settingInfiniband #macAddress

setSettingInfinibandMacAddress :: (MonadIO m, IsSettingInfiniband o) => o -> Text -> m ()

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

set settingInfiniband [ #macAddress := value ]

mtu

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.

constructSettingInfinibandMtu :: (IsSettingInfiniband o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingInfinibandMtu :: (MonadIO m, IsSettingInfiniband o) => o -> m Word32

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

get settingInfiniband #mtu

setSettingInfinibandMtu :: (MonadIO m, IsSettingInfiniband o) => o -> Word32 -> m ()

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

set settingInfiniband [ #mtu := value ]

pKey

The InfiniBand p-key to use for this device. A value of -1 means to use the default p-key (aka "the p-key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit 0x8000 is set if it is a "full membership" p-key. The values 0 and 0x8000 are not allowed.

With the p-key set, the interface name is always "$parent.$p_key". Setting "connection.interface-name" to another name is not supported.

Note that kernel will internally always set the full membership bit, although the interface name does not reflect that. Usually the user would want to configure a full membership p-key with 0x8000 flag set.

constructSettingInfinibandPKey :: (IsSettingInfiniband o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getSettingInfinibandPKey :: (MonadIO m, IsSettingInfiniband o) => o -> m Int32

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

get settingInfiniband #pKey

setSettingInfinibandPKey :: (MonadIO m, IsSettingInfiniband o) => o -> Int32 -> m ()

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

set settingInfiniband [ #pKey := value ]

parent

The interface name of the parent device of this device. Normally Nothing, but if the SettingInfiniband:p_key property is set, then you must specify the base device by setting either this property or SettingInfiniband:macAddress.

clearSettingInfinibandParent :: (MonadIO m, IsSettingInfiniband o) => o -> m ()

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

clear #parent

constructSettingInfinibandParent :: (IsSettingInfiniband o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingInfinibandParent :: (MonadIO m, IsSettingInfiniband o) => o -> m Text

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

get settingInfiniband #parent

setSettingInfinibandParent :: (MonadIO m, IsSettingInfiniband o) => o -> Text -> m ()

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

set settingInfiniband [ #parent := value ]

transportMode

The IP-over-InfiniBand transport mode. Either "datagram" or "connected".

clearSettingInfinibandTransportMode :: (MonadIO m, IsSettingInfiniband o) => o -> m ()

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

clear #transportMode

constructSettingInfinibandTransportMode :: (IsSettingInfiniband o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingInfinibandTransportMode :: (MonadIO m, IsSettingInfiniband o) => o -> m Text

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

get settingInfiniband #transportMode

setSettingInfinibandTransportMode :: (MonadIO m, IsSettingInfiniband o) => o -> Text -> m ()

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

set settingInfiniband [ #transportMode := value ]