X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=src%2Fmeshlink%2B%2B.h;h=f1a3b96270e44fb084c1a7648df4bef50a45832e;hb=b901fca3e5379b73f5080732b0bf2d43df4b9291;hp=3fa7774e0b9fa667ad42025455409d78e7dc3418;hpb=0058ff2373221bf19a6cd30a853c3e8d696c2e74;p=meshlink diff --git a/src/meshlink++.h b/src/meshlink++.h index 3fa7774e..f1a3b962 100644 --- a/src/meshlink++.h +++ b/src/meshlink++.h @@ -21,10 +21,12 @@ #define MESHLINKPP_H #include +#include // 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; @@ -54,71 +56,193 @@ namespace meshlink { */ 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 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, 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 callback that is called when data can be send on a channel. + /** @param mesh A handle which represents an instance of MeshLink. + * @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(). + */ + typedef void (*channel_poll_cb_t)(mesh *mesh, channel *channel, size_t len); + /// A class describing a MeshLink node. class node: public meshlink_node_t { }; - /// A class describing a MeshLink mesh. - class mesh: public meshlink_handle_t { - public: - // TODO: delete constructor, add a destructor. + /// A class describing a MeshLink channel. + class channel: public meshlink_channel_t { + }; - /// 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. + /// A class describing a MeshLink mesh. + class mesh { + public: + mesh() : handle(0) {} + + virtual ~mesh() { + this->close(); + } + + bool isOpen() const { + return (handle!=0); + } + +// TODO: please enable C++11 in autoconf to enable "move constructors": +// mesh(mesh&& other) +// : handle(other.handle) +// { +// if(handle) +// handle->priv = this; +// other.handle = 0; +// } + + /// Initialize MeshLink's configuration directory. + /** This function causes MeshLink to initialize its configuration directory, + * if it hasn't already been initialized. + * It only has to be run the first time the application starts, + * but it is not a problem if it is run more than once, as long as + * the arguments given are the same. * - * @return This function will return true if MeshLink has succesfully started its thread, false otherwise. - */ - bool start() { - return meshlink_start(this); + * This function does not start any network I/O yet. The application should + * first set callbacks, and then call meshlink_start(). + * + * @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. + */ + bool open(const char *confbase, const char *name, const char* appname, dev_class_t devclass) { + handle = meshlink_open(confbase, name, appname, devclass); + if(handle) + handle->priv = this; + + return isOpen(); } - - /// Stop MeshLink. - /** This function causes MeshLink to disconnect from all other nodes, - * close all sockets, and shut down its own thread. + + mesh(const char *confbase, const char *name, const char* appname, dev_class_t devclass) { + open(confbase, name, appname, devclass); + } + + /// Close the MeshLink handle. + /** This function calls meshlink_stop() if necessary, + * and frees all memory allocated by MeshLink. + * Afterwards, the handle and any pointers to a struct meshlink_node are invalid. */ - void stop() { - meshlink_stop(this); + void close() { + if(handle) + { + handle->priv = 0; + meshlink_close(handle); + } + handle=0; } - - /// 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.) + + /** 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 */ } + + /// This functions is called whenever another node attemps 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 + * channel_receive(). + * + * The function 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 cb A pointer to the function which will be called when another node sends data to the local node. + * @param channel A handle for the incoming channel. + * @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. */ - void set_receive_cb(receive_cb_t cb) { - meshlink_set_receive_cb(this, (meshlink_receive_cb_t)cb); + virtual bool channel_accept(channel *channel, uint16_t port, const void *data, size_t len) + { + /* by default reject all channels */ + return false; } - /// 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. + /// This function is called by Meshlink for receiving data from a channel. + /** + * The function 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. + * to pass data to or from 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. + * @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. */ - void set_node_status_cb(node_status_cb_t cb) { - meshlink_set_node_status_cb(this, (meshlink_node_status_cb_t)cb); - } + virtual void channel_receive(channel *channel, const void *data, size_t len) { /* do nothing */ } - /// 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. + /// This function is called by Meshlink when data can be send on a channel. + /** + * The function 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 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 */ } + + /// 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. * - * @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. + * @return This function will return true if MeshLink has succesfully 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_log_cb (handle, MESHLINK_DEBUG, &log_trampoline); + meshlink_set_channel_accept_cb(handle, &channel_accept_trampoline); + return meshlink_start (handle); + } + + /// Stop MeshLink. + /** This function causes MeshLink to disconnect from all other nodes, + * close all sockets, and shut down its own thread. */ - void set_log_cb(meshlink_log_level_t level, log_cb_t cb) { - meshlink_set_log_cb(this, level, (meshlink_log_cb_t)cb); + void stop() { + meshlink_stop(handle); } /// Send data to another node. @@ -135,7 +259,7 @@ namespace meshlink { * A return value of true does not guarantee that the message will actually arrive at the destination. */ bool send(node *destination, const void *data, unsigned int len) { - return meshlink_send(this, destination, data, len); + return meshlink_send(handle, destination, data, len); } /// Get a handle for a specific node. @@ -147,7 +271,7 @@ namespace meshlink { * or NULL if the requested node does not exist. */ node *get_node(const char *name) { - return (node *)meshlink_get_node(this, name); + return (node *)meshlink_get_node(handle, name); } /// Get a list of all nodes. @@ -156,10 +280,11 @@ namespace meshlink { * @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(handle, (meshlink_node_t **)nodes, nmemb); } /// Sign data using the local node's MeshLink key. @@ -168,12 +293,13 @@ namespace meshlink { * * @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(handle, data, len, signature, siglen); } /// Verify the signature generated by another node of a piece of data. @@ -183,11 +309,12 @@ namespace meshlink { * @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(handle, source, data, len, signature, siglen); } /// Add an Address for the local node. @@ -198,7 +325,7 @@ namespace meshlink { * @return This function returns true if the address was added, false otherwise. */ bool add_address(const char *address) { - return meshlink_add_address(this, address); + return meshlink_add_address(handle, address); } /// Invite another node into the mesh. @@ -213,7 +340,7 @@ namespace meshlink { * The application should call free() after it has finished using the URL. */ char *invite(const char *name) { - return meshlink_invite(this, name); + return meshlink_invite(handle, name); } /// Use an invitation to join a mesh. @@ -226,7 +353,7 @@ namespace meshlink { * @return This function returns true if the local node joined the mesh it was invited to, false otherwise. */ bool join(const char *invitation) { - return meshlink_join(this, invitation); + return meshlink_join(handle, invitation); } /// Export the local node's key and addresses. @@ -238,7 +365,7 @@ namespace meshlink { * The application should call free() after it has finished using this string. */ char *export_key() { - return meshlink_export(this); + return meshlink_export(handle); } /// Import another node's key and addresses. @@ -250,7 +377,7 @@ namespace meshlink { * @return This function returns true if the data was valid and the other node has been granted access to the mesh, false otherwise. */ bool import_key(const char *data) { - return meshlink_import(this, data); + return meshlink_import(handle, data); } /// Blacklist a node from the mesh. @@ -261,37 +388,158 @@ namespace meshlink { * @param node A pointer to a meshlink::node describing the node to be blacklisted. */ void blacklist(node *node) { - return meshlink_blacklist(this, node); + return meshlink_blacklist(handle, node); + } + + /// 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 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. + */ + void set_channel_poll_cb(channel *channel, channel_poll_cb_t cb) { + meshlink_set_channel_poll_cb(handle, 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 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. + * + * @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) { + channel *ch = (channel *)meshlink_channel_open(handle, node, port, (meshlink_channel_receive_cb_t)cb, data, len); + meshlink_set_channel_poll_cb(handle, ch, &channel_poll_trampoline); + return ch; + } + + /** + * @override + * Sets channel_receive_trampoline as cb, which in turn calls this->channel_receive( ... ). + */ + channel *channel_open(node *node, uint16_t port, const void *data, size_t len) { + channel *ch = (channel *)meshlink_channel_open(handle, node, port, &channel_receive_trampoline, data, len); + meshlink_set_channel_poll_cb(handle, ch, &channel_poll_trampoline); + return ch; + } + + /// 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(handle, 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(handle, 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(handle, 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) + { + if (!(handle->priv)) + return; + meshlink::mesh* that = static_cast(handle->priv); + that->receive(static_cast(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(handle->priv); + that->node_status(static_cast(peer), reachable); + } + + static void log_trampoline(meshlink_handle_t* handle, log_level_t level, const char* message) + { + if (!(handle->priv)) + return; + meshlink::mesh* that = static_cast(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)) + return false; + meshlink::mesh* that = static_cast(handle->priv); + bool accepted = that->channel_accept(static_cast(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)) + return; + meshlink::mesh* that = static_cast(handle->priv); + that->channel_receive(static_cast(channel), data, len); + } + + static void channel_poll_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, size_t len) + { + if (!(handle->priv)) + return; + meshlink::mesh* that = static_cast(handle->priv); + that->channel_poll(static_cast(channel), len); + } + + meshlink_handle_t* handle; }; - /// Initialize MeshLink's configuration directory. - /** This function causes MeshLink to initialize its configuration directory, - * if it hasn't already been initialized. - * It only has to be run the first time the application starts, - * but it is not a problem if it is run more than once, as long as - * the arguments given are the same. - * - * This function does not start any network I/O yet. The application should - * first set callbacks, and then call meshlink_start(). - * - * @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. - * - * @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); + static const char *strerror(errno_t err = meshlink_errno) { + return meshlink_strerror(err); } - /// Close the MeshLink handle. - /** This function calls meshlink_stop() if necessary, - * and frees all memory allocated by MeshLink. - * Afterwards, the handle and any pointers to a struct meshlink_node are invalid. - */ - static void close(mesh *mesh) { - meshlink_close(mesh); - } -}; +} #endif // MESHLINKPP_H