X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=src%2Fmeshlink%2B%2B.h;h=3599cc55f44c7b59a64f66eab4aece32479ba6ff;hb=529b8fab8c21e7ae5af91d742ff202eab38e51f3;hp=6b9c685528bf4015e34e7995cc55cec5159a01e8;hpb=23af52a05391e8083e7211358021bac94e5e0103;p=meshlink diff --git a/src/meshlink++.h b/src/meshlink++.h index 6b9c6855..3599cc55 100644 --- a/src/meshlink++.h +++ b/src/meshlink++.h @@ -259,6 +259,12 @@ public: (void)message; } + /// This functions is called whenever MeshLink has encountered a serious error. + virtual void error(meshlink_errno_t meshlink_errno) { + /* do nothing */ + (void)meshlink_errno; + } + /// This functions is called whenever MeshLink a meta-connection attempt is made. virtual void connection_try(node *peer) { /* do nothing */ @@ -339,6 +345,7 @@ public: meshlink_set_node_pmtu_cb(handle, &node_pmtu_trampoline); meshlink_set_node_duplicate_cb(handle, &node_duplicate_trampoline); meshlink_set_log_cb(handle, MESHLINK_DEBUG, &log_trampoline); + meshlink_set_error_cb(handle, &error_trampoline); meshlink_set_channel_accept_cb(handle, &channel_accept_trampoline); meshlink_set_connection_try_cb(handle, &connection_try_trampoline); return meshlink_start(handle); @@ -651,17 +658,87 @@ public: return meshlink_import(handle, data); } + /// Forget any information about a node. + /** This function allows the local node to forget any information it has about a node, + * and if possible will remove any data it has stored on disk about the node. + * + * Any open channels to this node must be closed before calling this function. + * + * After this call returns, the node handle is invalid and may no longer be used, regardless + * of the return value of this call. + * + * Note that this function does not prevent MeshLink from actually forgetting about a node, + * or re-learning information about a node at a later point in time. It is merely a hint that + * the application does not care about this node anymore and that any resources kept could be + * cleaned up. + * + * \memberof meshlink_node + * @param node A pointer to a struct meshlink_node describing the node to be forgotten. + * + * @return This function returns true if all currently known data about the node has been forgotten, false otherwise. + */ + bool forget_node(node *node) { + return meshlink_forget_node(handle, node); + } + /// Blacklist a node from the mesh. /** This function causes the local node to blacklist another node. * The local node will drop any existing connections to that node, * and will not send data to it nor accept any data received from it any more. * * @param node A pointer to a meshlink::node describing the node to be blacklisted. + * + * @return This function returns true if the node has been whitelisted, false otherwise. */ - void blacklist(node *node) { + bool blacklist(node *node) { return meshlink_blacklist(handle, node); } + /// Blacklist a node from the mesh by name. + /** This function causes the local node to blacklist another node by name. + * The local node will drop any existing connections to that node, + * and will not send data to it nor accept any data received from it any more. + * + * If no node by the given name is known, it is created. + * + * @param name The name of the node to blacklist. + * + * @return This function returns true if the node has been blacklisted, false otherwise. + */ + bool blacklist_by_name(const char *name) { + return meshlink_blacklist_by_name(handle, name); + } + + /// Whitelist a node on the mesh. + /** This function causes the local node to whitelist another node. + * The local node will allow connections to and from that node, + * and will send data to it and accept any data received from it. + * + * @param node A pointer to a meshlink::node describing the node to be whitelisted. + * + * @return This function returns true if the node has been whitelisted, false otherwise. + */ + bool whitelist(node *node) { + return meshlink_whitelist(handle, node); + } + + /// Whitelist a node on the mesh by name. + /** This function causes the local node to whitelist a node by name. + * The local node will allow connections to and from that node, + * and will send data to it and accept any data received from it. + * + * If no node by the given name is known, it is created. + * This is useful if new nodes are blacklisted by default. + * + * \memberof meshlink_node + * @param node A pointer to a struct meshlink_node describing the node to be whitelisted. + * + * @return This function returns true if the node has been whitelisted, false otherwise. + */ + bool whitelist_by_name(const char *name) { + return meshlink_whitelist_by_name(handle, name); + } + /// Set the poll callback. /** This functions sets the callback that is called whenever data can be sent to another node. * The callback is run in MeshLink's own thread. @@ -701,6 +778,18 @@ public: meshlink_set_channel_rcvbuf(handle, channel, size); } + /// Set the connection timeout used for channels to the given node. + /** This sets the timeout after which unresponsive channels will be reported as closed. + * The timeout is set for all current and future channels to the given node. + * + * @param channel A handle for the channel. + * @param timeout The timeout in seconds after which unresponsive channels will be reported as closed. + * The default is 60 seconds. + */ + void set_node_channel_timeout(node *node, int timeout) { + meshlink_set_node_channel_timeout(handle, node, timeout); + } + /// 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. * The application then has to decide whether to accept or reject this channel. @@ -713,6 +802,7 @@ public: * @param cb A pointer to the function which will be called when the remote node sends data to the local node. * @param data A pointer to a buffer containing data to already queue for sending. * @param len The length of the data. + * If len is 0, the data pointer is copied into the channel's priv member. * @param flags A bitwise-or'd combination of flags that set the semantics for this channel. * * @return A handle for the channel, or NULL in case of an error. @@ -737,6 +827,7 @@ public: * @param port The port number the peer wishes to connect to. * @param data A pointer to a buffer containing data to already queue for sending. * @param len The length of the data. + * If len is 0, the data pointer is copied into the channel's priv member. * @param flags A bitwise-or'd combination of flags that set the semantics for this channel. * * @return A handle for the channel, or NULL in case of an error. @@ -796,6 +887,7 @@ public: * until the callback routine is called. * @param len The length of the data, or 0 if there is no data to send. * @param cb A pointer to the function which will be called when MeshLink has finished using the buffer. + * @param priv A private pointer which was set by the application when submitting the buffer. * * @return True if the buffer was enqueued, false otherwise. */ @@ -812,6 +904,7 @@ public: * @param fd A file descriptor from which data will be read. * @param len The length of the data, or 0 if there is no data to send. * @param cb A pointer to the function which will be called when MeshLink has finished using the filedescriptor. + * @param priv A private pointer which was set by the application when submitting the buffer. * * @return True if the buffer was enqueued, false otherwise. */ @@ -830,6 +923,7 @@ public: * until the callback routine is called. * @param len The length of the data. * @param cb A pointer to the function which will be called when MeshLink has finished using the buffer. + * @param priv A private pointer which was set by the application when submitting the buffer. * * @return True if the buffer was enqueued, false otherwise. */ @@ -846,6 +940,7 @@ public: * @param fd A file descriptor to which data will be written. * @param len The length of the data. * @param cb A pointer to the function which will be called when MeshLink has finished using the filedescriptor. + * @param priv A private pointer which was set by the application when submitting the buffer. * * @return True if the buffer was enqueued, false otherwise. */ @@ -895,7 +990,20 @@ public: * @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. */ - void set_dev_class_timeouts(dev_class_t devclass, int pinginterval, int pingtimeout); + void set_dev_class_timeouts(dev_class_t devclass, int pinginterval, int pingtimeout) { + meshlink_set_dev_class_timeouts(handle, devclass, pinginterval, pingtimeout); + } + + /// Set device class fast retry period + /** This sets the fast retry period for a given device class. + * During this period after the last time the mesh becomes unreachable, connections are tried once a second. + * + * @param devclass The device class to update + * @param fast_retry_period The period during which fast connection retries are done. The default is 0. + */ + void set_dev_class_fast_retry_period(dev_class_t devclass, int fast_retry_period) { + meshlink_set_dev_class_fast_retry_period(handle, devclass, fast_retry_period); + } private: // non-copyable: @@ -948,6 +1056,15 @@ private: that->log(level, message); } + static void error_trampoline(meshlink_handle_t *handle, meshlink_errno_t meshlink_errno) { + if(!(handle->priv)) { + return; + } + + meshlink::mesh *that = static_cast(handle->priv); + that->error(meshlink_errno); + } + static void connection_try_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer) { if(!(handle->priv)) { return;