]> git.meshlink.io Git - meshlink/blobdiff - src/meshlink++.h
Never automatically try to bind to ports >= 32768.
[meshlink] / src / meshlink++.h
index 551913d4ba2a94ceb4df51852dd8595ce563a28d..9e97fc820d846b29e9570da08bbc1fb47b65e4bd 100644 (file)
@@ -280,6 +280,12 @@ public:
                (void)peer;
        }
 
+       /// This functions is called whenever the MeshLink thread status changes.
+       virtual void thread_status(bool status) {
+               /* do nothing */
+               (void)status;
+       }
+
        /// This functions is called whenever MeshLink a meta-connection attempt is made.
        virtual void connection_try(node *peer) {
                /* do nothing */
@@ -381,6 +387,7 @@ public:
                meshlink_set_log_cb(handle, MESHLINK_DEBUG, &log_trampoline);
                meshlink_set_error_cb(handle, &error_trampoline);
                meshlink_set_blacklisted_cb(handle, &blacklisted_trampoline);
+               meshlink_set_thread_status_cb(handle, &thread_status_trampoline);
                meshlink_set_channel_listen_cb(handle, &channel_listen_trampoline);
                meshlink_set_channel_accept_cb(handle, &channel_accept_trampoline);
                meshlink_set_connection_try_cb(handle, &connection_try_trampoline);
@@ -449,6 +456,18 @@ public:
                return meshlink_get_node_blacklisted(handle, node);
        }
 
+       /// Get the node's tiny status.
+       /** This function returns true if the given node is a tiny node.
+        *  Note that the tiny status of a node will only be known if the node has been reachable at least once.
+        *
+        *  @param node          A pointer to a meshlink::node describing the node.
+        *
+        *  @return              This function returns true if the node is a tiny node.
+        */
+       bool get_node_tiny(node *node) {
+               return meshlink_get_node_tiny(handle, node);
+       }
+
        /// Get a handle for a specific submesh.
        /** This function returns a handle for the submesh with the given name.
         *
@@ -705,6 +724,19 @@ public:
                meshlink_set_scheduling_granularity(handle, granularity);
        }
 
+       /// Sets the storage policy used by MeshLink
+       /** This sets the policy MeshLink uses when it has new information about nodes.
+        *  By default, all udpates will be stored to disk (unless an ephemeral instance has been opened).
+        *  Setting the policy to MESHLINK_STORAGE_KEYS_ONLY, only updates that contain new keys for nodes
+        *  are stored, as well as blacklist/whitelist settings.
+        *  By setting the policy to MESHLINK_STORAGE_DISABLED, no updates will be stored.
+        *
+        *  @param policy  The storage policy to use.
+        */
+       void set_storage_policy(meshlink_storage_policy_t policy) {
+               meshlink_set_storage_policy(handle, policy);
+       }
+
        /// 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.
         *  The generated invitation is a string containing a URL.
@@ -885,6 +917,43 @@ public:
                meshlink_set_channel_rcvbuf(handle, channel, size);
        }
 
+       /// Set the flags of a channel.
+       /** This function allows changing some of the channel flags.
+        *  Currently only MESHLINK_CHANNEL_NO_PARTIAL and MESHLINK_CHANNEL_DROP_LATE are supported, other flags are ignored.
+        *  These flags only affect the local side of the channel with the peer.
+        *  The changes take effect immediately.
+        *
+        *  @param channel   A handle for the channel.
+        *  @param flags     A bitwise-or'd combination of flags that set the semantics for this channel.
+        */
+       void set_channel_flags(channel *channel, uint32_t flags) {
+               meshlink_set_channel_flags(handle, channel, flags);
+       }
+
+       /// Set the send buffer storage of a channel.
+       /** This function provides MeshLink with a send buffer allocated by the application.
+       *
+       *  @param channel   A handle for the channel.
+       *  @param buf       A pointer to the start of the buffer.
+       *                   If a NULL pointer is given, MeshLink will use its own internal buffer again.
+       *  @param size      The size of the buffer.
+       */
+       void set_channel_sndbuf_storage(channel *channel, void *buf, size_t size) {
+               meshlink_set_channel_sndbuf_storage(handle, channel, buf, size);
+       }
+
+       /// Set the receive buffer storage of a channel.
+       /** This function provides MeshLink with a receive buffer allocated by the application.
+       *
+       *  @param channel   A handle for the channel.
+       *  @param buf       A pointer to the start of the buffer.
+       *                   If a NULL pointer is given, MeshLink will use its own internal buffer again.
+       *  @param size      The size of the buffer.
+       */
+       void set_channel_rcvbuf_storage(channel *channel, void *buf, size_t size) {
+               meshlink_set_channel_rcvbuf_storage(handle, channel, buf, 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.
@@ -962,12 +1031,30 @@ public:
         *  It also causes the local node to stop accepting incoming data from the remote node.
         *  Afterwards, the channel handle is invalid and must not be used any more.
         *
+        *  It is allowed to call this function at any time on a valid handle, even inside callback functions.
+        *  If called with a valid handle, this function always succeeds, otherwise the result is undefined.
+        *
         *  @param channel      A handle for the channel.
         */
        void channel_close(meshlink_channel_t *channel) {
                return meshlink_channel_close(handle, channel);
        }
 
+       /// Abort a reliable stream channel.
+       /** This aborts a channel.
+        *  Data that was in the send and receive buffers is dropped, so potentially there is some data that
+        *  was sent on this channel that will not be received by the peer.
+        *  Afterwards, the channel handle is invalid and must not be used any more.
+        *
+        *  It is allowed to call this function at any time on a valid handle, even inside callback functions.
+        *  If called with a valid handle, this function always succeeds, otherwise the result is undefined.
+        *
+        *  @param channel      A handle for the channel.
+        */
+       void channel_abort(meshlink_channel_t *channel) {
+               return meshlink_channel_abort(handle, channel);
+       }
+
        /// Transmit data on a channel
        /** This queues data to send to the remote node.
         *
@@ -1100,6 +1187,15 @@ public:
                meshlink_enable_discovery(handle, enable);
        }
 
+       /// Inform MeshLink that the local network configuration might have changed
+       /** This is intended to be used when there is no way for MeshLink to get notifications of local network changes.
+        *  It forces MeshLink to scan all network interfaces for changes in up/down status and new/removed addresses,
+        *  and will immediately check if all connections to other nodes are still alive.
+        */
+       void hint_network_change() {
+               meshlink_hint_network_change(handle);
+       }
+
        /// Set device class timeouts
        /** This sets the ping interval and timeout for a given device class.
         *
@@ -1224,6 +1320,15 @@ private:
                that->blacklisted(static_cast<node *>(peer));
        }
 
+       static void thread_status_trampoline(meshlink_handle_t *handle, bool status) {
+               if(!(handle->priv)) {
+                       return;
+               }
+
+               meshlink::mesh *that = static_cast<mesh *>(handle->priv);
+               that->thread_status(status);
+       }
+
        static void connection_try_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer) {
                if(!(handle->priv)) {
                        return;