]> git.meshlink.io Git - meshlink/blobdiff - src/meshlink++.h
Avoid allocating packet buffers unnecessarily.
[meshlink] / src / meshlink++.h
index 6374a86d3b3725920c4b464da91afb6dbfaa744c..93020661b922b21b1c1b43dbc2e7dd105f65138d 100644 (file)
@@ -486,11 +486,10 @@ public:
                return meshlink_set_canonical_address(handle, node, address, port);
        }
 
-       /// Set the canonical Address for the local node.
-       /** This function sets the canonical Address for the local node.
-        *  This address is stored permanently until it is changed by another call to this function,
-        *  unlike other addresses associated with a node,
-        *  such as those added with meshlink_hint_address() or addresses discovered at runtime.
+       /// Add an invitation address for the local node.
+       /** This function adds an address for the local node, which will be used only for invitation URLs.
+        *  This address is not stored permanently.
+        *  Multiple addresses can be added using multiple calls to this function.
         *
         *  @param address      A nul-terminated C string containing the address, which can be either in numeric format or a hostname.
         *  @param port         A nul-terminated C string containing the port, which can be either in numeric or symbolic format.
@@ -498,19 +497,27 @@ public:
         *
         *  @return             This function returns true if the address was added, false otherwise.
         */
-       bool set_canonical_address(const char *address, const char *port = NULL) {
-               return meshlink_set_canonical_address(handle, get_self(), address, port);
+       bool add_invitation_address(const char *address, const char *port) {
+               return meshlink_add_invitation_address(handle, address, port);
+       }
+
+       /// Clears all invitation address for the local node.
+       /** This function removes all addresses added with meshlink_add_invitation_address().
+        */
+       void clear_invitation_addresses() {
+               return meshlink_clear_invitation_addresses(handle);
        }
 
        /// Add an Address for the local node.
        /** This function adds an Address for the local node, which will be used for invitation URLs.
+        *  @deprecated This function is deprecated, use set_canonical_address() and/or add_invitation_address().
         *
         *  @param address      A string containing the address, which can be either in numeric format or a hostname.
         *
         *  @return             This function returns true if the address was added, false otherwise.
         */
-       bool add_address(const char *address) {
-               return meshlink_add_address(handle, address);
+       bool add_address(const char *address) __attribute__((__deprecated__("use set_canonical_address() and/or add_invitation_address() instead"))) {
+               return meshlink_set_canonical_address(handle, get_self(), address, NULL);
        }
 
        /** This function performs tries to discover the local node's external address
@@ -986,6 +993,17 @@ public:
                return meshlink_channel_get_recvq(handle, channel);
        }
 
+       /// Get the maximum segment size of a channel.
+       /** This returns the amount of bytes that can be sent at once for channels with UDP semantics.
+        *
+        *  @param channel      A handle for the channel.
+        *
+        *  @return             The amount of bytes in the receive buffer.
+        */
+       size_t channel_get_mss(channel *channel) {
+               return meshlink_channel_get_mss(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.
@@ -1019,6 +1037,28 @@ public:
                meshlink_set_dev_class_fast_retry_period(handle, devclass, fast_retry_period);
        }
 
+       /// Set which order invitations are committed
+       /** This determines in which order configuration files are written to disk during an invitation.
+        *  By default, the invitee saves the configuration to disk first, then the inviter.
+        *  By calling this function with @a inviter_commits_first set to true, the order is reversed.
+        *
+        *  @param inviter_commits_first  If true, then the node that invited a peer will commit data to disk first.
+        */
+       void set_inviter_commits_first(bool inviter_commits_first) {
+               meshlink_set_inviter_commits_first(handle, inviter_commits_first);
+       }
+
+       /// Set the URL used to discover the host's external address
+       /** For generating invitation URLs, MeshLink can look up the externally visible address of the local node.
+        *  It does so by querying an external service. By default, this is http://meshlink.io/host.cgi.
+        *  Only URLs starting with http:// are supported.
+        *
+        *  @param url   The URL to use for external address queries, or NULL to revert back to the default URL.
+        */
+       void set_external_address_discovery_url(const char *url) {
+               meshlink_set_external_address_discovery_url(handle, url);
+       }
+
 private:
        // non-copyable:
        mesh(const mesh &) /* TODO: C++11: = delete */;