dst_host_filter_fn_private_data void pointer to data that can be used to identify the callback.
.PP
dst_host_filter_fn - is a callback function that is invoked every time a packet hits datafd (see knet_handle_new(3)). the function allows users to tell libknet where the packet has to be delivered.
.PP
-const unsigned char *outdata - is a pointer to the current packet ssize_t outdata_len - lenght of the above data uint8_t tx_rx - filter is called on tx or rx (see defines below) knet_node_id_t this_host_id - host_id processing the packet knet_node_id_t src_host_id - host_id that generated the packet knet_node_id_t *dst_host_ids - array of KNET_MAX_HOST knet_node_id_t where to store the destinations size_t *dst_host_ids_entries - number of hosts to send the message
+const unsigned char *outdata - is a pointer to the current packet ssize_t outdata_len - length of the above data uint8_t tx_rx - filter is called on tx or rx (KNET_NOTIFY_TX, KNET_NOTIFY_RX) knet_node_id_t this_host_id - host_id processing the packet knet_node_id_t src_host_id - host_id that generated the packet knet_node_id_t *dst_host_ids - array of KNET_MAX_HOST knet_node_id_t where to store the destinations size_t *dst_host_ids_entries - number of hosts to send the message
.PP
dst_host_filter_fn should return -1 on error, packet is discarded. 0 packet is unicast and should be sent to dst_host_ids and there are dst_host_ids_entries in the buffer. 1 packet is broadcast/multicast and is sent all hosts. contents of dst_host_ids and dst_host_ids_entries are ignored. (see also kronosnetd/etherfilter.* for an example that filters based on ether protocol)
.SH RETURN VALUE
.PP
knet_handle_enable_filter returns 0 on success -1 on error and errno is set.
knet_handle_new \- create a new instance of a knet handle
.SH SYNOPSIS
.nf
.B #include <libknet.h>
.sp
\fBknet_handle_t knet_handle_new\fP(
\fBknet_node_id_t \fP\fIhost_id\fP,
\fBint \fP\fIlog_fd\fP,
\fBuint8_t \fP\fIdefault_log_level\fP
);
.fi
.SH DESCRIPTION
.PP
knet_handle_new
.PP
host_id - Each host in a knet is identified with a unique ID. when creating a new handle local host_id must be specified (0 to UINT16T_MAX are all valid). It is the user's responsibility to check that the value is unique, or bad things might happen.
.PP
-log_fd - Write file descriptor. If set to a value > 0, it will be used to write log packets (see below) from libknet to the application. Setting to 0 will disable logging from libknet. It is possible to enable logging at any given time (see logging API below). Make sure to either read from this filedescriptor properly and/or mark it O_NONBLOCK, otherwise if the fd becomes full, libknet could block.
+log_fd - Write file descriptor. If set to a value > 0, it will be used to write log packets from libknet to the application. Setting to 0 will disable logging from libknet. It is possible to enable logging at any given time (see logging API). Make sure to either read from this filedescriptor properly and/or mark it O_NONBLOCK, otherwise if the fd becomes full, libknet could block.
.PP
-default_log_level - If logfd is specified, it will initialize all subsystems to log at default_log_level value. (see logging API below)
+default_log_level - If logfd is specified, it will initialize all subsystems to log at default_log_level value. (see logging API)
.SH RETURN VALUE
.PP
on success, a new knet_handle_t is returned. on failure, NULL is returned and errno is set.
-host_status_change_notify_fn_private_data void pointer to data that can be used to identify the callback.
+host_status_change_notify_fn_private_data - void pointer to data that can be used to identify the callback
.PP
external, 0 if the host_id is configured locally or 1 if it has been added from remote nodes config. NOTE: dynamic topology is NOT currently implemented, but this is ready for future and can avoid an API/ABI breakage later on. This function MUST NEVER block or add substantial delays.
.SH RETURN VALUE
.PP
knet_host_status_change_notify returns 0 on success -1 on error and errno is set.
knet_host_set_name \- Set the name of a knet host.
.SH SYNOPSIS
.nf
.B #include <libknet.h>
.sp
\fBint knet_host_set_name\fP(
\fBknet_handle_t \fP\fIknet_h\fP,
\fBknet_node_id_t \fP\fIhost_id\fP,
\fBconst char *\fP\fIname\fP
);
.fi
.SH DESCRIPTION
.PP
knet_host_set_name
.PP
knet_h - pointer to knet_handle_t
.PP
-host_id - see above
+host_id - see knet_host_add(3)
.PP
name - this name will be used for pretty logging and eventually search for hosts (see also knet_handle_host_get_name(2) and knet_handle_host_get_id(3)). Only up to KNET_MAX_HOST_LEN - 1 bytes will be accepted and name has to be unique for each host.
.SH RETURN VALUE
.PP
knet_host_set_name returns: 0 on success -1 on error and errno is set.
knet_host_set_policy \- Set the switching policy for a host's links.
.SH SYNOPSIS
.nf
.B #include <libknet.h>
.sp
\fBint knet_host_set_policy\fP(
\fBknet_handle_t \fP\fIknet_h\fP,
\fBknet_node_id_t \fP\fIhost_id\fP,
\fBuint8_t \fP\fIpolicy\fP
);
.fi
.SH DESCRIPTION
.PP
knet_host_set_policy
.PP
knet_h - pointer to knet_handle_t
.PP
host_id - see knet_host_add(3)
.PP
-policy - there are currently 3 kind of simple switching policies as defined above, based on link configuration. KNET_LINK_POLICY_PASSIVE - the active link with the lowest priority will be used. if one or more active links share the same priority, the one with lowest link_id will be used.
+policy - there are currently 3 kind of simple switching policies based on link configuration. KNET_LINK_POLICY_PASSIVE - the active link with the lowest priority will be used. if one or more active links share the same priority, the one with lowest link_id will be used.
.PP
KNET_LINK_POLICY_ACTIVE - all active links will be used simultaneously to send traffic. link priority is ignored.
.PP
KNET_LINK_POLICY_RR - round-robin policy, every packet will be send on a different active link.
.SH RETURN VALUE
.PP
knet_host_set_policy returns 0 on success -1 on error and errno is set.
knet_link_get_status \- Get the status (and statistics) for a link.
.SH SYNOPSIS
.nf
.B #include <libknet.h>
.sp
\fBint knet_link_get_status\fP(
\fBknet_handle_t \fP\fIknet_h\fP,
\fBknet_node_id_t \fP\fIhost_id\fP,
\fBuint8_t \fP\fIlink_id\fP,
\fBstruct knet_link_status *\fP\fIstatus\fP,
\fBsize_t \fP\fIstruct_size\fP
);
.fi
.SH DESCRIPTION
.PP
knet_link_get_status
.PP
knet_h - pointer to knet_handle_t
.PP
-host_id - see above
+host_id - see knet_host_add(3)
.PP
-link_id - see above
+link_id - see knet_link_set_config(3)
.PP
-status - pointer to knet_link_status struct (see above)
+status - pointer to knet_link_status struct
.PP
struct_size - max size of knet_link_status - allows library to add fields without ABI change. Returned structure will be truncated to this length and .size member indicates the full size.
.SH STRUCTURES
.SS ""
.PP
.sp
.sp
.RS
.nf
\fB
struct knet_link_status {
size_t \fIsize\fP;
char \fIsrc_ipaddr\fP;
char \fIsrc_port\fP;
char \fIdst_ipaddr\fP;
char \fIdst_port\fP;
uint8_t \fIenabled\fP;
uint8_t \fIconnected\fP;
uint8_t \fIdynconnected\fP;
unsigned long long \fIlatency\fP;
struct timespec \fIpong_last\fP;
unsigned int \fImtu\fP;
unsigned int \fIproto_overhead\fP;
struct knet_link_stats \fIstats\fP;
};
\fP
.fi
.RE
.SH RETURN VALUE
.PP
knet_link_get_status returns 0 on success -1 on error and errno is set.
knet_link_set_config \- Configure the link to a host.
.SH SYNOPSIS
.nf
.B #include <libknet.h>
.sp
\fBint knet_link_set_config\fP(
\fBknet_handle_t \fP\fIknet_h\fP,
\fBknet_node_id_t \fP\fIhost_id\fP,
\fBuint8_t \fP\fIlink_id\fP,
\fBuint8_t \fP\fItransport\fP,
\fBstruct sockaddr_storage *\fP\fIsrc_addr\fP,
\fBstruct sockaddr_storage *\fP\fIdst_addr\fP,
\fBuint64_t \fP\fIflags\fP
);
.fi
.SH DESCRIPTION
.PP
knet_link_set_config
.PP
knet_h - pointer to knet_handle_t
.PP
host_id - see knet_host_add(3)
.PP
link_id - see knet_link_set_config(3)
.PP
-transport - one of the above KNET_TRANSPORT_xxx constants
+transport - one of the KNET_TRANSPORT_xxx constants
.PP
src_addr - sockaddr_storage that can be either IPv4 or IPv6
.PP
dst_addr - sockaddr_storage that can be either IPv4 or IPv6 this can be null if we don't know the incoming IP address/port and the link will remain quiet till the node on the other end will initiate a connection
.PP
flags - KNET_LINK_FLAG_*
.SH RETURN VALUE
.PP
knet_link_set_config returns 0 on success -1 on error and errno is set.
int knet_handle_enable_pmtud_notify(knet_handle_t, void *, void(*)(void *private_data, unsigned int data_mtu));
int knet_handle_enable_sock_notify(knet_handle_t, void *, void(*)(void *private_data, int datafd, int8_t channel, uint8_t tx_rx, int error, int errorno));
int knet_handle_free(knet_handle_t);
int knet_handle_get_channel(knet_handle_t, const int, int8_t *);
int knet_handle_get_compress_list(knet_handle_t, const char **, size_t *);
int knet_handle_get_crypto_list(knet_handle_t, const char **, size_t *);
int knet_handle_get_datafd(knet_handle_t, const int8_t, int *);
int knet_handle_get_stats(knet_handle_t, struct knet_handle_stats *, size_t);