class mesh;
class node;
class channel;
+class submesh;
/// Severity of log messages generated by MeshLink.
typedef meshlink_log_level_t log_level_t;
*/
typedef void (*node_status_cb_t)(mesh *mesh, node *node, bool reachable);
+/// 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.
+ * This pointer is valid until meshlink_close() is called.
+ */
+typedef void (*duplicate_cb_t)(mesh *mesh, node *node);
+
/// A callback for receiving log messages generated by MeshLink.
/** @param mesh A handle which represents an instance of MeshLink.
* @param level An enum describing the severity level of the message.
class node: public meshlink_node_t {
};
+/// A class describing a MeshLink Sub-Mesh.
+class submesh: public meshlink_submesh_t {
+};
+
/// A class describing a MeshLink channel.
class channel: public meshlink_channel_t {
public:
}
bool isOpen() const {
- return (handle!=0);
+ return (handle != 0);
}
// TODO: please enable C++11 in autoconf to enable "move constructors":
* @param confbase The directory in which MeshLink will store its configuration files.
* @param name The name which this instance of the application will use in the mesh.
* @param appname The application name which will be used in the mesh.
- * @param dclass The device class 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) {
+ bool open(const char *confbase, const char *name, const char *appname, dev_class_t devclass) {
handle = meshlink_open(confbase, name, appname, devclass);
- if(handle)
+
+ if(handle) {
handle->priv = this;
+ }
return isOpen();
}
- mesh(const char *confbase, const char *name, const char* appname, dev_class_t devclass) {
+ mesh(const char *confbase, const char *name, const char *appname, dev_class_t devclass) {
open(confbase, name, appname, devclass);
}
handle->priv = 0;
meshlink_close(handle);
}
- handle=0;
+
+ handle = 0;
}
/** instead of registerin callbacks you derive your own class and overwrite the following abstract member functions.
*/
/// This function is called whenever another node sends data to the local node.
- virtual void receive(node* source, const void* data, size_t length) { /* do nothing */ }
+ virtual void receive(node *source, const void *data, size_t length) {
+ /* do nothing */
+ (void)source;
+ (void)data;
+ (void) length;
+ }
+
+ /// This functions is called whenever another node's status changed.
+ virtual void node_status(node *peer, bool reachable) {
+ /* do nothing */
+ (void)peer;
+ (void)reachable;
+ }
- /// This functions is called whenever another node's status changed.
- virtual void node_status(node* peer, bool reachable) { /* do nothing */ }
+ /// This functions is called whenever a duplicate node is detected.
+ virtual void node_duplicate(node *peer) {
+ /* do nothing */
+ (void)peer;
+ }
/// This functions is called whenever MeshLink has some information to log.
- virtual void log(log_level_t level, const char* message) { /* do nothing */ }
+ virtual void log(log_level_t level, const char *message) {
+ /* do nothing */
+ (void)level;
+ (void)message;
+ }
- /// This functions is called whenever another node attemps to open a channel to the local node.
+ /// 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
*/
virtual bool channel_accept(channel *channel, uint16_t port, const void *data, size_t len) {
/* by default reject all channels */
+ (void)channel;
+ (void)port;
+ (void)data;
+ (void)len;
return false;
}
* @param data A pointer to a buffer containing data sent by the source.
* @param len The length of the data.
*/
- virtual void channel_receive(channel *channel, const void *data, size_t len) { /* do nothing */ }
+ virtual void channel_receive(channel *channel, const void *data, size_t len) {
+ /* do nothing */
+ (void)channel;
+ (void)data;
+ (void)len;
+ }
/// This function is called by Meshlink when data can be send on a channel.
/**
* @param channel A handle for the channel.
* @param len The maximum length of data that is guaranteed to be accepted by a call to channel_send().
*/
- virtual void channel_poll(channel *channel, size_t len) { /* do nothing */ }
+ virtual void channel_poll(channel *channel, size_t len) {
+ /* do nothing */
+ (void)channel;
+ (void)len;
+ }
/// Start MeshLink.
/** 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);
meshlink_set_node_status_cb(handle, &node_status_trampoline);
+ 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);
return meshlink_start(handle);
return meshlink_verify(handle, source, data, len, signature, siglen);
}
+ /// Set the canonical Address for a node.
+ /** This function sets the canonical Address for a 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.
+ *
+ * If a canonical Address is set for the local node,
+ * it will be used for the hostname part of generated invitation URLs.
+ *
+ * @param node A pointer to a meshlink_node_t describing the node.
+ * @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.
+ * If it is NULL, the listening port's number will be used.
+ *
+ * @return This function returns true if the address was added, false otherwise.
+ */
+ bool set_canonical_address(node *node, const char *address, const char *port = NULL) {
+ 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.
+ *
+ * @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.
+ * If it is NULL, the listening port's number will be used.
+ *
+ * @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);
+ }
+
/// Add an Address for the local node.
/** This function adds an Address for the local node, which will be used for invitation URLs.
*
* There is no guarantee it will be able to resolve the external address.
* Failures might be because by temporary network outages.
*
+ * @param family The address family to check, for example AF_INET or AF_INET6. If AF_UNSPEC is given,
+ * this might return the external address for any working address family.
+ *
+ * @return This function returns a pointer to a C string containing the discovered external address,
+ * or NULL if there was an error looking up the address.
+ * After get_external_address() returns, the application is free to overwrite or free this string.
+ */
+ bool get_external_address(int family = AF_UNSPEC) {
+ return meshlink_get_external_address_for_family(handle, family);
+ }
+
+ /** This function performs tries to discover the address of the local interface used for outgoing connection.
+ *
+ * Please note that this is function only returns a single address,
+ * even if the local node might have more than one external address.
+ * In that case, there is no control over which address will be selected.
+ * Also note that if you have a dynamic IP address, or are behind carrier-grade NAT,
+ * there is no guarantee that the external address will be valid for an extended period of time.
+ *
+ * This function will fail if it couldn't find a local address for the given address family.
+ * If hostname resolving is requested, this function may block for a few seconds.
+ *
+ * @param family The address family to check, for example AF_INET or AF_INET6. If AF_UNSPEC is given,
+ * this might return the external address for any working address family.
+ *
* @return This function returns a pointer to a C string containing the discovered external address,
* or NULL if there was an error looking up the address.
* After get_external_address() returns, the application is free to overwrite or free this string.
*/
- bool get_external_address() {
- return meshlink_get_external_address(handle);
+ bool get_local_address(int family = AF_UNSPEC) {
+ return meshlink_get_local_address_for_family(handle, family);
}
/// Try to discover the external address for the local node, and add it to its list of addresses.
/// Get the network port used by the local node.
/** This function returns the network port that the local node is listening on.
- *
- * @param mesh A handle which represents an instance of MeshLink.
*
* @return This function returns the port number, or -1 in case of an error.
*/
* 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);
}
+ /// Set the timeout for invitations.
+ /** This function sets the timeout for invitations.
+ * The timeout is retroactively applied to all outstanding invitations.
+ *
+ * @param timeout The timeout for invitations in seconds.
+ */
+ void set_invitation_timeout(int timeout) {
+ meshlink_set_invitation_timeout(handle, timeout);
+ }
+
/// 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.
* This URL should be passed by the application to the invitee in a way that no eavesdroppers can see the URL.
* The URL can only be used once, after the user has joined the mesh the URL is no longer valid.
*
+ * @param submesh A handle to the submesh to put the invitee in.
* @param name The name that the invitee will use in the mesh.
+ * @param flags A bitwise-or'd combination of flags that controls how the URL is generated.
*
* @return This function returns a string that contains the invitation URL.
* The application should call free() after it has finished using the URL.
*/
- char *invite(const char *name) {
- return meshlink_invite(handle, name);
+ char *invite(submesh *submesh, const char *name, uint32_t flags = 0) {
+ return meshlink_invite_ex(handle, submesh, name, flags);
}
/// 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.
*
* The application then has to decide whether to accept or reject this channel.
*
* This function sets the channel poll callback to channel_poll_trampoline, which in turn
- * calls channel_poll. To set a differnt, channel-specific poll callback, use set_channel_poll_cb.
+ * calls channel_poll. To set a different, channel-specific poll callback, use set_channel_poll_cb.
*
* @param node The node to which this channel is being initiated.
* @param port The port number the peer wishes to connect to.
return ch;
}
- /**
- * @override
- * Sets channel_receive_trampoline as cb, which in turn calls this->channel_receive( ... ).
+ /// 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.
+ *
+ * This function sets the channel receive callback to channel_receive_trampoline,
+ * which in turn calls channel_receive.
+ *
+ * This function sets the channel poll callback to channel_poll_trampoline, which in turn
+ * calls channel_poll. To set a different, channel-specific poll callback, use set_channel_poll_cb.
+ *
+ * @param node The node to which this channel is being initiated.
+ * @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.
+ * @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.
*/
channel *channel_open(node *node, uint16_t port, const void *data, size_t len, uint32_t flags = channel::TCP) {
channel *ch = (channel *)meshlink_channel_open_ex(handle, node, port, &channel_receive_trampoline, data, len, flags);
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.
private:
// non-copyable:
- mesh(const mesh&) /* TODO: C++11: = delete */;
- void operator=(const mesh&) /* TODO: C++11: = delete */ ;
+ mesh(const mesh &) /* TODO: C++11: = delete */;
+ void operator=(const mesh &) /* TODO: C++11: = delete */;
/// static callback trampolines:
- static void receive_trampoline(meshlink_handle_t* handle, meshlink_node_t* source, const void* data, size_t length) {
- if(!(handle->priv))
+ static void receive_trampoline(meshlink_handle_t *handle, meshlink_node_t *source, const void *data, size_t length) {
+ if(!(handle->priv)) {
+ return;
+ }
+
+ meshlink::mesh *that = static_cast<mesh *>(handle->priv);
+ that->receive(static_cast<node *>(source), data, length);
+ }
+
+ static void node_status_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer, bool reachable) {
+ if(!(handle->priv)) {
return;
- meshlink::mesh* that = static_cast<mesh*>(handle->priv);
- that->receive(static_cast<node*>(source), data, length);
+ }
+
+ meshlink::mesh *that = static_cast<mesh *>(handle->priv);
+ that->node_status(static_cast<node *>(peer), reachable);
}
- static void node_status_trampoline(meshlink_handle_t* handle, meshlink_node_t* peer, bool reachable) {
- if(!(handle->priv))
+ static void node_duplicate_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer) {
+ if(!(handle->priv)) {
return;
- meshlink::mesh* that = static_cast<mesh*>(handle->priv);
- that->node_status(static_cast<node*>(peer), reachable);
+ }
+
+ meshlink::mesh *that = static_cast<mesh *>(handle->priv);
+ that->node_duplicate(static_cast<node *>(peer));
}
- static void log_trampoline(meshlink_handle_t* handle, log_level_t level, const char* message) {
- if(!(handle->priv))
+ static void log_trampoline(meshlink_handle_t *handle, log_level_t level, const char *message) {
+ if(!(handle->priv)) {
return;
- meshlink::mesh* that = static_cast<mesh*>(handle->priv);
+ }
+
+ meshlink::mesh *that = static_cast<mesh *>(handle->priv);
that->log(level, message);
}
static bool channel_accept_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, uint16_t port, const void *data, size_t len) {
- if(!(handle->priv))
+ if(!(handle->priv)) {
return false;
- meshlink::mesh* that = static_cast<mesh*>(handle->priv);
- bool accepted = that->channel_accept(static_cast<meshlink::channel*>(channel), port, data, len);
+ }
+
+ meshlink::mesh *that = static_cast<mesh *>(handle->priv);
+ bool accepted = that->channel_accept(static_cast<meshlink::channel *>(channel), port, data, len);
+
if(accepted) {
meshlink_set_channel_receive_cb(handle, channel, &channel_receive_trampoline);
meshlink_set_channel_poll_cb(handle, channel, &channel_poll_trampoline);
}
+
return accepted;
}
- static void channel_receive_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, const void* data, size_t len) {
- if(!(handle->priv))
+ static void channel_receive_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, const void *data, size_t len) {
+ if(!(handle->priv)) {
return;
- meshlink::mesh* that = static_cast<mesh*>(handle->priv);
- that->channel_receive(static_cast<meshlink::channel*>(channel), data, len);
+ }
+
+ meshlink::mesh *that = static_cast<mesh *>(handle->priv);
+ that->channel_receive(static_cast<meshlink::channel *>(channel), data, len);
}
static void channel_poll_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, size_t len) {
- if(!(handle->priv))
+ if(!(handle->priv)) {
return;
- meshlink::mesh* that = static_cast<mesh*>(handle->priv);
- that->channel_poll(static_cast<meshlink::channel*>(channel), len);
+ }
+
+ meshlink::mesh *that = static_cast<mesh *>(handle->priv);
+ that->channel_poll(static_cast<meshlink::channel *>(channel), len);
}
- meshlink_handle_t* handle;
+ meshlink_handle_t *handle;
};
-static const char *strerror(errno_t err = meshlink_errno) {
+static inline const char *strerror(errno_t err = meshlink_errno) {
return meshlink_strerror(err);
}
* @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 bool destroy(const char *confbase) {
+static inline bool destroy(const char *confbase) {
return meshlink_destroy(confbase);
}
}
projects / meshlink / blobdiff