Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

PingConfig

This interface is fully implemented not recommended for use unless you are using BrightSign OS v8.2 or later and is only fully implemented in BrightSign OS v8.3.45 and later:.

  • [unsigned short] count: The default value is 10
  • [unsigned long] interval: Value in milliseconds. The default is 100.
  • [unsigned long] timeout: The timeout value in seconds. The default is 10000.
  • [unsigned long] packetsize: // in bytes, default 56
  • [bool] ipv4: Enable pinging IPv6 addresses. The default is true.
  • [bool] ipv6: Enable pinging IPv6 addresses. The default isfalse.
  • [bool] allAddresses: If true then ping all addresses returned from the DNS query, if false then each will be pinged in turn until one responds. The default is false.

PingResult

This interface is fully implemented not recommended for use unless you are using BrightSign OS v8.2 or later and is only fully implemented in BrightSign OS v8.3.45 and later:.

  • [string] hostname: The host name or literal address pinged
  • [PingResults] results:

PingResults

This interface is fully implemented is not recommended for use unless you are using BrightSign OS v8.2 or later and is only fully implemented in BrightSign OS v8.3.45 and later:.

  • [bool] up: This value is true if at least one address responded to at least 50% of the echo requests
  • [Array<ProtocolPingResult>] ipv4:
  • [Array<ProtocolPingResult>] ipv6:

ProtocolPingResults

This interface is fully implemented is not recommended for use unless you are using BrightSign OS v8.2 or later and is only fully implemented in BrightSign OS v8.3.45 and later:.

  • [string] address:  The IP address pinged
  • [bool] up: If true if the address responded to at least 50% of the echo requests ProtocolPingReport report

ProtocolPingReport

This interface is fully implemented not recommended for use unless you are using BrightSign OS v8.2 or later and is only fully implemented in BrightSign OS v8.3.45 and later:.

  • [unsigned short] transmitted: The number of echo requests sent
  • [unsigned short] received: The number of echo replies received
  • [ProtocolPingStats] stats:

ProtocolPingStats

This interface is fully implemented is not recommended for use unless you are using BrightSign OS v8.2 or later and is only fully implemented in BrightSign OS v8.3.45 and later:.

  • [unsigned long] quickest: The quickest reply received
  • [unsigned long]  average: The average time across all replies from address
  • [unsigned long]  slowest: The slowest reply received.
  • [string]  units: The value is always "us" to indicate microseconds

...