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.DeviceMacsec

Description

No description available in the introspection data.

Since: 1.6

Synopsis

Exported types

class (GObject o, IsDescendantOf DeviceMacsec o) => IsDeviceMacsec o Source #

Type class for types which can be safely cast to DeviceMacsec, for instance with toDeviceMacsec.

Instances

Instances details
(GObject o, IsDescendantOf DeviceMacsec o) => IsDeviceMacsec o Source # 
Instance details

Defined in GI.NM.Objects.DeviceMacsec

toDeviceMacsec :: (MonadIO m, IsDeviceMacsec o) => o -> m DeviceMacsec Source #

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

Methods

getCipherSuite

deviceMacsecGetCipherSuite Source #

Arguments

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

device: a DeviceMacsec

-> m Word64

Returns: the set of cryptographic algorithms in use

Gets the set of cryptographic algorithms in use

Since: 1.6

getEncodingSa

deviceMacsecGetEncodingSa Source #

Arguments

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

device: a DeviceMacsec

-> m Word8

Returns: the current Security Association

Gets the value of the Association Number (0..3) for the Security Association in use.

Since: 1.6

getEncrypt

deviceMacsecGetEncrypt Source #

Arguments

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

device: a DeviceMacsec

-> m Bool

Returns: whether encryption is enabled

Gets whether encryption of transmitted frames is enabled

Since: 1.6

getEs

deviceMacsecGetEs Source #

Arguments

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

device: a DeviceMacsec

-> m Bool

Returns: whether the ES (End station) bit is enabled

Gets whether the ES (End station) bit is enabled in SecTAG for transmitted frames

Since: 1.6

getIcvLength

deviceMacsecGetIcvLength Source #

Arguments

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

device: a DeviceMacsec

-> m Word8

Returns: the length of ICV

Gets the length of ICV (Integrity Check Value)

Since: 1.6

getIncludeSci

deviceMacsecGetIncludeSci Source #

Arguments

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

device: a DeviceMacsec

-> m Bool

Returns: whether the SCI is always included

Gets whether the SCI is always included in SecTAG for transmitted frames

Since: 1.6

getParent

deviceMacsecGetParent Source #

Arguments

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

device: a DeviceMacsec

-> m Device

Returns: the device's parent device

No description available in the introspection data.

Since: 1.42

getProtect

deviceMacsecGetProtect Source #

Arguments

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

device: a DeviceMacsec

-> m Bool

Returns: whether protection is enabled

Gets whether protection of transmitted frames is enabled

Since: 1.6

getReplayProtect

deviceMacsecGetReplayProtect Source #

Arguments

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

device: a DeviceMacsec

-> m Bool

Returns: whether replay protection is enabled

Gets whether replay protection is enabled

Since: 1.6

getScb

deviceMacsecGetScb Source #

Arguments

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

device: a DeviceMacsec

-> m Bool

Returns: whether the SCB (Single Copy Broadcast) bit is enabled

Gets whether the SCB (Single Copy Broadcast) bit is enabled in SecTAG for transmitted frames

Since: 1.6

getSci

deviceMacsecGetSci Source #

Arguments

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

device: a DeviceMacsec

-> m Word64

Returns: the SCI

Gets the Secure Channel Identifier in use

Since: 1.6

getValidation

deviceMacsecGetValidation Source #

Arguments

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

device: a DeviceMacsec

-> m Text

Returns: the validation mode

Gets the validation mode for incoming packets (strict, check, disabled)

Since: 1.6

getWindow

deviceMacsecGetWindow Source #

Arguments

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

device: a DeviceMacsec

-> m Word32

Returns: size of the replay window

Gets the size of the replay window

Since: 1.6

Properties

cipherSuite

The set of cryptographic algorithms in use.

Since: 1.6

getDeviceMacsecCipherSuite :: (MonadIO m, IsDeviceMacsec o) => o -> m Word64 Source #

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

get deviceMacsec #cipherSuite

encodingSa

encrypt

Whether encryption of transmitted frames is enabled.

Since: 1.6

getDeviceMacsecEncrypt :: (MonadIO m, IsDeviceMacsec o) => o -> m Bool Source #

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

get deviceMacsec #encrypt

es

Whether the ES (End station) bit is enabled in SecTAG for transmitted frames.

Since: 1.6

getDeviceMacsecEs :: (MonadIO m, IsDeviceMacsec o) => o -> m Bool Source #

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

get deviceMacsec #es

icvLength

includeSci

Whether the SCI is always included in SecTAG for transmitted frames.

Since: 1.6

getDeviceMacsecIncludeSci :: (MonadIO m, IsDeviceMacsec o) => o -> m Bool Source #

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

get deviceMacsec #includeSci

parent

The devices's parent device.

Since: 1.6

getDeviceMacsecParent :: (MonadIO m, IsDeviceMacsec o) => o -> m Device Source #

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

get deviceMacsec #parent

protect

Whether protection of transmitted frames is enabled.

Since: 1.6

getDeviceMacsecProtect :: (MonadIO m, IsDeviceMacsec o) => o -> m Bool Source #

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

get deviceMacsec #protect

replayProtect

Whether replay protection is enabled.

Since: 1.6

getDeviceMacsecReplayProtect :: (MonadIO m, IsDeviceMacsec o) => o -> m Bool Source #

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

get deviceMacsec #replayProtect

scb

Whether the SCB (Single Copy Broadcast) bit is enabled in SecTAG for transmitted frames.

Since: 1.6

getDeviceMacsecScb :: (MonadIO m, IsDeviceMacsec o) => o -> m Bool Source #

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

get deviceMacsec #scb

sci

The Secure Channel Identifier in use.

Since: 1.6

getDeviceMacsecSci :: (MonadIO m, IsDeviceMacsec o) => o -> m Word64 Source #

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

get deviceMacsec #sci

validation

The validation mode for incoming packets (strict, check, disabled).

Since: 1.6

getDeviceMacsecValidation :: (MonadIO m, IsDeviceMacsec o) => o -> m Text Source #

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

get deviceMacsec #validation

window

The size of the replay window.

Since: 1.6

getDeviceMacsecWindow :: (MonadIO m, IsDeviceMacsec o) => o -> m Word32 Source #

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

get deviceMacsec #window