X-Git-Url: http://git.meshlink.io/?p=meshlink;a=blobdiff_plain;f=src%2Fmeshlink.h;h=3a23eb088b6d38a810b7f821565b00cd6afdfddd;hp=2763ad8d214ff2d52d2ec3b0ec373c8a0cb12a07;hb=5a8e05640dfa2db62d3a4afe82d38137355733d4;hpb=5f2e8877486869471041b0eca1aaed841c41a1a9 diff --git a/src/meshlink.h b/src/meshlink.h index 2763ad8d..3a23eb08 100644 --- a/src/meshlink.h +++ b/src/meshlink.h @@ -71,7 +71,7 @@ typedef enum { MESHLINK_EPEER, ///< A peer caused an error MESHLINK_ENOTSUP, ///< The operation is not supported in the current configuration of MeshLink MESHLINK_EBUSY, ///< The MeshLink instance is already in use by another process - MESHLINK_EBLACKLISTED, ///< The operation is not allowed because the node is blacklisted + MESHLINK_EBLACKLISTED ///< The operation is not allowed because the node is blacklisted } meshlink_errno_t; /// Device class @@ -140,7 +140,7 @@ struct meshlink_channel { * The pointer is to static storage that is valid for the lifetime of the application. * This function will always return a valid pointer, even if an invalid error code has been passed. */ -extern const char *meshlink_strerror(meshlink_errno_t err) __attribute__((__warn_unused_result__)); +const char *meshlink_strerror(meshlink_errno_t err) __attribute__((__warn_unused_result__)); /// Create a new meshlink_open_params_t struct. /** This function allocates and initializes a new meshlink_open_params_t struct that can be passed to meshlink_open_ex(). @@ -159,14 +159,14 @@ extern const char *meshlink_strerror(meshlink_errno_t err) __attribute__((__warn * @return A pointer to a meshlink_open_params_t which can be passed to meshlink_open_ex(), or NULL in case of an error. * The pointer is valid until meshlink_open_params_free() is called. */ -extern meshlink_open_params_t *meshlink_open_params_init(const char *confbase, const char *name, const char *appname, dev_class_t devclass) __attribute__((__warn_unused_result__)); +meshlink_open_params_t *meshlink_open_params_init(const char *confbase, const char *name, const char *appname, dev_class_t devclass) __attribute__((__warn_unused_result__)); /// Free a meshlink_open_params_t struct. /** This function frees a meshlink_open_params_t struct and all resources associated with it. * * @param params A pointer to a meshlink_open_params_t which must have been created earlier with meshlink_open_params_init(). */ -extern void meshlink_open_params_free(meshlink_open_params_t *params); +void meshlink_open_params_free(meshlink_open_params_t *params); /// Set the network namespace MeshLink should use. /** This function changes the open parameters to use the given netns filedescriptor. @@ -176,7 +176,7 @@ extern void meshlink_open_params_free(meshlink_open_params_t *params); * * @return This function will return true if the open parameters have been successfully updated, false otherwise. */ -extern bool meshlink_open_params_set_netns(meshlink_open_params_t *params, int netns) __attribute__((__warn_unused_result__)); +bool meshlink_open_params_set_netns(meshlink_open_params_t *params, int netns) __attribute__((__warn_unused_result__)); /// Set the encryption key MeshLink should use for local storage. /** This function changes the open parameters to use the given key for encrypting MeshLink's own configuration files. @@ -187,7 +187,7 @@ extern bool meshlink_open_params_set_netns(meshlink_open_params_t *params, int n * * @return This function will return true if the open parameters have been successfully updated, false otherwise. */ -extern bool meshlink_open_params_set_storage_key(meshlink_open_params_t *params, const void *key, size_t keylen) __attribute__((__warn_unused_result__)); +bool meshlink_open_params_set_storage_key(meshlink_open_params_t *params, const void *key, size_t keylen) __attribute__((__warn_unused_result__)); /// Open or create a MeshLink instance. /** This function opens or creates a MeshLink instance. @@ -207,7 +207,7 @@ extern bool meshlink_open_params_set_storage_key(meshlink_open_params_t *params, * @return A pointer to a struct meshlink_handle which represents this instance of MeshLink, or NULL in case of an error. * The pointer is valid until meshlink_close() is called. */ -extern struct meshlink_handle *meshlink_open_ex(const meshlink_open_params_t *params) __attribute__((__warn_unused_result__)); +struct meshlink_handle *meshlink_open_ex(const meshlink_open_params_t *params) __attribute__((__warn_unused_result__)); /// Open or create a MeshLink instance. /** This function opens or creates a MeshLink instance. @@ -237,7 +237,7 @@ extern struct meshlink_handle *meshlink_open_ex(const meshlink_open_params_t *pa * @return A pointer to a struct meshlink_handle which represents this instance of MeshLink, or NULL in case of an error. * The pointer is valid until meshlink_close() is called. */ -extern struct meshlink_handle *meshlink_open(const char *confbase, const char *name, const char *appname, dev_class_t devclass) __attribute__((__warn_unused_result__)); +struct meshlink_handle *meshlink_open(const char *confbase, const char *name, const char *appname, dev_class_t devclass) __attribute__((__warn_unused_result__)); /// Open or create a MeshLink instance that uses encrypted storage. /** This function opens or creates a MeshLink instance. @@ -269,7 +269,7 @@ extern struct meshlink_handle *meshlink_open(const char *confbase, const char *n * @return A pointer to a struct meshlink_handle which represents this instance of MeshLink, or NULL in case of an error. * The pointer is valid until meshlink_close() is called. */ -extern struct meshlink_handle *meshlink_open_encrypted(const char *confbase, const char *name, const char *appname, dev_class_t devclass, const void *key, size_t keylen) __attribute__((__warn_unused_result__)); +struct meshlink_handle *meshlink_open_encrypted(const char *confbase, const char *name, const char *appname, dev_class_t devclass, const void *key, size_t keylen) __attribute__((__warn_unused_result__)); /// Create an ephemeral MeshLink instance that does not store any state. /** This function creates a MeshLink instance. @@ -293,7 +293,7 @@ extern struct meshlink_handle *meshlink_open_encrypted(const char *confbase, con * @return A pointer to a struct meshlink_handle which represents this instance of MeshLink, or NULL in case of an error. * The pointer is valid until meshlink_close() is called. */ -extern struct meshlink_handle *meshlink_open_ephemeral(const char *name, const char *appname, dev_class_t devclass) __attribute__((__warn_unused_result__)); +struct meshlink_handle *meshlink_open_ephemeral(const char *name, const char *appname, dev_class_t devclass) __attribute__((__warn_unused_result__)); /// Create Sub-Mesh. /** This function causes MeshLink to open a new Sub-Mesh network @@ -322,7 +322,7 @@ struct meshlink_submesh *meshlink_submesh_open(struct meshlink_handle *mesh, con * * @return This function will return true if MeshLink has successfully started, false otherwise. */ -extern bool meshlink_start(struct meshlink_handle *mesh) __attribute__((__warn_unused_result__)); +bool meshlink_start(struct meshlink_handle *mesh) __attribute__((__warn_unused_result__)); /// Stop MeshLink. /** This function causes MeshLink to disconnect from all other nodes, @@ -334,7 +334,7 @@ extern bool meshlink_start(struct meshlink_handle *mesh) __attribute__((__warn_u * \memberof meshlink_handle * @param mesh A handle which represents an instance of MeshLink. */ -extern void meshlink_stop(struct meshlink_handle *mesh); +void meshlink_stop(struct meshlink_handle *mesh); /// Close the MeshLink handle. /** This function calls meshlink_stop() if necessary, @@ -348,7 +348,7 @@ extern void meshlink_stop(struct meshlink_handle *mesh); * \memberof meshlink_handle * @param mesh A handle which represents an instance of MeshLink. */ -extern void meshlink_close(struct meshlink_handle *mesh); +void meshlink_close(struct meshlink_handle *mesh); /// Destroy a MeshLink instance. /** This function remove all configuration files of a MeshLink instance. It should only be called when the application @@ -360,7 +360,7 @@ extern void meshlink_close(struct meshlink_handle *mesh); * * @return This function will return true if the MeshLink instance was successfully destroyed, false otherwise. */ -extern bool meshlink_destroy(const char *confbase) __attribute__((__warn_unused_result__)); +bool meshlink_destroy(const char *confbase) __attribute__((__warn_unused_result__)); /// A callback for receiving data from the mesh. /** @param mesh A handle which represents an instance of MeshLink. @@ -384,7 +384,7 @@ typedef void (*meshlink_receive_cb_t)(struct meshlink_handle *mesh, struct meshl * @param cb A pointer to the function which will be called when another node sends data to the local node. * If a NULL pointer is given, the callback will be disabled. */ -extern void meshlink_set_receive_cb(struct meshlink_handle *mesh, meshlink_receive_cb_t cb); +void meshlink_set_receive_cb(struct meshlink_handle *mesh, meshlink_receive_cb_t cb); /// A callback reporting the meta-connection attempt made by the host node to an another node. /** @param mesh A handle which represents an instance of MeshLink. @@ -405,7 +405,7 @@ typedef void (*meshlink_connection_try_cb_t)(struct meshlink_handle *mesh, struc * @param cb A pointer to the function which will be called when host node attempts to make * the connection to another node. If a NULL pointer is given, the callback will be disabled. */ -extern void meshlink_set_connection_try_cb(struct meshlink_handle *mesh, meshlink_connection_try_cb_t cb); +void meshlink_set_connection_try_cb(struct meshlink_handle *mesh, meshlink_connection_try_cb_t cb); /// A callback reporting node status changes. /** @param mesh A handle which represents an instance of MeshLink. @@ -427,7 +427,7 @@ typedef void (*meshlink_node_status_cb_t)(struct meshlink_handle *mesh, struct m * @param cb A pointer to the function which will be called when another node's status changes. * If a NULL pointer is given, the callback will be disabled. */ -extern void meshlink_set_node_status_cb(struct meshlink_handle *mesh, meshlink_node_status_cb_t cb); +void meshlink_set_node_status_cb(struct meshlink_handle *mesh, meshlink_node_status_cb_t cb); /// A callback reporting node path MTU changes. /** @param mesh A handle which represents an instance of MeshLink. @@ -449,7 +449,7 @@ typedef void (*meshlink_node_pmtu_cb_t)(struct meshlink_handle *mesh, struct mes * @param cb A pointer to the function which will be called when another node's extended status changes. * If a NULL pointer is given, the callback will be disabled. */ -extern void meshlink_set_node_pmtu_cb(struct meshlink_handle *mesh, meshlink_node_pmtu_cb_t cb); +void meshlink_set_node_pmtu_cb(struct meshlink_handle *mesh, meshlink_node_pmtu_cb_t cb); /// A callback reporting duplicate node detection. /** @param mesh A handle which represents an instance of MeshLink. @@ -470,7 +470,7 @@ typedef void (*meshlink_node_duplicate_cb_t)(struct meshlink_handle *mesh, struc * @param cb A pointer to the function which will be called when a duplicate node is detected. * If a NULL pointer is given, the callback will be disabled. */ -extern void meshlink_set_node_duplicate_cb(struct meshlink_handle *mesh, meshlink_node_duplicate_cb_t cb); +void meshlink_set_node_duplicate_cb(struct meshlink_handle *mesh, meshlink_node_duplicate_cb_t cb); /// Severity of log messages generated by MeshLink. typedef enum { @@ -513,7 +513,7 @@ typedef void (*meshlink_log_cb_t)(struct meshlink_handle *mesh, meshlink_log_lev * @param cb A pointer to the function which will be called when another node sends data to the local node. * If a NULL pointer is given, the callback will be disabled. */ -extern void meshlink_set_log_cb(struct meshlink_handle *mesh, meshlink_log_level_t level, meshlink_log_cb_t cb); +void meshlink_set_log_cb(struct meshlink_handle *mesh, meshlink_log_level_t level, meshlink_log_cb_t cb); /// A callback for receiving error conditions encountered by the MeshLink thread. /** @param mesh A handle which represents an instance of MeshLink, or NULL. @@ -545,7 +545,7 @@ typedef void (*meshlink_error_cb_t)(struct meshlink_handle *mesh, meshlink_errno * @param cb A pointer to the function which will be called when a serious error is encountered. * If a NULL pointer is given, the callback will be disabled. */ -extern void meshlink_set_error_cb(struct meshlink_handle *mesh, meshlink_error_cb_t cb); +void meshlink_set_error_cb(struct meshlink_handle *mesh, meshlink_error_cb_t cb); /// Send data to another node. /** This functions sends one packet of data to another node in the mesh. @@ -566,7 +566,7 @@ extern void meshlink_set_error_cb(struct meshlink_handle *mesh, meshlink_error_c * @return This function will return true if MeshLink has queued the message for transmission, and false otherwise. * A return value of true does not guarantee that the message will actually arrive at the destination. */ -extern bool meshlink_send(struct meshlink_handle *mesh, struct meshlink_node *destination, const void *data, size_t len) __attribute__((__warn_unused_result__)); +bool meshlink_send(struct meshlink_handle *mesh, struct meshlink_node *destination, const void *data, size_t len) __attribute__((__warn_unused_result__)); /// Query the maximum packet size that can be sent to a node. /** This functions returns the maximum size of packets (path MTU) that can be sent to a specific node with meshlink_send(). @@ -582,7 +582,7 @@ extern bool meshlink_send(struct meshlink_handle *mesh, struct meshlink_node *de * @return The recommended maximum size of packets that are to be sent to the destination node, 0 if the node is unreachable, * or a negative value in case of an error. */ -extern ssize_t meshlink_get_pmtu(struct meshlink_handle *mesh, struct meshlink_node *destination) __attribute__((__warn_unused_result__)); +ssize_t meshlink_get_pmtu(struct meshlink_handle *mesh, struct meshlink_node *destination) __attribute__((__warn_unused_result__)); /// Get a handle for our own node. /** This function returns a handle for the local node. @@ -593,7 +593,7 @@ extern ssize_t meshlink_get_pmtu(struct meshlink_handle *mesh, struct meshlink_n * @return A pointer to a struct meshlink_node which represents the local node. * The pointer is guaranteed to be valid until meshlink_close() is called. */ -extern struct meshlink_node *meshlink_get_self(struct meshlink_handle *mesh) __attribute__((__warn_unused_result__)); +struct meshlink_node *meshlink_get_self(struct meshlink_handle *mesh) __attribute__((__warn_unused_result__)); /// Get a handle for a specific node. /** This function returns a handle for the node with the given name. @@ -607,7 +607,7 @@ extern struct meshlink_node *meshlink_get_self(struct meshlink_handle *mesh) __a * or NULL if the requested node does not exist. * The pointer is guaranteed to be valid until meshlink_close() is called. */ -extern struct meshlink_node *meshlink_get_node(struct meshlink_handle *mesh, const char *name) __attribute__((__warn_unused_result__)); +struct meshlink_node *meshlink_get_node(struct meshlink_handle *mesh, const char *name) __attribute__((__warn_unused_result__)); /// Get a handle for a specific submesh. /** This function returns a handle for the submesh with the given name. @@ -621,7 +621,7 @@ extern struct meshlink_node *meshlink_get_node(struct meshlink_handle *mesh, con * or NULL if the requested submesh does not exist. * The pointer is guaranteed to be valid until meshlink_close() is called. */ -extern struct meshlink_submesh *meshlink_get_submesh(struct meshlink_handle *mesh, const char *name) __attribute__((__warn_unused_result__)); +struct meshlink_submesh *meshlink_get_submesh(struct meshlink_handle *mesh, const char *name) __attribute__((__warn_unused_result__)); /// Get the fingerprint of a node's public key. /** This function returns a fingerprint of the node's public key. @@ -634,7 +634,7 @@ extern struct meshlink_submesh *meshlink_get_submesh(struct meshlink_handle *mes * @return A nul-terminated C string containing the fingerprint of the node's public key in a printable ASCII format. * The application should call free() after it is done using this string. */ -extern char *meshlink_get_fingerprint(struct meshlink_handle *mesh, struct meshlink_node *node) __attribute__((__warn_unused_result__)); +char *meshlink_get_fingerprint(struct meshlink_handle *mesh, struct meshlink_node *node) __attribute__((__warn_unused_result__)); /// Get a list of all nodes. /** This function returns a list with handles for all known nodes. @@ -654,7 +654,7 @@ extern char *meshlink_get_fingerprint(struct meshlink_handle *mesh, struct meshl * If it is a new value, the old value of @a nodes should not be used anymore. * If the new value is NULL, then the old array will have been freed by MeshLink. */ -extern struct meshlink_node **meshlink_get_all_nodes(struct meshlink_handle *mesh, struct meshlink_node **nodes, size_t *nmemb) __attribute__((__warn_unused_result__)); +struct meshlink_node **meshlink_get_all_nodes(struct meshlink_handle *mesh, struct meshlink_node **nodes, size_t *nmemb) __attribute__((__warn_unused_result__)); /// Sign data using the local node's MeshLink key. /** This function signs data using the local node's MeshLink key. @@ -671,7 +671,7 @@ extern struct meshlink_node **meshlink_get_all_nodes(struct meshlink_handle *mes * * @return This function returns true if the signature was correctly generated, false otherwise. */ -extern bool meshlink_sign(struct meshlink_handle *mesh, const void *data, size_t len, void *signature, size_t *siglen) __attribute__((__warn_unused_result__)); +bool meshlink_sign(struct meshlink_handle *mesh, const void *data, size_t len, void *signature, size_t *siglen) __attribute__((__warn_unused_result__)); /// Get the list of all nodes by device class. /** This function returns a list with handles for all the nodes that matches with the given @a devclass. @@ -692,7 +692,7 @@ extern bool meshlink_sign(struct meshlink_handle *mesh, const void *data, size_t * If it is a new value, the old value of @a nodes should not be used anymore. * If the new value is NULL, then the old array will have been freed by MeshLink. */ -extern struct meshlink_node **meshlink_get_all_nodes_by_dev_class(struct meshlink_handle *mesh, dev_class_t devclass, struct meshlink_node **nodes, size_t *nmemb) __attribute__((__warn_unused_result__)); +struct meshlink_node **meshlink_get_all_nodes_by_dev_class(struct meshlink_handle *mesh, dev_class_t devclass, struct meshlink_node **nodes, size_t *nmemb) __attribute__((__warn_unused_result__)); /// Get the list of all nodes by Submesh. /** This function returns a list with handles for all the nodes that matches with the given @a Submesh. @@ -713,7 +713,7 @@ extern struct meshlink_node **meshlink_get_all_nodes_by_dev_class(struct meshlin * If it is a new value, the old value of @a nodes should not be used anymore. * If the new value is NULL, then the old array will have been freed by MeshLink. */ -extern struct meshlink_node **meshlink_get_all_nodes_by_submesh(struct meshlink_handle *mesh, struct meshlink_submesh *submesh, struct meshlink_node **nodes, size_t *nmemb) __attribute__((__warn_unused_result__)); +struct meshlink_node **meshlink_get_all_nodes_by_submesh(struct meshlink_handle *mesh, struct meshlink_submesh *submesh, struct meshlink_node **nodes, size_t *nmemb) __attribute__((__warn_unused_result__)); /// Get the list of all nodes by time they were last reachable. /** This function returns a list with handles for all the nodes whose last known reachability time overlaps with the given time range. @@ -737,7 +737,7 @@ extern struct meshlink_node **meshlink_get_all_nodes_by_submesh(struct meshlink_ * If it is a new value, the old value of @a nodes should not be used anymore. * If the new value is NULL, then the old array will have been freed by MeshLink. */ -extern struct meshlink_node **meshlink_get_all_nodes_by_last_reachable(struct meshlink_handle *mesh, time_t start, time_t end, struct meshlink_node **nodes, size_t *nmemb) __attribute__((__warn_unused_result__)); +struct meshlink_node **meshlink_get_all_nodes_by_last_reachable(struct meshlink_handle *mesh, time_t start, time_t end, struct meshlink_node **nodes, size_t *nmemb) __attribute__((__warn_unused_result__)); /// Get the node's device class. /** This function returns the device class of the given node. @@ -748,7 +748,7 @@ extern struct meshlink_node **meshlink_get_all_nodes_by_last_reachable(struct me * * @return This function returns the device class of the @a node, or -1 in case of an error. */ -extern dev_class_t meshlink_get_node_dev_class(struct meshlink_handle *mesh, struct meshlink_node *node) __attribute__((__warn_unused_result__)); +dev_class_t meshlink_get_node_dev_class(struct meshlink_handle *mesh, struct meshlink_node *node) __attribute__((__warn_unused_result__)); /// Get the node's submesh handle. /** This function returns the submesh handle of the given node. @@ -759,7 +759,7 @@ extern dev_class_t meshlink_get_node_dev_class(struct meshlink_handle *mesh, str * * @return This function returns the submesh handle of the @a node, or NULL in case of an error. */ -extern struct meshlink_submesh *meshlink_get_node_submesh(struct meshlink_handle *mesh, struct meshlink_node *node) __attribute__((__warn_unused_result__)); +struct meshlink_submesh *meshlink_get_node_submesh(struct meshlink_handle *mesh, struct meshlink_node *node) __attribute__((__warn_unused_result__)); /// Get a node's reachability status. /** This function returns the current reachability of a given node, and the times of the last state changes. @@ -775,7 +775,7 @@ extern struct meshlink_submesh *meshlink_get_node_submesh(struct meshlink_handle * * @return This function returns true if the node is currently reachable, false otherwise. */ -extern bool meshlink_get_node_reachability(struct meshlink_handle *mesh, struct meshlink_node *node, time_t *last_reachable, time_t *last_unreachable); +bool meshlink_get_node_reachability(struct meshlink_handle *mesh, struct meshlink_node *node, time_t *last_reachable, time_t *last_unreachable); /// Verify the signature generated by another node of a piece of data. /** This function verifies the signature that another node generated for a piece of data. @@ -791,7 +791,7 @@ extern bool meshlink_get_node_reachability(struct meshlink_handle *mesh, struct * * @return This function returns true if the signature is valid, false otherwise. */ -extern bool meshlink_verify(struct meshlink_handle *mesh, struct meshlink_node *source, const void *data, size_t len, const void *signature, size_t siglen) __attribute__((__warn_unused_result__)); +bool meshlink_verify(struct meshlink_handle *mesh, struct meshlink_node *source, const void *data, size_t len, const void *signature, size_t siglen) __attribute__((__warn_unused_result__)); /// Set the canonical Address for a node. /** This function sets the canonical Address for a node. @@ -811,7 +811,7 @@ extern bool meshlink_verify(struct meshlink_handle *mesh, struct meshlink_node * * * @return This function returns true if the address was added, false otherwise. */ -extern bool meshlink_set_canonical_address(struct meshlink_handle *mesh, struct meshlink_node *node, const char *address, const char *port) __attribute__((__warn_unused_result__)); +bool meshlink_set_canonical_address(struct meshlink_handle *mesh, struct meshlink_node *node, const char *address, const char *port) __attribute__((__warn_unused_result__)); /// Add an invitation address for the local node. /** This function adds an address for the local node, which will be used only for invitation URLs. @@ -822,11 +822,11 @@ extern bool meshlink_set_canonical_address(struct meshlink_handle *mesh, struct * @param mesh A handle which represents an instance of MeshLink. * @param address A nul-terminated C string containing the address, which can be either in numeric format or a hostname. * @param port A nul-terminated C string containing the port, which can be either in numeric or symbolic format. - * If it is NULL, the listening port's number will be used. + * If it is NULL, the current listening port's number will be used. * * @return This function returns true if the address was added, false otherwise. */ -extern bool meshlink_add_invitation_address(struct meshlink_handle *mesh, const char *address, const char *port) __attribute__((__warn_unused_result__)); +bool meshlink_add_invitation_address(struct meshlink_handle *mesh, const char *address, const char *port) __attribute__((__warn_unused_result__)); /// Clears all invitation address for the local node. /** This function removes all addresses added with meshlink_add_invitation_address(). @@ -834,7 +834,7 @@ extern bool meshlink_add_invitation_address(struct meshlink_handle *mesh, const * \memberof meshlink_handle * @param mesh A handle which represents an instance of MeshLink. */ -extern void meshlink_clear_invitation_addresses(struct meshlink_handle *mesh); +void meshlink_clear_invitation_addresses(struct meshlink_handle *mesh); /// Add an Address for the local node. /** This function adds an Address for the local node, which will be used for invitation URLs. @@ -846,7 +846,7 @@ extern void meshlink_clear_invitation_addresses(struct meshlink_handle *mesh); * * @return This function returns true if the address was added, false otherwise. */ -extern bool meshlink_add_address(struct meshlink_handle *mesh, const char *address) __attribute__((__warn_unused_result__, __deprecated__("use meshlink_set_canonical_address() and/or meshlink_add_invitation_address() instead"))); +bool meshlink_add_address(struct meshlink_handle *mesh, const char *address) __attribute__((__warn_unused_result__, __deprecated__("use meshlink_set_canonical_address() and/or meshlink_add_invitation_address() instead"))); /// Try to discover the external address for the local node. /** This function performs tries to discover the local node's external address @@ -870,7 +870,7 @@ extern bool meshlink_add_address(struct meshlink_handle *mesh, const char *addre * or NULL if there was an error looking up the address. * After meshlink_get_external_address() returns, the application is free to overwrite or free this string. */ -extern char *meshlink_get_external_address(struct meshlink_handle *mesh) __attribute__((__warn_unused_result__)); +char *meshlink_get_external_address(struct meshlink_handle *mesh) __attribute__((__warn_unused_result__)); /// Try to discover the external address for the local node. /** This function performs tries to discover the local node's external address @@ -896,7 +896,7 @@ extern char *meshlink_get_external_address(struct meshlink_handle *mesh) __attri * or NULL if there was an error looking up the address. * After meshlink_get_external_address_for_family() returns, the application is free to overwrite or free this string. */ -extern char *meshlink_get_external_address_for_family(struct meshlink_handle *mesh, int address_family) __attribute__((__warn_unused_result__)); +char *meshlink_get_external_address_for_family(struct meshlink_handle *mesh, int address_family) __attribute__((__warn_unused_result__)); /// Try to discover the local address for the local node. /** This function performs tries to discover the address of the local interface used for outgoing connection. @@ -919,7 +919,7 @@ extern char *meshlink_get_external_address_for_family(struct meshlink_handle *me * or NULL if there was an error looking up the address. * After meshlink_get_local_address_for_family() returns, the application is free to overwrite or free this string. */ -extern char *meshlink_get_local_address_for_family(struct meshlink_handle *mesh, int address_family) __attribute__((__warn_unused_result__)); +char *meshlink_get_local_address_for_family(struct meshlink_handle *mesh, int address_family) __attribute__((__warn_unused_result__)); /// Try to discover the external address for the local node, and add it to its list of addresses. /** This function is equivalent to: @@ -933,7 +933,7 @@ extern char *meshlink_get_local_address_for_family(struct meshlink_handle *mesh, * * @return This function returns true if the address was added, false otherwise. */ -extern bool meshlink_add_external_address(struct meshlink_handle *mesh) __attribute__((__warn_unused_result__)); +bool meshlink_add_external_address(struct meshlink_handle *mesh) __attribute__((__warn_unused_result__)); /// Get the network port used by the local node. /** This function returns the network port that the local node is listening on. @@ -943,7 +943,7 @@ extern bool meshlink_add_external_address(struct meshlink_handle *mesh) __attrib * * @return This function returns the port number, or -1 in case of an error. */ -extern int meshlink_get_port(struct meshlink_handle *mesh) __attribute__((__warn_unused_result__)); +int meshlink_get_port(struct meshlink_handle *mesh) __attribute__((__warn_unused_result__)); /// Set the network port used by the local node. /** This function sets the network port that the local node is listening on. @@ -953,6 +953,9 @@ extern int meshlink_get_port(struct meshlink_handle *mesh) __attribute__((__warn * that the other nodes may no longer be able to initiate connections to the local node, * since they will try to connect to the previously configured port. * + * Note that if a canonical address has been set for the local node, + * you might need to call meshlink_set_canonical_address() again to ensure it includes the new port number. + * * \memberof meshlink_handle * @param mesh A handle which represents an instance of MeshLink. * @param port The port number to listen on. This must be between 0 and 65535. @@ -964,7 +967,7 @@ extern int meshlink_get_port(struct meshlink_handle *mesh) __attribute__((__warn * is no guarantee that MeshLink is listening on the old port. */ -extern bool meshlink_set_port(struct meshlink_handle *mesh, int port) __attribute__((__warn_unused_result__)); +bool meshlink_set_port(struct meshlink_handle *mesh, int port) __attribute__((__warn_unused_result__)); /// Set the timeout for invitations. /** This function sets the timeout for invitations. @@ -975,7 +978,7 @@ extern bool meshlink_set_port(struct meshlink_handle *mesh, int port) __attribut * @param mesh A handle which represents an instance of MeshLink. * @param timeout The timeout for invitations in seconds. */ -extern void meshlink_set_invitation_timeout(struct meshlink_handle *mesh, int timeout); +void meshlink_set_invitation_timeout(struct meshlink_handle *mesh, int timeout); /// Invite another node into the mesh. /** This function generates an invitation that can be used by another node to join the same mesh as the local node. @@ -993,7 +996,7 @@ extern void meshlink_set_invitation_timeout(struct meshlink_handle *mesh, int ti * @return This function returns a nul-terminated C string that contains the invitation URL, or NULL in case of an error. * The application should call free() after it has finished using the URL. */ -extern char *meshlink_invite_ex(struct meshlink_handle *mesh, struct meshlink_submesh *submesh, const char *name, uint32_t flags) __attribute__((__warn_unused_result__)); +char *meshlink_invite_ex(struct meshlink_handle *mesh, struct meshlink_submesh *submesh, const char *name, uint32_t flags) __attribute__((__warn_unused_result__)); /// Invite another node into the mesh. /** This function generates an invitation that can be used by another node to join the same mesh as the local node. @@ -1012,7 +1015,7 @@ extern char *meshlink_invite_ex(struct meshlink_handle *mesh, struct meshlink_su * @return This function returns a nul-terminated C string that contains the invitation URL, or NULL in case of an error. * The application should call free() after it has finished using the URL. */ -extern char *meshlink_invite(struct meshlink_handle *mesh, struct meshlink_submesh *submesh, const char *name) __attribute__((__warn_unused_result__)); +char *meshlink_invite(struct meshlink_handle *mesh, struct meshlink_submesh *submesh, const char *name) __attribute__((__warn_unused_result__)); /// Use an invitation to join a mesh. /** This function allows the local node to join an existing mesh using an invitation URL generated by another node. @@ -1032,7 +1035,7 @@ extern char *meshlink_invite(struct meshlink_handle *mesh, struct meshlink_subme * * @return This function returns true if the local node joined the mesh it was invited to, false otherwise. */ -extern bool meshlink_join(struct meshlink_handle *mesh, const char *invitation) __attribute__((__warn_unused_result__)); +bool meshlink_join(struct meshlink_handle *mesh, const char *invitation) __attribute__((__warn_unused_result__)); /// Export the local node's key and addresses. /** This function generates a string that contains the local node's public key and one or more IP addresses. @@ -1048,7 +1051,7 @@ extern bool meshlink_join(struct meshlink_handle *mesh, const char *invitation) * @return This function returns a nul-terminated C string that contains the exported key and addresses, or NULL in case of an error. * The application should call free() after it has finished using this string. */ -extern char *meshlink_export(struct meshlink_handle *mesh) __attribute__((__warn_unused_result__)); +char *meshlink_export(struct meshlink_handle *mesh) __attribute__((__warn_unused_result__)); /// Import another node's key and addresses. /** This function accepts a string containing the exported public key and addresses of another node. @@ -1064,7 +1067,7 @@ extern char *meshlink_export(struct meshlink_handle *mesh) __attribute__((__warn * * @return This function returns true if the data was valid and the other node has been granted access to the mesh, false otherwise. */ -extern bool meshlink_import(struct meshlink_handle *mesh, const char *data) __attribute__((__warn_unused_result__)); +bool meshlink_import(struct meshlink_handle *mesh, const char *data) __attribute__((__warn_unused_result__)); /// Forget any information about a node. /** This function allows the local node to forget any information it has about a node, @@ -1086,7 +1089,7 @@ extern bool meshlink_import(struct meshlink_handle *mesh, const char *data) __at * * @return This function returns true if all currently known data about the node has been forgotten, false otherwise. */ -extern bool meshlink_forget_node(struct meshlink_handle *mesh, struct meshlink_node *node); +bool meshlink_forget_node(struct meshlink_handle *mesh, struct meshlink_node *node); /// Blacklist a node from the mesh. /** This function causes the local node to blacklist another node. @@ -1099,7 +1102,7 @@ extern bool meshlink_forget_node(struct meshlink_handle *mesh, struct meshlink_n * * @return This function returns true if the node has been blacklisted, false otherwise. */ -extern bool meshlink_blacklist(struct meshlink_handle *mesh, struct meshlink_node *node) __attribute__((__warn_unused_result__)); +bool meshlink_blacklist(struct meshlink_handle *mesh, struct meshlink_node *node) __attribute__((__warn_unused_result__)); /// Blacklist a node from the mesh by name. /** This function causes the local node to blacklist another node by name. @@ -1114,7 +1117,7 @@ extern bool meshlink_blacklist(struct meshlink_handle *mesh, struct meshlink_nod * * @return This function returns true if the node has been blacklisted, false otherwise. */ -extern bool meshlink_blacklist_by_name(struct meshlink_handle *mesh, const char *name) __attribute__((__warn_unused_result__)); +bool meshlink_blacklist_by_name(struct meshlink_handle *mesh, const char *name) __attribute__((__warn_unused_result__)); /// Whitelist a node on the mesh. /** This function causes the local node to whitelist a previously blacklisted node. @@ -1127,7 +1130,7 @@ extern bool meshlink_blacklist_by_name(struct meshlink_handle *mesh, const char * * @return This function returns true if the node has been whitelisted, false otherwise. */ -extern bool meshlink_whitelist(struct meshlink_handle *mesh, struct meshlink_node *node) __attribute__((__warn_unused_result__)); +bool meshlink_whitelist(struct meshlink_handle *mesh, struct meshlink_node *node) __attribute__((__warn_unused_result__)); /// Whitelist a node on the mesh by name. /** This function causes the local node to whitelist a node by name. @@ -1143,7 +1146,7 @@ extern bool meshlink_whitelist(struct meshlink_handle *mesh, struct meshlink_nod * * @return This function returns true if the node has been whitelisted, false otherwise. */ -extern bool meshlink_whitelist_by_name(struct meshlink_handle *mesh, const char *name) __attribute__((__warn_unused_result__)); +bool meshlink_whitelist_by_name(struct meshlink_handle *mesh, const char *name) __attribute__((__warn_unused_result__)); /// Set whether new nodes are blacklisted by default. /** This function sets the blacklist behaviour for newly discovered nodes. @@ -1156,11 +1159,27 @@ extern bool meshlink_whitelist_by_name(struct meshlink_handle *mesh, const char * @param mesh A handle which represents an instance of MeshLink. * @param blacklist True if new nodes are to be blacklisted, false if whitelisted. */ -extern void meshlink_set_default_blacklist(struct meshlink_handle *mesh, bool blacklist); +void meshlink_set_default_blacklist(struct meshlink_handle *mesh, bool blacklist); -/// A callback for accepting incoming channels. +/// A callback for listening for incoming channels. /** This function is called whenever a remote node wants to open a channel to the local node. - * The application then has to decide whether to accept or reject this channel. + * This callback should only make a decision whether to accept or reject this channel. + * The accept callback should be set to get a handle to the actual channel. + * + * The callback is run in MeshLink's own thread. + * It is therefore important that the callback return quickly and uses apprioriate methods (queues, pipes, locking, etc.) + * to hand any data over to the application's thread. + * + * @param mesh A handle which represents an instance of MeshLink. + * @param node A handle for the node that wants to open a channel. + * @param port The port number the peer wishes to connect to. + * + * @return This function should return true if the application accepts the incoming channel, false otherwise. + */ +typedef bool (*meshlink_channel_listen_cb_t)(struct meshlink_handle *mesh, struct meshlink_node *node, uint16_t port); + +/// A callback for accepting incoming channels. +/** This function is called whenever a remote node has opened a channel to the local node. * * The callback is run in MeshLink's own thread. * It is therefore important that the callback return quickly and uses apprioriate methods (queues, pipes, locking, etc.) @@ -1210,21 +1229,37 @@ typedef void (*meshlink_channel_receive_cb_t)(struct meshlink_handle *mesh, stru */ typedef void (*meshlink_channel_poll_cb_t)(struct meshlink_handle *mesh, struct meshlink_channel *channel, size_t len); +/// Set the listen callback. +/** This functions sets the callback that is called whenever another node wants to open a channel to the local node. + * The callback is run in MeshLink's own thread. + * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.) + * to hand the data over to the application's thread. + * The callback should also not block itself and return as quickly as possible. + * + * If no listen or accept callbacks are set, incoming channels are rejected. + * + * \memberof meshlink_handle + * @param mesh A handle which represents an instance of MeshLink. + * @param cb A pointer to the function which will be called when another node want to open a channel. + * If a NULL pointer is given, the callback will be disabled. + */ +void meshlink_set_channel_listen_cb(struct meshlink_handle *mesh, meshlink_channel_listen_cb_t cb); + /// Set the accept callback. -/** This functions sets the callback that is called whenever another node sends data to the local node. +/** This functions sets the callback that is called whenever a remote node has opened a channel to the local node. * The callback is run in MeshLink's own thread. * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.) * to hand the data over to the application's thread. * The callback should also not block itself and return as quickly as possible. * - * If no accept callback is set, incoming channels are rejected. + * If no listen or accept callbacks are set, incoming channels are rejected. * * \memberof meshlink_handle * @param mesh A handle which represents an instance of MeshLink. - * @param cb A pointer to the function which will be called when another node sends data to the local node. + * @param cb A pointer to the function which will be called when a new channel has been opened by a remote node. * If a NULL pointer is given, the callback will be disabled. */ -extern void meshlink_set_channel_accept_cb(struct meshlink_handle *mesh, meshlink_channel_accept_cb_t cb); +void meshlink_set_channel_accept_cb(struct meshlink_handle *mesh, meshlink_channel_accept_cb_t cb); /// Set the receive callback. /** This functions sets the callback that is called whenever another node sends data to the local node. @@ -1239,7 +1274,7 @@ extern void meshlink_set_channel_accept_cb(struct meshlink_handle *mesh, meshlin * @param cb A pointer to the function which will be called when another node sends data to the local node. * If a NULL pointer is given, the callback will be disabled and incoming data is ignored. */ -extern void meshlink_set_channel_receive_cb(struct meshlink_handle *mesh, struct meshlink_channel *channel, meshlink_channel_receive_cb_t cb); +void meshlink_set_channel_receive_cb(struct meshlink_handle *mesh, struct meshlink_channel *channel, meshlink_channel_receive_cb_t cb); /// Set the poll callback. /** This functions sets the callback that is called whenever data can be sent to another node. @@ -1254,7 +1289,7 @@ extern void meshlink_set_channel_receive_cb(struct meshlink_handle *mesh, struct * @param cb A pointer to the function which will be called when data can be sent to another node. * If a NULL pointer is given, the callback will be disabled. */ -extern void meshlink_set_channel_poll_cb(struct meshlink_handle *mesh, struct meshlink_channel *channel, meshlink_channel_poll_cb_t cb); +void meshlink_set_channel_poll_cb(struct meshlink_handle *mesh, struct meshlink_channel *channel, meshlink_channel_poll_cb_t cb); /// Set the send buffer size of a channel. /** This function sets the desired size of the send buffer. @@ -1266,7 +1301,7 @@ extern void meshlink_set_channel_poll_cb(struct meshlink_handle *mesh, struct me * @param size The desired size for the send buffer. * If a NULL pointer is given, the callback will be disabled. */ -extern void meshlink_set_channel_sndbuf(struct meshlink_handle *mesh, struct meshlink_channel *channel, size_t size); +void meshlink_set_channel_sndbuf(struct meshlink_handle *mesh, struct meshlink_channel *channel, size_t size); /// Set the receive buffer size of a channel. /** This function sets the desired size of the receive buffer. @@ -1278,7 +1313,7 @@ extern void meshlink_set_channel_sndbuf(struct meshlink_handle *mesh, struct mes * @param size The desired size for the send buffer. * If a NULL pointer is given, the callback will be disabled. */ -extern void meshlink_set_channel_rcvbuf(struct meshlink_handle *mesh, struct meshlink_channel *channel, size_t size); +void meshlink_set_channel_rcvbuf(struct meshlink_handle *mesh, struct meshlink_channel *channel, size_t size); /// Open a reliable stream channel to another node. /** This function is called whenever a remote node wants to open a channel to the local node. @@ -1303,7 +1338,7 @@ extern void meshlink_set_channel_rcvbuf(struct meshlink_handle *mesh, struct mes * @return A handle for the channel, or NULL in case of an error. * The handle is valid until meshlink_channel_close() is called. */ -extern struct meshlink_channel *meshlink_channel_open_ex(struct meshlink_handle *mesh, struct meshlink_node *node, uint16_t port, meshlink_channel_receive_cb_t cb, const void *data, size_t len, uint32_t flags) __attribute__((__warn_unused_result__)); +struct meshlink_channel *meshlink_channel_open_ex(struct meshlink_handle *mesh, struct meshlink_node *node, uint16_t port, meshlink_channel_receive_cb_t cb, const void *data, size_t len, uint32_t flags) __attribute__((__warn_unused_result__)); /// Open a reliable stream channel to another node. /** This function is called whenever a remote node wants to open a channel to the local node. @@ -1330,7 +1365,7 @@ extern struct meshlink_channel *meshlink_channel_open_ex(struct meshlink_handle * @return A handle for the channel, or NULL in case of an error. * The handle is valid until meshlink_channel_close() is called. */ -extern struct meshlink_channel *meshlink_channel_open(struct meshlink_handle *mesh, struct meshlink_node *node, uint16_t port, meshlink_channel_receive_cb_t cb, const void *data, size_t len) __attribute__((__warn_unused_result__)); +struct meshlink_channel *meshlink_channel_open(struct meshlink_handle *mesh, struct meshlink_node *node, uint16_t port, meshlink_channel_receive_cb_t cb, const void *data, size_t len) __attribute__((__warn_unused_result__)); /// Partially close a reliable stream channel. /** This shuts down the read or write side of a channel, or both, without closing the handle. @@ -1344,7 +1379,7 @@ extern struct meshlink_channel *meshlink_channel_open(struct meshlink_handle *me * @param channel A handle for the channel. * @param direction Must be one of SHUT_RD, SHUT_WR or SHUT_RDWR, otherwise this call will not have any affect. */ -extern void meshlink_channel_shutdown(struct meshlink_handle *mesh, struct meshlink_channel *channel, int direction); +void meshlink_channel_shutdown(struct meshlink_handle *mesh, struct meshlink_channel *channel, int direction); /// Close a reliable stream channel. /** This informs the remote node that the local node has finished sending all data on the channel. @@ -1359,7 +1394,7 @@ extern void meshlink_channel_shutdown(struct meshlink_handle *mesh, struct meshl * @param mesh A handle which represents an instance of MeshLink. * @param channel A handle for the channel. */ -extern void meshlink_channel_close(struct meshlink_handle *mesh, struct meshlink_channel *channel); +void meshlink_channel_close(struct meshlink_handle *mesh, struct meshlink_channel *channel); /// Transmit data on a channel /** This queues data to send to the remote node. @@ -1375,7 +1410,7 @@ extern void meshlink_channel_close(struct meshlink_handle *mesh, struct meshlink * If MESHLINK_CHANNEL_NO_PARTIAL is set, then the result will either be len, * 0 if the buffer is currently too full, or -1 if len is too big even for an empty buffer. */ -extern ssize_t meshlink_channel_send(struct meshlink_handle *mesh, struct meshlink_channel *channel, const void *data, size_t len) __attribute__((__warn_unused_result__)); +ssize_t meshlink_channel_send(struct meshlink_handle *mesh, struct meshlink_channel *channel, const void *data, size_t len) __attribute__((__warn_unused_result__)); /// A callback for cleaning up buffers submitted for asynchronous I/O. /** This callbacks signals that MeshLink has finished using this buffer. @@ -1417,7 +1452,7 @@ typedef void (*meshlink_aio_fd_cb_t)(struct meshlink_handle *mesh, struct meshli * * @return True if the buffer was enqueued, false otherwise. */ -extern bool meshlink_channel_aio_send(struct meshlink_handle *mesh, struct meshlink_channel *channel, const void *data, size_t len, meshlink_aio_cb_t cb, void *priv) __attribute__((__warn_unused_result__)); +bool meshlink_channel_aio_send(struct meshlink_handle *mesh, struct meshlink_channel *channel, const void *data, size_t len, meshlink_aio_cb_t cb, void *priv) __attribute__((__warn_unused_result__)); /// Transmit data on a channel asynchronously from a filedescriptor /** This will read up to the specified length number of bytes from the given filedescriptor, and send it over the channel. @@ -1434,7 +1469,7 @@ extern bool meshlink_channel_aio_send(struct meshlink_handle *mesh, struct meshl * * @return True if the buffer was enqueued, false otherwise. */ -extern bool meshlink_channel_aio_fd_send(struct meshlink_handle *mesh, struct meshlink_channel *channel, int fd, size_t len, meshlink_aio_fd_cb_t cb, void *priv) __attribute__((__warn_unused_result__)); +bool meshlink_channel_aio_fd_send(struct meshlink_handle *mesh, struct meshlink_channel *channel, int fd, size_t len, meshlink_aio_fd_cb_t cb, void *priv) __attribute__((__warn_unused_result__)); /// Receive data on a channel asynchronously /** This registers a buffer that will be filled with incoming channel data. @@ -1453,7 +1488,7 @@ extern bool meshlink_channel_aio_fd_send(struct meshlink_handle *mesh, struct me * * @return True if the buffer was enqueued, false otherwise. */ -extern bool meshlink_channel_aio_receive(struct meshlink_handle *mesh, struct meshlink_channel *channel, const void *data, size_t len, meshlink_aio_cb_t cb, void *priv) __attribute__((__warn_unused_result__)); +bool meshlink_channel_aio_receive(struct meshlink_handle *mesh, struct meshlink_channel *channel, const void *data, size_t len, meshlink_aio_cb_t cb, void *priv) __attribute__((__warn_unused_result__)); /// Receive data on a channel asynchronously and send it to a filedescriptor /** This will read up to the specified length number of bytes from the channel, and send it to the filedescriptor. @@ -1470,7 +1505,7 @@ extern bool meshlink_channel_aio_receive(struct meshlink_handle *mesh, struct me * * @return True if the buffer was enqueued, false otherwise. */ -extern bool meshlink_channel_aio_fd_receive(struct meshlink_handle *mesh, struct meshlink_channel *channel, int fd, size_t len, meshlink_aio_fd_cb_t cb, void *priv) __attribute__((__warn_unused_result__)); +bool meshlink_channel_aio_fd_receive(struct meshlink_handle *mesh, struct meshlink_channel *channel, int fd, size_t len, meshlink_aio_fd_cb_t cb, void *priv) __attribute__((__warn_unused_result__)); /// Get channel flags. /** This returns the flags used when opening this channel. @@ -1481,7 +1516,7 @@ extern bool meshlink_channel_aio_fd_receive(struct meshlink_handle *mesh, struct * * @return The flags set for this channel. */ -extern uint32_t meshlink_channel_get_flags(struct meshlink_handle *mesh, struct meshlink_channel *channel) __attribute__((__warn_unused_result__)); +uint32_t meshlink_channel_get_flags(struct meshlink_handle *mesh, struct meshlink_channel *channel) __attribute__((__warn_unused_result__)); /// Get the amount of bytes in the send buffer. /** This returns the amount of bytes in the send buffer. @@ -1493,7 +1528,7 @@ extern uint32_t meshlink_channel_get_flags(struct meshlink_handle *mesh, struct * * @return The amount of un-ACKed bytes in the send buffer. */ -extern size_t meshlink_channel_get_sendq(struct meshlink_handle *mesh, struct meshlink_channel *channel) __attribute__((__warn_unused_result__)); +size_t meshlink_channel_get_sendq(struct meshlink_handle *mesh, struct meshlink_channel *channel) __attribute__((__warn_unused_result__)); /// Get the amount of bytes in the receive buffer. /** This returns the amount of bytes in the receive buffer. @@ -1505,7 +1540,7 @@ extern size_t meshlink_channel_get_sendq(struct meshlink_handle *mesh, struct me * * @return The amount of bytes in the receive buffer. */ -extern size_t meshlink_channel_get_recvq(struct meshlink_handle *mesh, struct meshlink_channel *channel) __attribute__((__warn_unused_result__)); +size_t meshlink_channel_get_recvq(struct meshlink_handle *mesh, struct meshlink_channel *channel) __attribute__((__warn_unused_result__)); /// Get the maximum segment size of a channel. /** This returns the amount of bytes that can be sent at once for channels with UDP semantics. @@ -1516,7 +1551,7 @@ extern size_t meshlink_channel_get_recvq(struct meshlink_handle *mesh, struct me * * @return The amount of bytes in the receive buffer. */ -extern size_t meshlink_channel_get_mss(struct meshlink_handle *mesh, struct meshlink_channel *channel) __attribute__((__warn_unused_result__)); +size_t meshlink_channel_get_mss(struct meshlink_handle *mesh, struct meshlink_channel *channel) __attribute__((__warn_unused_result__)); /// Set the connection timeout used for channels to the given node. /** This sets the timeout after which unresponsive channels will be reported as closed. @@ -1528,7 +1563,7 @@ extern size_t meshlink_channel_get_mss(struct meshlink_handle *mesh, struct mesh * @param timeout The timeout in seconds after which unresponsive channels will be reported as closed. * The default is 60 seconds. */ -extern void meshlink_set_node_channel_timeout(struct meshlink_handle *mesh, struct meshlink_node *node, int timeout); +void meshlink_set_node_channel_timeout(struct meshlink_handle *mesh, struct meshlink_node *node, int timeout); /// Hint that a hostname may be found at an address /** This function indicates to meshlink that the given hostname is likely found @@ -1541,7 +1576,7 @@ extern void meshlink_set_node_channel_timeout(struct meshlink_handle *mesh, stru * given hostname. The caller is free to overwrite or free * this memory once meshlink returns. */ -extern void meshlink_hint_address(struct meshlink_handle *mesh, struct meshlink_node *node, const struct sockaddr *addr); +void meshlink_hint_address(struct meshlink_handle *mesh, struct meshlink_node *node, const struct sockaddr *addr); /// Enable or disable zeroconf discovery of local peers /** This controls whether zeroconf discovery using the Catta library will be @@ -1551,7 +1586,7 @@ extern void meshlink_hint_address(struct meshlink_handle *mesh, struct meshlink_ * @param mesh A handle which represents an instance of MeshLink. * @param enable Set to true to enable discovery, false to disable. */ -extern void meshlink_enable_discovery(struct meshlink_handle *mesh, bool enable); +void meshlink_enable_discovery(struct meshlink_handle *mesh, bool enable); /// Performs key rotation for an encrypted storage /** This rotates the (master) key for an encrypted storage and discards the old key @@ -1564,7 +1599,7 @@ extern void meshlink_enable_discovery(struct meshlink_handle *mesh, bool enable) * * @return This function returns true if the key rotation for the encrypted storage succeeds, false otherwise. */ -extern bool meshlink_encrypted_key_rotate(struct meshlink_handle *mesh, const void *key, size_t keylen) __attribute__((__warn_unused_result__)); +bool meshlink_encrypted_key_rotate(struct meshlink_handle *mesh, const void *key, size_t keylen) __attribute__((__warn_unused_result__)); /// Set device class timeouts /** This sets the ping interval and timeout for a given device class. @@ -1576,7 +1611,7 @@ extern bool meshlink_encrypted_key_rotate(struct meshlink_handle *mesh, const vo * @param pingtimeout The required time within which a peer should respond, in seconds. The default is 5. * The timeout must be smaller than the interval. */ -extern void meshlink_set_dev_class_timeouts(struct meshlink_handle *mesh, dev_class_t devclass, int pinginterval, int pingtimeout); +void meshlink_set_dev_class_timeouts(struct meshlink_handle *mesh, dev_class_t devclass, int pinginterval, int pingtimeout); /// Set device class fast retry period /** This sets the fast retry period for a given device class. @@ -1587,7 +1622,26 @@ extern void meshlink_set_dev_class_timeouts(struct meshlink_handle *mesh, dev_cl * @param devclass The device class to update * @param fast_retry_period The period during which fast connection retries are done. The default is 0. */ -extern void meshlink_set_dev_class_fast_retry_period(struct meshlink_handle *mesh, dev_class_t devclass, int fast_retry_period); +void meshlink_set_dev_class_fast_retry_period(struct meshlink_handle *mesh, dev_class_t devclass, int fast_retry_period); + +/// Set device class maximum timeout +/** This sets the maximum timeout for outgoing connection retries for a given device class. + * + * \memberof meshlink_handle + * @param mesh A handle which represents an instance of MeshLink. + * @param devclass The device class to update + * @param maxtimeout The maximum timeout between reconnection attempts, in seconds. The default is 900. + */ +void meshlink_set_dev_class_maxtimeout(struct meshlink_handle *mesh, dev_class_t devclass, int maxtimeout); + +/// Reset all connection timers +/** This resets all timers related to connections, causing pending outgoing connections to be retried immediately. + * It also sends keepalive packets on all active connections immediately. + * + * \memberof meshlink_handle + * @param mesh A handle which represents an instance of MeshLink. + */ +void meshlink_reset_timers(struct meshlink_handle *mesh); /// Set which order invitations are committed /** This determines in which order configuration files are written to disk during an invitation. @@ -1598,7 +1652,7 @@ extern void meshlink_set_dev_class_fast_retry_period(struct meshlink_handle *mes * @param mesh A handle which represents an instance of MeshLink. * @param inviter_commits_first If true, then the node that invited a peer will commit data to disk first. */ -extern void meshlink_set_inviter_commits_first(struct meshlink_handle *mesh, bool inviter_commits_first); +void meshlink_set_inviter_commits_first(struct meshlink_handle *mesh, bool inviter_commits_first); /// Set the URL used to discover the host's external address /** For generating invitation URLs, MeshLink can look up the externally visible address of the local node. @@ -1609,7 +1663,7 @@ extern void meshlink_set_inviter_commits_first(struct meshlink_handle *mesh, boo * @param mesh A handle which represents an instance of MeshLink. * @param url The URL to use for external address queries, or NULL to revert back to the default URL. */ -extern void meshlink_set_external_address_discovery_url(struct meshlink_handle *mesh, const char *url); +void meshlink_set_external_address_discovery_url(struct meshlink_handle *mesh, const char *url); /// Set the scheduling granularity of the application /** This should be set to the effective scheduling granularity for the application. @@ -1621,7 +1675,7 @@ extern void meshlink_set_external_address_discovery_url(struct meshlink_handle * * @param mesh A handle which represents an instance of MeshLink. * @param granularity The scheduling granularity of the application in microseconds. */ -extern void meshlink_set_scheduling_granularity(struct meshlink_handle *mesh, long granularity); +void meshlink_set_scheduling_granularity(struct meshlink_handle *mesh, long granularity); #ifdef __cplusplus }