knet_link_set_ping_timers(3)

knet_link_set_ping_timers3

Set the ping timers for a link.

Usage

#include <libknet.h>

int knet_link_set_ping_timers(
    knet_handle_t   knet_h,
    knet_node_id_t  host_id,
    uint8_t         link_id,
    time_t          interval,
    time_t          timeout,
    unsigned int    precision
);

Overview

knet_link_set_ping_timers

knet_h - pointer to knet_handle_t

host_id - see knet_host_add(3)

link_id - see knet_link_set_config(3)

interval - specify the ping interval in milliseconds.

timeout - if no pong is received within this time, the link is declared dead, in milliseconds. NOTE: in future it will be possible to set timeout to 0 for an autocalculated timeout based on interval, pong_count and latency. The API already accept 0 as value and it will return ENOSYS / -1. Once the automatic calculation feature will be implemented, this call will only return EINVAL for incorrect values.

precision - how many values of latency are used to calculate the average link latency (see also knet_link_get_status(3))

Return value

knet_link_set_ping_timers returns 0 on success -1 on error and errno is set.

Releases

4 releases since Debian 10 (Buster); the text changed 3 times.

  1. 10
  2. 11
  3. 12
  4. 13

From libknet-doc 1.31-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.