Add support for black/whitelisting by name, and forgetting nodes.

[meshlink] / src / meshlink++.h

diff --git a/src/meshlink++.h b/src/meshlink++.h
index 980e5b12c5d4591da998015105c5ee4bb6dae5cd..74ec06e5a5bd37f80f8e9af866be525dd183cf2e 100644 (file)
--- a/src/meshlink++.h
+++ b/src/meshlink++.h
@@ -658,6 +658,29 @@ 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,
@@ -671,6 +694,21 @@ public:
                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,
@@ -684,6 +722,23 @@ public:
                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.