📦 libknet-doc

86 pages

K

knet_addrtostr(3)Convert an address to a host name.✨
knet_get_compress_list(3)Get a list of support compression types.✨
knet_get_crypto_list(3)Get a list of supported crypto libraries.✨
knet_get_transport_id_by_name(3)Get a transport ID from its name.✨
knet_get_transport_list(3)Get a list of the transports support by this build of knet.✨
knet_get_transport_name_by_id(3)Get a transport name from its ID number.✨
knet_handle_add_datafd(3)Install a file descriptor for communication.✨
knet_handle_clear_stats(3)Clear knet stats, link and/or handle.✨
knet_handle_compress(3)Set up packet compression.✨
knet_handle_crypto(3)set up packet cryptographic signing & encryption✨
knet_handle_crypto_rx_clear_traffic(3)enable or disable RX processing of clear (unencrypted) traffic✨
knet_handle_crypto_set_config(3)set up packet cryptographic signing & encryption✨
knet_handle_crypto_use_config(3)specify crypto configuration to use for TX✨
knet_handle_enable_access_lists(3)Enable or disable usage of access lists (default: off)✨
knet_handle_enable_filter(3)install a filter to route packets✨
knet_handle_enable_pmtud_notify(3)install a callback to receive PMTUd changes✨
knet_handle_enable_sock_notify(3)Register a callback to receive socket events.✨
knet_handle_free(3)Destroy a knet handle, free all resources.✨
knet_handle_get_channel(3)Get the channel associated with a file descriptor.✨
knet_handle_get_datafd(3)Get the file descriptor associated with a channel.✨
knet_handle_get_stats(3)Get statistics for compression & crypto.✨
knet_handle_get_transport_reconnect_interval(3)Get the interval between transport attempts to reconnect a failed link.✨
knet_handle_new(3)knet_handle_new_ex with flags = KNET_HANDLE_FLAG_PRIVILEGED.✨
knet_handle_new_ex(3)create a new instance of a knet handle✨
knet_handle_pmtud_get(3)Get the current data MTU.✨
knet_handle_pmtud_getfreq(3)Get the interval between PMTUd scans.✨
knet_handle_pmtud_set(3)Set the current interface MTU.✨
knet_handle_pmtud_setfreq(3)Set the interval between PMTUd scans.✨
knet_handle_remove_datafd(3)Remove a file descriptor from knet.✨
knet_handle_set_transport_reconnect_interval(3)Set the interval between transport attempts to reconnect a failed link.✨
knet_handle_setfwd(3)Start packet forwarding.✨
knet_handle_setprio_dscp(3)Use dscp for IP_TOS on socket to implement KNET_LINK_FLAG_TRAFFICHIPRIO.✨
knet_host_add(3)Add a new host ID to knet.✨
knet_host_enable_status_change_notify(3)Install a callback to get host status change events.✨
knet_host_get_host_list(3)Get a list of hosts known to knet.✨
knet_host_get_id_by_host_name(3)Get the ID of a host given its name.✨
knet_host_get_name_by_host_id(3)Get the name of a host given its ID.✨
knet_host_get_policy(3)Get the switching policy for a host's links.✨
knet_host_get_status(3)Get the status of a host.✨
knet_host_remove(3)Remove a host ID from knet.✨
knet_host_set_name(3)Set the name of a knet host.✨
knet_host_set_policy(3)Set the switching policy for a host's links.✨
knet_link_add_acl(3)Add access list entry to an open link.✨
knet_link_clear_acl(3)Remove all access list entries from an open link.✨
knet_link_clear_config(3)Clear link information and disconnect the link.✨
knet_link_get_config(3)Get the link configutation information.✨
knet_link_get_enable(3)Find out whether a link is enabled or not.✨
knet_link_get_link_list(3)Get a list of links connecting a host.✨
knet_link_get_ping_timers(3)Get the ping timers for a link.✨
knet_link_get_pong_count(3)Get the pong count for a link.✨
knet_link_get_priority(3)Get the priority for a link.✨
knet_link_get_status(3)Get the status (and statistics) for a link.✨
knet_link_insert_acl(3)Insert access list entry to an open link at given index.✨
knet_link_rm_acl(3)Remove access list entry from an open link.✨
knet_link_set_config(3)Configure the link to a host.✨
knet_link_set_enable(3)Enable traffic on a link.✨
knet_link_set_ping_timers(3)Set the ping timers for a link.✨
knet_link_set_pong_count(3)Set the pong count for a link.✨
knet_link_set_priority(3)Set the priority for a link.✨
knet_log_get_loglevel(3)Get the logging level for a subsystem.✨
knet_log_get_loglevel_id(3)Get a logging level ID from its name.✨
knet_log_get_loglevel_name(3)Get a logging level name from its numeric ID.✨
knet_log_get_subsystem_id(3)Get a logging system ID from its name.✨
knet_log_get_subsystem_name(3)Get a logging system name from its numeric ID.✨
knet_log_set_loglevel(3)Set the logging level for a subsystem.✨
knet_recv(3)Receive data from knet nodes.✨
knet_send(3)Send data to knet nodes.✨
knet_send_sync(3)Synchronously send data to knet nodes.✨
knet_strtoaddr(3)Convert a hostname string to an address.✨

N

nozzle_add_ip(3)equivalent of ip addr or ifconfig <ipaddress/prefix>✨
nozzle_close(3)deconfigure and destroy a nozzle device✨
nozzle_del_ip(3)equivalent of ip addr del or ifconfig del <ipaddress/prefix>✨
nozzle_get_fd(3)nozzle - pointer to the nozzle struct✨
nozzle_get_handle_by_name(3)find a nozzle handle by device name✨
nozzle_get_ips(3)retrieve the list of all configured ips for a given interface✨
nozzle_get_mac(3)retrieve mac address on a given nozzle interface✨
nozzle_get_mtu(3)retrieve mtu on a given nozzle interface✨
nozzle_get_name_by_handle(3)retrieve nozzle interface name by handle✨
nozzle_open(3)create a new tap device on the system.✨
nozzle_reset_mac(3)reset mac address on a given nozzle interface to system default✨
nozzle_reset_mtu(3)reset mtu on a given nozzle interface to the system default✨
nozzle_run_updown(3)execute updown commands associated with a nozzle device.✨
nozzle_set_down(3)equivalent of ifconfig down✨
nozzle_set_mac(3)set mac address on a given nozzle interface✨
nozzle_set_mtu(3)set mtu on a given nozzle interface✨
nozzle_set_up(3)equivalent of ifconfig up✨