*/
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.
* @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) {
handle = meshlink_open(confbase, name, appname, devclass);
(void)message;
}
- /// This functions is called whenever another node attemps to open a channel to the local node.
+ /// 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
* changed using set_channel_poll_cb(). Likewise, the receive callback is set to
/** 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_duplicate_cb(handle, &node_duplicate_trampoline);
meshlink_set_log_cb(handle, MESHLINK_DEBUG, &log_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 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.
*
/// 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
+ * 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);
* 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.
*
/// 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.
that->log(level, message);
}
+ 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;
* @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 inline bool destroy(const char *confbase) {
return meshlink_destroy(confbase);