]> git.meshlink.io Git - meshlink/blobdiff - src/meshlink++.h
Rename mesh_mutex to mutex.
[meshlink] / src / meshlink++.h
index dee2c7060d04bc352b59901f911fc7d8a78a7009..f5921363e0dffa550a5a38065bc8eaafc703829f 100644 (file)
@@ -57,6 +57,14 @@ typedef void (*connection_try_cb_t)(mesh *mesh, node *node);
  */
 typedef void (*node_status_cb_t)(mesh *mesh, node *node, bool reachable);
 
+/// A callback reporting node path MTU changes.
+/** @param mesh       A handle which represents an instance of MeshLink.
+ *  @param node       A pointer to a meshlink_node_t describing the node whose status changed.
+ *                    This pointer is valid until meshlink_close() is called.
+ *  @param pmtu       The current path MTU to the node, or 0 if UDP communication is not (yet) possible.
+ */
+typedef void (*node_pmtu_cb_t)(mesh *mesh, node *node, uint16_t pmtu);
+
 /// A callback reporting duplicate node detection.
 /** @param mesh       A handle which represents an instance of MeshLink.
  *  @param node       A pointer to a meshlink_node_t describing the node which is duplicate.
@@ -110,6 +118,17 @@ typedef void (*channel_poll_cb_t)(mesh *mesh, channel *channel, size_t len);
  */
 typedef void (*aio_cb_t)(mesh *mesh, channel *channel, const void *data, size_t len, void *priv);
 
+/// A callback for asynchronous I/O to and from filedescriptors.
+/** This callbacks signals that MeshLink has finished using this filedescriptor.
+ *
+ *  @param mesh      A handle which represents an instance of MeshLink.
+ *  @param channel   A handle for the channel which used this filedescriptor.
+ *  @param fd        The filedescriptor that was used.
+ *  @param len       The length of the data that was successfully sent or received.
+ *  @param priv      A private pointer which was set by the application when submitting the buffer.
+ */
+typedef void (*aio_fd_cb_t)(mesh *mesh, channel *channel, int fd, size_t len, void *priv);
+
 /// A class describing a MeshLink node.
 class node: public meshlink_node_t {
 };
@@ -220,6 +239,13 @@ public:
                (void)reachable;
        }
 
+       /// This functions is called whenever another node's path MTU changes.
+       virtual void node_pmtu(node *peer, uint16_t pmtu) {
+               /* do nothing */
+               (void)peer;
+               (void)pmtu;
+       }
+
        /// This functions is called whenever a duplicate node is detected.
        virtual void node_duplicate(node *peer) {
                /* do nothing */
@@ -233,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 */
@@ -310,8 +342,10 @@ public:
        bool start() {
                meshlink_set_receive_cb(handle, &receive_trampoline);
                meshlink_set_node_status_cb(handle, &node_status_trampoline);
+               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);
@@ -674,6 +708,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.
@@ -769,6 +815,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.
         */
@@ -776,6 +823,23 @@ public:
                return meshlink_channel_aio_send(handle, channel, data, len, cb, priv);
        }
 
+       /// 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.
+        *  The callback may be returned early if there is an error reading from the filedescriptor.
+        *  While there is still with unsent data, the poll callback will not be called.
+        *
+        *  @param channel      A handle for the channel.
+        *  @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.
+        */
+       bool channel_aio_fd_send(channel *channel, int fd, size_t len, meshlink_aio_fd_cb_t cb, void *priv) {
+               return meshlink_channel_aio_fd_send(handle, channel, fd, len, cb, priv);
+       }
+
        /// Receive data on a channel asynchronously
        /** This registers a buffer that will be filled with incoming channel data.
         *  Multiple buffers can be registered, in which case data will be received in the order the buffers were registered.
@@ -787,6 +851,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.
         */
@@ -794,6 +859,23 @@ public:
                return meshlink_channel_aio_receive(handle, channel, data, len, cb, priv);
        }
 
+       /// 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.
+        *  The callback may be returned early if there is an error writing to the filedescriptor.
+        *  While there is still unread data, the receive callback will not be called.
+        *
+        *  @param channel      A handle for the channel.
+        *  @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.
+        */
+       bool channel_aio_fd_receive(channel *channel, int fd, size_t len, meshlink_aio_fd_cb_t cb, void *priv) {
+               return meshlink_channel_aio_fd_receive(handle, channel, fd, len, cb, priv);
+       }
+
        /// 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.
@@ -828,6 +910,16 @@ public:
                meshlink_enable_discovery(handle, enable);
        }
 
+       /// Set device class timeouts
+       /** This sets the ping interval and timeout for a given device class.
+        *
+        *  @param devclass      The device class to update
+        *  @param pinginterval  The interval between keepalive packets, in seconds. The default is 60.
+        *  @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);
+
 private:
        // non-copyable:
        mesh(const mesh &) /* TODO: C++11: = delete */;
@@ -852,6 +944,15 @@ private:
                that->node_status(static_cast<node *>(peer), reachable);
        }
 
+       static void node_pmtu_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer, uint16_t pmtu) {
+               if(!(handle->priv)) {
+                       return;
+               }
+
+               meshlink::mesh *that = static_cast<mesh *>(handle->priv);
+               that->node_pmtu(static_cast<node *>(peer), pmtu);
+       }
+
        static void node_duplicate_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer) {
                if(!(handle->priv)) {
                        return;
@@ -870,6 +971,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<mesh *>(handle->priv);
+               that->error(meshlink_errno);
+       }
+
        static void connection_try_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer) {
                if(!(handle->priv)) {
                        return;