#define MESHLINKPP_H
#include <meshlink.h>
+#include <new> // for 'placement new'
namespace meshlink {
class mesh;
class node;
+ class channel;
/// Severity of log messages generated by MeshLink.
typedef meshlink_log_level_t log_level_t;
*/
typedef void (*log_cb_t)(mesh *mesh, log_level_t level, const char *text);
+ /// A callback for accepting incoming channels.
+ /** @param mesh A handle which represents an instance of MeshLink.
+ * @param channel A handle for the incoming channel.
+ * @param node The node from 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 already received. (Not yet used.)
+ * @param len The length of the data. (Not yet used.)
+ *
+ * @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 (*channel_accept_cb_t)(mesh *mesh, channel *channel, node *node, uint16_t port, const void *data, size_t len);
+
+ /// A callback for receiving data from a channel.
+ /** @param mesh A handle which represents an instance of MeshLink.
+ * @param channel A handle for the channel.
+ * @param data A pointer to a buffer containing data sent by the source.
+ * @param len The length of the data.
+ */
+ typedef void (*channel_receive_cb_t)(mesh *mesh, channel *channel, const void *data, size_t len);
+
/// A class describing a MeshLink node.
class node: public meshlink_node_t {
};
+ /// A class describing a MeshLink channel.
+ class channel: public meshlink_channel_t {
+ };
+
/// A class describing a MeshLink mesh.
class mesh: public meshlink_handle_t {
- public:
- // TODO: delete constructor, add a destructor.
-
+ public:
+ mesh() {}
+
+ virtual ~mesh() {
+ meshlink_close(this);
+ }
+
+ /** instead of registerin callbacks you derive your own class and overwrite the following abstract member functions.
+ * These functions are run in MeshLink's own thread.
+ * It is therefore important that these functions use apprioriate methods (queues, pipes, locking, etc.)
+ * to hand the data over to the application's thread.
+ * These functions should also not block itself and return as quickly as possible.
+ * The default member functions are no-ops, so you are not required to overwrite all these 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 */ }
+
+ /// 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 MeshLink has some information to log.
+ virtual void log(log_level_t level, const char* message) { /* do nothing */ }
+
/// 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.
*/
bool start() {
+ meshlink_set_receive_cb (this, &receive_trampoline);
+ meshlink_set_node_status_cb(this, &node_status_trampoline);
+ meshlink_set_log_cb (this, MESHLINK_DEBUG, &log_trampoline);
return meshlink_start(this);
}
meshlink_stop(this);
}
- /// Set the receive 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.
- * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
- * to hand the data over to the application's thread.
- * The callback should also not block itself and return as quickly as possible.
- *
- * @param cb A pointer to the function which will be called when another node sends data to the local node.
- */
- void set_receive_cb(receive_cb_t cb) {
- meshlink_set_receive_cb(this, (meshlink_receive_cb_t)cb);
- }
-
- /// Set the node status callback.
- /** This functions sets the callback that is called whenever another node's status changed.
- * The callback is run in MeshLink's own thread.
- * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
- * to hand the data over to the application's thread.
- * The callback should also not block itself and return as quickly as possible.
- *
- * @param cb A pointer to the function which will be called when another node's status changes.
- */
- void set_node_status_cb(node_status_cb_t cb) {
- meshlink_set_node_status_cb(this, (meshlink_node_status_cb_t)cb);
- }
-
- /// Set the log callback.
- /** This functions sets the callback that is called whenever MeshLink has some information to log.
- * The callback is run in MeshLink's own thread.
- * It is important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
- * to hand the data over to the application's thread.
- * The callback should also not block itself and return as quickly as possible.
- *
- * @param level An enum describing the minimum severity level. Debugging information with a lower level will not trigger the callback.
- * @param cb A pointer to the function which will be called when another node sends data to the local node.
- */
- void set_log_cb(meshlink_log_level_t level, log_cb_t cb) {
- meshlink_set_log_cb(this, level, (meshlink_log_cb_t)cb);
- }
-
/// Send data to another node.
/** This functions sends one packet of data to another node in the mesh.
* The packet is sent using UDP semantics, which means that
* @param nodes A pointer to an array of pointers to meshlink::node, which should be allocated by the application.
* @param nmemb The maximum number of pointers that can be stored in the nodes array.
*
- * @param return The number of known nodes. This can be larger than nmemb, in which case not all nodes were stored in the nodes array.
+ * @return The number of known nodes, or -1 in case of an error.
+ * This can be larger than nmemb, in which case not all nodes were stored in the nodes array.
*/
- size_t get_all_nodes(node **nodes, size_t nmemb) {
- return meshlink_get_all_nodes(this, (meshlink_node_t **)nodes, nmemb);
+ node **get_all_nodes(node **nodes, size_t *nmemb) {
+ return (node **)meshlink_get_all_nodes(this, (meshlink_node_t **)nodes, nmemb);
}
/// Sign data using the local node's MeshLink key.
*
* @param data A pointer to a buffer containing the data to be signed.
* @param len The length of the data to be signed.
+ * @param signature A pointer to a buffer where the signature will be stored.
+ * @param siglen The size of the signature buffer. Will be changed after the call to match the size of the signature itself.
*
- * @return This function returns a pointer to a string containing the signature, or NULL in case of an error.
- * The application should call free() after it has finished using the signature.
+ * @return This function returns true if the signature is valid, false otherwise.
*/
- char *sign(const char *data, size_t len) {
- return meshlink_sign(this, data, len);
+ bool sign(const void *data, size_t len, void *signature, size_t *siglen) {
+ return meshlink_sign(this, data, len, signature, siglen);
}
/// Verify the signature generated by another node of a piece of data.
* @param data A pointer to a buffer containing the data to be verified.
* @param len The length of the data to be verified.
* @param signature A pointer to a string containing the signature.
+ * @param siglen The size of the signature.
*
* @return This function returns true if the signature is valid, false otherwise.
*/
- bool verify(node *source, const char *data, size_t len, const char *signature) {
- return meshlink_verify(this, source, data, len, signature);
+ bool verify(node *source, const void *data, size_t len, const void *signature, size_t siglen) {
+ return meshlink_verify(this, source, data, len, signature, siglen);
}
/// Add an Address for the local node.
void blacklist(node *node) {
return meshlink_blacklist(this, node);
}
+
+ /// 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.
+ * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
+ * to hand the data over to the application's thread.
+ * The callback should also not block itself and return as quickly as possible.
+ *
+ * @param channel A handle for the channel.
+ * @param cb A pointer to the function which will be called when another node sends data to the local node.
+ */
+ void set_channel_accept_cb(channel *channel, channel_accept_cb_t cb) {
+ return meshlink_set_channel_accept_cb(this, (meshlink_channel_accept_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.
+ *
+ * @param node The node to which this channel is being initiated.
+ * @param port The port number the peer wishes to connect to.
+ * @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.
+ *
+ * @return A handle for the channel, or NULL in case of an error.
+ */
+ channel *channel_open(node *node, uint16_t port, channel_receive_cb_t cb, const void *data, size_t len) {
+ return (channel *)meshlink_channel_open(this, node, port, (meshlink_channel_receive_cb_t)cb, data, len);
+ }
+
+ /// Partially close a reliable stream channel.
+ /** This shuts down the read or write side of a channel, or both, without closing the handle.
+ * It can be used to inform the remote node that the local node has finished sending all data on the channel,
+ * but still allows waiting for incoming data from the remote node.
+ *
+ * @param channel A handle for the channel.
+ * @param direction Must be one of SHUT_RD, SHUT_WR or SHUT_RDWR.
+ */
+ void channel_shutdown(channel *channel, int direction) {
+ return meshlink_channel_shutdown(this, channel, direction);
+ }
+
+ /// Close a reliable stream channel.
+ /** This informs the remote node that the local node has finished sending all data on the channel.
+ * It also causes the local node to stop accepting incoming data from the remote node.
+ * Afterwards, the channel handle is invalid and must not be used any more.
+ *
+ * @param channel A handle for the channel.
+ */
+ void channel_close(meshlink_channel_t *channel) {
+ return meshlink_channel_close(this, channel);
+ }
+
+ /// Transmit data on a channel
+ /** This queues data to send to the remote node.
+ *
+ * @param channel A handle for the channel.
+ * @param data A pointer to a buffer containing data sent by the source.
+ * @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.
+ */
+ ssize_t channel_send(channel *channel, void *data, size_t len) {
+ return meshlink_channel_send(this, channel, data, len);
+ }
+
+ private:
+ // non-copyable:
+ 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)
+ {
+ mesh* that = static_cast<mesh*>(handle);
+ that->receive(static_cast<node*>(source), data, length);
+ }
+
+ static void node_status_trampoline(meshlink_handle_t* handle, meshlink_node_t* peer, bool reachable)
+ {
+ mesh* that = static_cast<mesh*>(handle);
+ that->node_status(static_cast<node*>(peer), reachable);
+ }
+
+ static void log_trampoline(meshlink_handle_t* handle, log_level_t level, const char* message)
+ {
+ mesh* that = static_cast<mesh*>(handle);
+ that->log(level, message);
+ }
};
/// Initialize MeshLink's configuration directory.
*
* @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.
*
* @return This function will return a pointer to a meshlink::mesh if MeshLink has succesfully set up its configuration files, NULL otherwise.
*/
- static mesh *open(const char *confbase, const char *name) {
- return (mesh *)meshlink_open(confbase, name);
+ template<class MESH>
+ static MESH* open(const char *confbase, const char *name, const char* appname, dclass_t dclass) {
+ void* mp = (void *)meshlink_open_with_size(confbase, name, appname, dclass, sizeof(MESH));
+ return new (mp) MESH;
}
/// Close the MeshLink handle.
static void close(mesh *mesh) {
meshlink_close(mesh);
}
-};
+
+ static const char *strerror(errno_t err = meshlink_errno) {
+ return meshlink_strerror(err);
+ }
+
+}
#endif // MESHLINKPP_H