*/
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.
*/
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.
*/
typedef void (*channel_poll_cb_t)(mesh *mesh, channel *channel, size_t len);
+/// A callback for cleaning up buffers submitted for asynchronous I/O.
+/** This callbacks signals that MeshLink has finished using this buffer.
+ * The ownership of the buffer is now back into the application's hands.
+ *
+ * @param mesh A handle which represents an instance of MeshLink.
+ * @param channel A handle for the channel which used this buffer.
+ * @param data A pointer to a buffer containing the enqueued data.
+ * @param len The length of the buffer.
+ * @param priv A private pointer which was set by the application when submitting the buffer.
+ */
+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 {
};
static const uint32_t ORDERED = MESHLINK_CHANNEL_ORDERED;
static const uint32_t FRAMED = MESHLINK_CHANNEL_FRAMED;
static const uint32_t DROP_LATE = MESHLINK_CHANNEL_DROP_LATE;
+ static const uint32_t NO_PARTIAL = MESHLINK_CHANNEL_NO_PARTIAL;
static const uint32_t TCP = MESHLINK_CHANNEL_TCP;
static const uint32_t UDP = MESHLINK_CHANNEL_UDP;
};
(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 */
(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 */
+ (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
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);
}
return (node *)meshlink_get_node(handle, name);
}
+ /// Get a node's reachability status.
+ /** This function returns the current reachability of a given node, and the times of the last state changes.
+ * If a given state change never happened, the time returned will be 0.
+ *
+ * @param node A pointer to a meshlink::node describing the node.
+ * @param last_reachable A pointer to a time_t variable that will be filled in with the last time the node became reachable.
+ * @param last_unreachable A pointer to a time_t variable that will be filled in with the last time the node became unreachable.
+ *
+ * @return This function returns true if the node is currently reachable, false otherwise.
+ */
+ bool get_node_reachability(node *node, time_t *last_reachable = NULL, time_t *last_unreachable = NULL) {
+ return meshlink_get_node_reachability(handle, node, last_reachable, last_unreachable);
+ }
+
+ /// 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.
*
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.
*
* @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
* 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 successfully changed, false otherwise.
+ * @return This function returns true if the port was successfully changed
+ * to the desired port, false otherwise. If it returns false, there
+ * is no guarantee that MeshLink is listening on the old port.
*/
bool set_port(int port) {
return meshlink_set_port(handle, port);
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,
* and will not send data to it nor accept any data received from it any more.
*
* @param node A pointer to a meshlink::node describing the node to be blacklisted.
+ *
+ * @return This function returns true if the node has been whitelisted, false otherwise.
*/
- void blacklist(node *node) {
+ bool blacklist(node *node) {
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,
+ * and will send data to it and accept any data received from it.
+ *
+ * @param node A pointer to a meshlink::node describing the node to be whitelisted.
+ *
+ * @return This function returns true if the node has been whitelisted, false otherwise.
+ */
+ bool whitelist(node *node) {
+ 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.
meshlink_set_channel_poll_cb(handle, channel, (meshlink_channel_poll_cb_t)cb);
}
+ /// Set the send buffer size of a channel.
+ /** This function sets the desired size of the send buffer.
+ * The default size is 128 kB.
+ *
+ * @param channel A handle for the channel.
+ * @param size The desired size for the send buffer.
+ * If a NULL pointer is given, the callback will be disabled.
+ */
+ void set_channel_sndbuf(channel *channel, size_t size) {
+ meshlink_set_channel_sndbuf(handle, channel, size);
+ }
+
+ /// Set the receive buffer size of a channel.
+ /** This function sets the desired size of the receive buffer.
+ * The default size is 128 kB.
+ *
+ * @param channel A handle for the channel.
+ * @param size The desired size for the send buffer.
+ * If a NULL pointer is given, the callback will be disabled.
+ */
+ void set_channel_rcvbuf(channel *channel, size_t size) {
+ 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.
* @param cb A pointer to the function which will be called when the remote node sends data to the local node.
* @param data A pointer to a buffer containing data to already queue for sending.
* @param len The length of the data.
+ * If len is 0, the data pointer is copied into the channel's priv member.
* @param flags A bitwise-or'd combination of flags that set the semantics for this channel.
*
* @return A handle for the channel, or NULL in case of an error.
* @param port The port number the peer wishes to connect to.
* @param data A pointer to a buffer containing data to already queue for sending.
* @param len The length of the data.
+ * If len is 0, the data pointer is copied into the channel's priv member.
* @param flags A bitwise-or'd combination of flags that set the semantics for this channel.
*
* @return A handle for the channel, or NULL in case of an error.
* @param len The length of the data.
*
* @return The amount of data that was queued, which can be less than len, or a negative value in case of an error.
+ * If MESHLINK_CHANNEL_NO_PARTIAL is set, then the result will either be len,
+ * 0 if the buffer is currently too full, or -1 if len is too big even for an empty buffer.
*/
ssize_t channel_send(channel *channel, void *data, size_t len) {
return meshlink_channel_send(handle, channel, data, len);
}
+ /// Transmit data on a channel asynchronously
+ /** This registers a buffer that will be used to send data to the remote node.
+ * Multiple buffers can be registered, in which case data will be sent in the order the buffers were registered.
+ * While there are still buffers with unsent data, the poll callback will not be called.
+ *
+ * @param channel A handle for the channel.
+ * @param data A pointer to a buffer containing data sent by the source, or NULL if there is no data to send.
+ * After meshlink_channel_aio_send() returns, the buffer may not be modified or freed by the application
+ * 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.
+ */
+ bool channel_aio_send(channel *channel, const void *data, size_t len, meshlink_aio_cb_t cb, void *priv) {
+ 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.
+ * While there are still buffers that have not been filled, the receive callback will not be called.
+ *
+ * @param channel A handle for the channel.
+ * @param data A pointer to a buffer that will be filled with incoming data.
+ * After meshlink_channel_aio_receive() returns, the buffer may not be modified or freed by the application
+ * 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.
+ */
+ bool channel_aio_receive(channel *channel, const void *data, size_t len, meshlink_aio_cb_t cb, void *priv) {
+ 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.
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.
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) {
+ meshlink_set_dev_class_timeouts(handle, devclass, pinginterval, pingtimeout);
+ }
+
+ /// Set device class fast retry period
+ /** This sets the fast retry period for a given device class.
+ * During this period after the last time the mesh becomes unreachable, connections are tried once a second.
+ *
+ * @param devclass The device class to update
+ * @param fast_retry_period The period during which fast connection retries are done. The default is 0.
+ */
+ void set_dev_class_fast_retry_period(dev_class_t devclass, int fast_retry_period) {
+ 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 */;
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;
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;
+ }
+
+ 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;
projects / meshlink / blobdiff