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.Structs.TeamLinkWatcher

Description

No description available in the introspection data.

Synopsis

Exported types

Methods

Click to display all available methods, including inherited ones

Expand

Methods

dup, equal, ref, unref.

Getters

getDelayDown, getDelayUp, getFlags, getInitWait, getInterval, getMissedMax, getName, getSourceHost, getTargetHost, getVlanid.

Setters

None.

dup

teamLinkWatcherDup Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TeamLinkWatcher

watcher: the TeamLinkWatcher

-> m TeamLinkWatcher

Returns: a copy of watcher

Creates a copy of watcher

Since: 1.12

equal

teamLinkWatcherEqual Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TeamLinkWatcher

watcher: the TeamLinkWatcher

-> TeamLinkWatcher

other: the TeamLinkWatcher to compare watcher to.

-> m Bool

Returns: True if the objects contain the same values, False if they do not.

Determines if two TeamLinkWatcher objects contain the same values in all the properties.

Since: 1.12

getDelayDown

teamLinkWatcherGetDelayDown Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TeamLinkWatcher

watcher: the TeamLinkWatcher

-> m Int32 

Gets the delay_down interval (in milliseconds) that elapses between the link going down and the runner being notified about it.

Since: 1.12

getDelayUp

teamLinkWatcherGetDelayUp Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TeamLinkWatcher

watcher: the TeamLinkWatcher

-> m Int32 

Gets the delay_up interval (in milliseconds) that elapses between the link coming up and the runner being notified about it.

Since: 1.12

getFlags

teamLinkWatcherGetFlags Source #

Gets the arp ping watcher flags.

Since: 1.12

getInitWait

teamLinkWatcherGetInitWait Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TeamLinkWatcher

watcher: the TeamLinkWatcher

-> m Int32 

Gets the init_wait interval (in milliseconds) that the team port should wait before sending the first packet to the target host.

Since: 1.12

getInterval

teamLinkWatcherGetInterval Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TeamLinkWatcher

watcher: the TeamLinkWatcher

-> m Int32 

Gets the interval (in milliseconds) that the team port should wait between sending two check packets to the target host.

Since: 1.12

getMissedMax

teamLinkWatcherGetMissedMax Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TeamLinkWatcher

watcher: the TeamLinkWatcher

-> m Int32 

Gets the number of missed replies after which the link is considered down.

Since: 1.12

getName

teamLinkWatcherGetName Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TeamLinkWatcher

watcher: the TeamLinkWatcher

-> m Text 

Gets the name of the link watcher to be used.

Since: 1.12

getSourceHost

teamLinkWatcherGetSourceHost Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TeamLinkWatcher

watcher: the TeamLinkWatcher

-> m Text 

Gets the ip address to be used as source for the link probing packets.

Since: 1.12

getTargetHost

teamLinkWatcherGetTargetHost Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TeamLinkWatcher

watcher: the TeamLinkWatcher

-> m Text 

Gets the host name/ip address to be used as destination for the link probing packets.

Since: 1.12

getVlanid

teamLinkWatcherGetVlanid Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TeamLinkWatcher

watcher: the TeamLinkWatcher

-> m Int32 

Gets the VLAN tag ID to be used to outgoing link probes

Since: 1.16

newArpPing

teamLinkWatcherNewArpPing Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Int32

initWait: init_wait value

-> Int32

interval: interval value

-> Int32

missedMax: missed_max value

-> Text

targetHost: the host name or the ip address that will be used as destination address in the arp request

-> Text

sourceHost: the host name or the ip address that will be used as source address in the arp request

-> [TeamLinkWatcherArpPingFlags]

flags: the watcher TeamLinkWatcherArpPingFlags

-> m TeamLinkWatcher

Returns: the new TeamLinkWatcher object, or Nothing on error (Can throw GError)

Creates a new arp_ping TeamLinkWatcher object

Since: 1.12

newArpPing2

teamLinkWatcherNewArpPing2 Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Int32

initWait: init_wait value

-> Int32

interval: interval value

-> Int32

missedMax: missed_max value

-> Int32

vlanid: vlanid value

-> Text

targetHost: the host name or the ip address that will be used as destination address in the arp request

-> Text

sourceHost: the host name or the ip address that will be used as source address in the arp request

-> [TeamLinkWatcherArpPingFlags]

flags: the watcher TeamLinkWatcherArpPingFlags

-> m TeamLinkWatcher

Returns: the new TeamLinkWatcher object, or Nothing on error (Can throw GError)

Creates a new arp_ping TeamLinkWatcher object

Since: 1.16

newEthtool

teamLinkWatcherNewEthtool Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Int32

delayUp: delay_up value

-> Int32

delayDown: delay_down value

-> m TeamLinkWatcher

Returns: the new TeamLinkWatcher object (Can throw GError)

Creates a new ethtool TeamLinkWatcher object

Since: 1.12

newNsnaPing

teamLinkWatcherNewNsnaPing Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Int32

initWait: init_wait value

-> Int32

interval: interval value

-> Int32

missedMax: missed_max value

-> Text

targetHost: the host name or the ipv6 address that will be used as target address in the NS packet

-> m TeamLinkWatcher

Returns: the new TeamLinkWatcher object, or Nothing on error (Can throw GError)

Creates a new nsna_ping TeamLinkWatcher object

Since: 1.12

ref

teamLinkWatcherRef Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TeamLinkWatcher

watcher: the TeamLinkWatcher

-> m () 

Increases the reference count of the object.

Since 1.20, ref-counting of TeamLinkWatcher is thread-safe.

Since: 1.12

unref

teamLinkWatcherUnref Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TeamLinkWatcher

watcher: the TeamLinkWatcher

-> m () 

Decreases the reference count of the object. If the reference count reaches zero, the object will be destroyed.

Since 1.20, ref-counting of TeamLinkWatcher is thread-safe.

Since: 1.12