]> git.meshlink.io Git - meshlink/blobdiff - src/meshlink++.h
Add meta-connection attempt callback feature
[meshlink] / src / meshlink++.h
index 312b42c81aa8bbd5a7ee4e2a1353f1e86fc2bfed..48eabf3fbf5fdf80cfb3586c6a5001e808a7e208 100644 (file)
@@ -43,6 +43,13 @@ typedef meshlink_errno_t errno_t;
  */
 typedef void (*receive_cb_t)(mesh *mesh, node *source, const void *data, size_t len);
 
+/// 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.
+ *  @param node      A pointer to a meshlink_node_t describing the node to whom meta-connection is being tried.
+ *                   This pointer is valid until meshlink_close() is called.
+ */
+typedef void (*connection_try_cb_t)(mesh *mesh, node *node);
+
 /// A callback reporting node status changes.
 /** @param mesh       A handle which represents an instance of MeshLink.
  *  @param node       A pointer to a meshlink::node describing the node whose status changed.
@@ -147,7 +154,7 @@ public:
         *  @param appname  The application name which will be used in the mesh.
         *  @param devclass The device class which will be used in the mesh.
         *
-        *  @return         This function will return a pointer to a meshlink::mesh if MeshLink has succesfully set up its configuration files, NULL otherwise.
+        *  @return         This function will return a pointer to a meshlink::mesh if MeshLink has successfully set up its configuration files, NULL otherwise.
         */
        bool open(const char *confbase, const char *name, const char *appname, dev_class_t devclass) {
                handle = meshlink_open(confbase, name, appname, devclass);
@@ -213,7 +220,13 @@ public:
                (void)message;
        }
 
-       /// This functions is called whenever another node attemps to open a channel to the local node.
+       /// This functions is called whenever MeshLink a meta-connection attempt is made.
+       virtual void connection_try(node *peer) {
+               /* do nothing */
+               (void)peer;
+       }
+
+       /// This functions is called whenever another node attempts to open a channel to the local node.
        /**
         *  If the channel is accepted, the poll_callback will be set to channel_poll and can be
         *  changed using set_channel_poll_cb(). Likewise, the receive callback is set to
@@ -279,7 +292,7 @@ public:
        /** This function causes MeshLink to open network sockets, make outgoing connections, and
         *  create a new thread, which will handle all network I/O.
         *
-        *  @return         This function will return true if MeshLink has succesfully started its thread, false otherwise.
+        *  @return         This function will return true if MeshLink has successfully started its thread, false otherwise.
         */
        bool start() {
                meshlink_set_receive_cb(handle, &receive_trampoline);
@@ -287,6 +300,7 @@ public:
                meshlink_set_node_duplicate_cb(handle, &node_duplicate_trampoline);
                meshlink_set_log_cb(handle, MESHLINK_DEBUG, &log_trampoline);
                meshlink_set_channel_accept_cb(handle, &channel_accept_trampoline);
+               meshlink_set_connection_try_cb(handle, &connection_try_trampoline);
                return meshlink_start(handle);
        }
 
@@ -327,6 +341,18 @@ public:
                return (node *)meshlink_get_node(handle, name);
        }
 
+       /// Get a handle for a specific submesh.
+       /** This function returns a handle for the submesh with the given name.
+        *
+        *  @param name         The name of the submesh for which a handle is requested.
+        *
+        *  @return             A pointer to a meshlink::submesh which represents the requested submesh,
+        *                      or NULL if the requested submesh does not exist.
+        */
+       submesh *get_submesh(const char *name) {
+               return (submesh *)meshlink_get_submesh(handle, name);
+       }
+
        /// Get a handle for our own node.
        /** This function returns a handle for the local node.
         *
@@ -507,7 +533,7 @@ public:
         *                       If the port is set to 0, then MeshLink will listen on a port
         *                       that is randomly assigned by the operating system every time open() is called.
         *
-        *  @return              This function returns true if the port was succesfully changed, false otherwise.
+        *  @return              This function returns true if the port was successfully changed, false otherwise.
         */
        bool set_port(int port) {
                return meshlink_set_port(handle, port);
@@ -543,7 +569,7 @@ public:
        /// 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.
         *  An invitation can only be used if the local node has never connected to other nodes before.
-        *  After a succesfully accepted invitation, the name of the local node may have changed.
+        *  After a successfully accepted invitation, the name of the local node may have changed.
         *
         *  This function may only be called on a mesh that has not been started yet and which is not already part of an existing mesh.
         *
@@ -691,6 +717,30 @@ public:
                return meshlink_channel_send(handle, channel, data, len);
        }
 
+       /// Get the amount of bytes in the send buffer.
+       /** This returns the amount of bytes in the send buffer.
+        *  These bytes have not been received by the peer yet.
+        *
+        *  @param channel      A handle for the channel.
+        *
+        *  @return             The amount of un-ACKed bytes in the send buffer.
+        */
+       size_t channel_get_sendq(channel *channel) {
+               return meshlink_channel_get_sendq(handle, channel);
+       }
+
+       /// Get the amount of bytes in the receive buffer.
+       /** This returns the amount of bytes in the receive buffer.
+        *  These bytes have not been processed by the application yet.
+        *
+        *  @param channel      A handle for the channel.
+        *
+        *  @return             The amount of bytes in the receive buffer.
+        */
+       size_t channel_get_recvq(channel *channel) {
+               return meshlink_channel_get_recvq(handle, channel);
+       }
+
        /// Enable or disable zeroconf discovery of local peers
        /** This controls whether zeroconf discovery using the Catta library will be
         *  enabled to search for peers on the local network. By default, it is enabled.
@@ -743,6 +793,15 @@ private:
                that->log(level, message);
        }
 
+       static void connection_try_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer) {
+               if(!(handle->priv)) {
+                       return;
+               }
+
+               meshlink::mesh *that = static_cast<mesh *>(handle->priv);
+               that->connection_try(static_cast<node *>(peer));
+       }
+
        static bool channel_accept_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, uint16_t port, const void *data, size_t len) {
                if(!(handle->priv)) {
                        return false;
@@ -792,7 +851,7 @@ static inline const char *strerror(errno_t err = meshlink_errno) {
  *  @param confbase The directory in which MeshLink stores its configuration files.
  *                  After the function returns, the application is free to overwrite or free @a confbase @a.
  *
- *  @return         This function will return true if the MeshLink instance was succesfully destroyed, false otherwise.
+ *  @return         This function will return true if the MeshLink instance was successfully destroyed, false otherwise.
  */
 static inline bool destroy(const char *confbase) {
        return meshlink_destroy(confbase);