#ifndef MESHLINK_INTERNAL_H
struct meshlink_handle {
- char *name;
- char *appname;
- dev_class_t devclass;
- void *priv;
+ char *name; ///< Textual name of ourself. It is stored in a nul-terminated C string, which is allocated by MeshLink.
+ void *priv; ///< Private pointer which may be set freely by the application, and is never used or modified by MeshLink.
};
struct meshlink_node {
char *name; ///< Textual name of this node. It is stored in a nul-terminated C string, which is allocated by MeshLink.
- uint32_t options;
- dev_class_t devclass;
void *priv; ///< Private pointer which may be set freely by the application, and is never used or modified by MeshLink.
};
struct meshlink_channel {
+ struct meshlink_node *node; ///< Pointer to the peer of this channel.
+ void *priv; ///< Private pointer which may be set freely by the application, and is never used or modified by MeshLink.
};
#endif // MESHLINK_INTERNAL_H
/// An edge in the meshlink network.
struct meshlink_edge {
struct meshlink_node *from; ///< Pointer to a node. Node memory is
- // owned by meshlink and should not be
- // deallocated. Node contents may be
- // changed by meshlink.
+ // owned by meshlink and should not be
+ // deallocated. Node contents may be
+ // changed by meshlink.
struct meshlink_node *to; ///< Pointer to a node. Node memory is
- // owned by meshlink and should not be
- // deallocated. Node contents may be
- // changed by meshlink.
+ // owned by meshlink and should not be
+ // deallocated. Node contents may be
+ // changed by meshlink.
struct sockaddr_storage address;///< The address information associated
- // with this edge.
+ // with this edge.
uint32_t options; ///< Edge options. @TODO what are edge options?
int weight; ///< Weight assigned to this edge.
};
*/
extern meshlink_handle_t *meshlink_open(const char *confbase, const char *name, const char* appname, dev_class_t devclass);
-/// is used by the C++ wrapper to allocate more memory behind the handle
-extern meshlink_handle_t *meshlink_open_with_size(const char *confbase, const char *name, const char* appname, dev_class_t devclass, size_t size);
-
/// 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.
* close all sockets, and shut down its own thread.
*
* This function always succeeds. It is allowed to call meshlink_stop() even if MeshLink is already stopped or has never been started.
+ * Channels that are still open will remain valid, but any communication via channels will stop as well.
*
* @param mesh A handle which represents an instance of MeshLink.
*/
/// Close the MeshLink handle.
/** This function calls meshlink_stop() if necessary,
- * and frees the struct meshlink_handle and all associacted memory allocated by MeshLink.
+ * and frees the struct meshlink_handle and all associacted memory allocated by MeshLink, including all channels.
* Afterwards, the handle and any pointers to a struct meshlink_node or struct meshlink_channel are invalid.
*
* It is allowed to call this function at any time on a valid handle, except inside callback functions.
* @param mesh A handle which represents an instance of MeshLink.
* @param node A pointer to a meshlink_node_t describing the node.
*
- * @return A nul-terminated C string containing the fingerprint of the node's public key in a printable ASCII format.
+ * @return A nul-terminated C string containing the fingerprint of the node's public key in a printable ASCII format.
* The application should call free() after it is done using this string.
*/
extern char *meshlink_get_fingerprint(meshlink_handle_t *mesh, meshlink_node_t *node);
* and will send data to it and accept any data received from it.
*
* @param mesh A handle which represents an instance of MeshLink.
- * @param node A pointer to a meshlink_node_t describing the node to be blacklisted.
+ * @param node A pointer to a meshlink_node_t describing the node to be whitelisted.
*/
-extern void meshlink_blacklist(meshlink_handle_t *mesh, meshlink_node_t *node);
+extern void meshlink_whitelist(meshlink_handle_t *mesh, meshlink_node_t *node);
+
+/// Set whether new nodes are blacklisted by default.
+/** This function sets the blacklist behaviour for newly discovered nodes.
+ * If set to true, new nodes will be automatically blacklisted.
+ * If set to false, which is the default, new nodes are automatically whitelisted.
+ * The whitelist/blacklist status of a node may be changed afterwards with the
+ * meshlink_whitelist() and meshlink_blacklist() functions.
+ *
+ * @param mesh A handle which represents an instance of MeshLink.
+ * @param blacklist True if new nodes are to be blacklisted, false if whitelisted.
+ */
+extern void meshlink_set_default_blacklist(meshlink_handle_t *mesh, bool blacklist);
/// A callback for accepting incoming channels.
/** This function is called whenever a remote node wants to open a channel to the local node.
* If the application rejects the incoming channel by returning false,
* then this handle is invalid after the callback returns
* (the callback does not need to call meshlink_channel_close() itself in this case).
- * @param node The node from which this channel is being initiated.
- * The pointer is guaranteed to be valid until meshlink_close() is called.
* @param port The port number the peer wishes to connect to.
* @param data A pointer to a buffer containing data already received, or NULL in case no data has been received yet. (Not yet used.)
* The pointer is only valid during the lifetime of the callback.
* @return This function should return true if the application accepts the incoming channel, false otherwise.
* If returning false, the channel is invalid and may not be used anymore.
*/
-typedef bool (*meshlink_channel_accept_cb_t)(meshlink_handle_t *mesh, meshlink_channel_t *channel, meshlink_node_t *node, uint16_t port, const void *data, size_t len);
+typedef bool (*meshlink_channel_accept_cb_t)(meshlink_handle_t *mesh, meshlink_channel_t *channel, uint16_t port, const void *data, size_t len);
/// A callback for receiving data from a channel.
/** This function is called whenever data is received from a remote node on a channel.
*/
typedef void (*meshlink_channel_receive_cb_t)(meshlink_handle_t *mesh, meshlink_channel_t *channel, const void *data, size_t len);
+/// A callback informing the application when data can be sent on a channel.
+/** This function is called whenever there is enough free buffer space so a call to meshlink_channel_send() will succeed.
+ *
+ * @param mesh A handle which represents an instance of MeshLink.
+ * @param channel A handle for the channel.
+ * @param len The maximum amount of data that is guaranteed to be accepted by meshlink_channel_send().
+ */
+typedef void (*meshlink_channel_poll_cb_t)(meshlink_handle_t *mesh, meshlink_channel_t *channel, size_t len);
+
/// Set the accept callback.
/** This functions sets the callback that is called whenever another node sends data to the local node.
* The callback is run in MeshLink's own thread.
*/
extern void meshlink_set_channel_receive_cb(meshlink_handle_t *mesh, meshlink_channel_t *channel, meshlink_channel_receive_cb_t cb);
+/// 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.
+ * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
+ * to pass data to or from the application's thread.
+ * The callback should also not block itself and return as quickly as possible.
+ *
+ * @param mesh A handle which represents an instance of MeshLink.
+ * @param channel A handle for the channel.
+ * @param cb A pointer to the function which will be called when data can be sent to another node.
+ * If a NULL pointer is given, the callback will be disabled.
+ */
+extern void meshlink_set_channel_poll_cb(meshlink_handle_t *mesh, meshlink_channel_t *channel, meshlink_channel_poll_cb_t cb);
+
/// 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 indicates to meshlink that the given hostname is likely found
* at the given IP address and port.
*
- * @param mesh A handle which represents an instance of MeshLink.
- * @param hostname The hostname which can be found at the given address.
- * The caller is free to overwrite or free this string
- * once meshlink returns.
- * @param addr The IP address and port which should be tried for the
- * given hostname. The caller is free to overwrite or free
- * this memory once meshlink returns.
+ * @param mesh A handle which represents an instance of MeshLink.
+ * @param hostname The hostname which can be found at the given address.
+ * The caller is free to overwrite or free this string
+ * once meshlink returns.
+ * @param addr The IP address and port which should be tried for the
+ * given hostname. The caller is free to overwrite or free
+ * this memory once meshlink returns.
*/
extern void meshlink_hint_address(meshlink_handle_t *mesh, meshlink_node_t *node, const struct sockaddr *addr);
projects / meshlink / blobdiff