Class TeamLinkWatcher

Hierarchy

TeamLinkWatcher

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new TeamLinkWatcher(): TeamLinkWatcher

Returns TeamLinkWatcher

Properties

Static name

name: string

Methods

dup

dup(): TeamLinkWatcher

- Defined in NM-1.0.d.ts:33119
Creates a copy of watcher

Returns TeamLinkWatcher

equal

equal(other: TeamLinkWatcher): boolean

- Defined in NM-1.0.d.ts:33125
Determines if two #NMTeamLinkWatcher objects contain the same values in all the properties.

Parameters
- other: TeamLinkWatcher
  
  the #NMTeamLinkWatcher to compare watcher to.
Returns boolean

getDelayDown

getDelayDown(): number

- Defined in NM-1.0.d.ts:33130
Gets the delay_down interval (in milliseconds) that elapses between the link going down and the runner being notified about it.

Returns number

getDelayUp

getDelayUp(): number

- Defined in NM-1.0.d.ts:33135
Gets the delay_up interval (in milliseconds) that elapses between the link coming up and the runner being notified about it.

Returns number

getFlags

getFlags(): TeamLinkWatcherArpPingFlags

- Defined in NM-1.0.d.ts:33139
Gets the arp ping watcher flags.

Returns TeamLinkWatcherArpPingFlags

getInitWait

getInitWait(): number

- Defined in NM-1.0.d.ts:33144
Gets the init_wait interval (in milliseconds) that the team slave should wait before sending the first packet to the target host.

Returns number

getInterval

getInterval(): number

- Defined in NM-1.0.d.ts:33149
Gets the interval (in milliseconds) that the team slave should wait between sending two check packets to the target host.

Returns number

getMissedMax

getMissedMax(): number

- Defined in NM-1.0.d.ts:33153
Gets the number of missed replies after which the link is considered down.

Returns number

getName

getName(): string

- Defined in NM-1.0.d.ts:33157
Gets the name of the link watcher to be used.

Returns string

getSourceHost

getSourceHost(): string

- Defined in NM-1.0.d.ts:33161
Gets the ip address to be used as source for the link probing packets.

Returns string

getTargetHost

getTargetHost(): string

- Defined in NM-1.0.d.ts:33166
Gets the host name/ip address to be used as destination for the link probing packets.

Returns string

getVlanid

getVlanid(): number

- Defined in NM-1.0.d.ts:33170
Gets the VLAN tag ID to be used to outgoing link probes

Returns number

ref

ref(): void

- Defined in NM-1.0.d.ts:33174
Increases the reference count of the object.

Returns void

unref

unref(): void

- Defined in NM-1.0.d.ts:33179
Decreases the reference count of the object. If the reference count reaches zero, the object will be destroyed.

Returns void

Static newArpPing

newArpPing(initWait: number, interval: number, missedMax: number, targetHost: string, sourceHost: string, flags: TeamLinkWatcherArpPingFlags): TeamLinkWatcher

- Defined in NM-1.0.d.ts:33200
Creates a new arp_ping #NMTeamLinkWatcher object

Parameters
- initWait: number
  
  init_wait value
- interval: number
  
  interval value
- missedMax: number
  
  missed_max value
- targetHost: string
  
  the host name or the ip address that will be used as destination address in the arp request
- sourceHost: string
  
  the host name or the ip address that will be used as source address in the arp request
- flags: TeamLinkWatcherArpPingFlags
  
  the watcher #NMTeamLinkWatcherArpPingFlags
Returns TeamLinkWatcher

Static newArpPing2

newArpPing2(initWait: number, interval: number, missedMax: number, vlanid: number, targetHost: string, sourceHost: string, flags: TeamLinkWatcherArpPingFlags): TeamLinkWatcher

- Defined in NM-1.0.d.ts:33212
Creates a new arp_ping #NMTeamLinkWatcher object

Parameters
- initWait: number
  
  init_wait value
- interval: number
  
  interval value
- missedMax: number
  
  missed_max value
- vlanid: number
  
  vlanid value
- targetHost: string
  
  the host name or the ip address that will be used as destination address in the arp request
- sourceHost: string
  
  the host name or the ip address that will be used as source address in the arp request
- flags: TeamLinkWatcherArpPingFlags
  
  the watcher #NMTeamLinkWatcherArpPingFlags
Returns TeamLinkWatcher

Static newEthtool

newEthtool(delayUp: number, delayDown: number): TeamLinkWatcher

- Defined in NM-1.0.d.ts:33219
Creates a new ethtool #NMTeamLinkWatcher object

Parameters
- delayUp: number
  
  delay_up value
- delayDown: number
  
  delay_down value
Returns TeamLinkWatcher

Static newNsnaPing

newNsnaPing(initWait: number, interval: number, missedMax: number, targetHost: string): TeamLinkWatcher

- Defined in NM-1.0.d.ts:33228
Creates a new nsna_ping #NMTeamLinkWatcher object

Parameters
- initWait: number
  
  init_wait value
- interval: number
  
  interval value
- missedMax: number
  
  missed_max value
- targetHost: string
  
  the host name or the ipv6 address that will be used as target address in the NS packet
Returns TeamLinkWatcher