NM-1.0 ▶ NM ▶ TeamLinkWatcher

constructor

• new TeamLinkWatcher(
      init_wait: number,
      interval: number,
      missed_max: number,
      target_host: string,
      source_host: string,
      flags: NM.TeamLinkWatcherArpPingFlags,
  ): TeamLinkWatcher

  Parameters

  • init_wait: number
  • interval: number
  • missed_max: number
  • target_host: string
  • source_host: string
  • flags: NM.TeamLinkWatcherArpPingFlags

  Returns TeamLinkWatcher

Static$gtype

Since 1.12dup

• dup(): TeamLinkWatcher

  Creates a copy of watcher

  Returns TeamLinkWatcher

  a copy of watcher

  Since

  1.12

Since 1.12equal

• equal(other: TeamLinkWatcher): boolean

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

  Parameters

  • other: TeamLinkWatcher

    the NM.TeamLinkWatcher to compare watcher to.

  Returns boolean

  true if the objects contain the same values, false if they do not.

  Since

  1.12

Since 1.12get_delay_down

• get_delay_down(): number

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

  Returns number

  Since

  1.12

Since 1.12get_delay_up

• get_delay_up(): number

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

  Returns number

  Since

  1.12

Since 1.12get_flags

• get_flags(): NM.TeamLinkWatcherArpPingFlags

  Gets the arp ping watcher flags.

  Returns NM.TeamLinkWatcherArpPingFlags

  Since

  1.12

Since 1.12get_init_wait

• get_init_wait(): number

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

  Returns number

  Since

  1.12

Since 1.12get_interval

• get_interval(): number

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

  Returns number

  Since

  1.12

Since 1.12get_missed_max

• get_missed_max(): number

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

  Returns number

  Since

  1.12

Since 1.12get_name

• get_name(): string

  Gets the name of the link watcher to be used.

  Returns string

  Since

  1.12

Since 1.12get_source_host

• get_source_host(): string

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

  Returns string

  Since

  1.12

Since 1.12get_target_host

• get_target_host(): string

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

  Returns string

  Since

  1.12

Since 1.16get_vlanid

• get_vlanid(): number

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

  Returns number

  Since

  1.16

Since 1.12ref

• ref(): void

  Increases the reference count of the object.

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

  Returns void

  Since

  1.12

Since 1.12unref

• unref(): void

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

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

  Returns void

  Since

  1.12

Staticnew_arp_ping

• new_arp_ping(
      init_wait: number,
      interval: number,
      missed_max: number,
      target_host: string,
      source_host: string,
      flags: NM.TeamLinkWatcherArpPingFlags,
  ): TeamLinkWatcher

  Parameters

  • init_wait: number
  • interval: number
  • missed_max: number
  • target_host: string
  • source_host: string
  • flags: NM.TeamLinkWatcherArpPingFlags

  Returns TeamLinkWatcher

Staticnew_arp_ping2

• new_arp_ping2(
      init_wait: number,
      interval: number,
      missed_max: number,
      vlanid: number,
      target_host: string,
      source_host: string,
      flags: NM.TeamLinkWatcherArpPingFlags,
  ): TeamLinkWatcher

  Parameters

  • init_wait: number
  • interval: number
  • missed_max: number
  • vlanid: number
  • target_host: string
  • source_host: string
  • flags: NM.TeamLinkWatcherArpPingFlags

  Returns TeamLinkWatcher

Staticnew_ethtool

• new_ethtool(delay_up: number, delay_down: number): TeamLinkWatcher

  Parameters

  • delay_up: number
  • delay_down: number

  Returns TeamLinkWatcher

Staticnew_nsna_ping

• new_nsna_ping(
      init_wait: number,
      interval: number,
      missed_max: number,
      target_host: string,
  ): TeamLinkWatcher

  Parameters

  • init_wait: number
  • interval: number
  • missed_max: number
  • target_host: string

  Returns TeamLinkWatcher