git.meshlink.io Git - meshlink/blob - src/meshlink++.h

   1 /*
   2     meshlink++.h -- MeshLink C++ API
   3     Copyright (C) 2014 Guus Sliepen <guus@meshlink.io>
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License along
  16     with this program; if not, write to the Free Software Foundation, Inc.,
  17     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef MESHLINKPP_H
  21 #define MESHLINKPP_H
  22
  23 #include <meshlink.h>
  24 #include <new> // for 'placement new'
  25
  26 namespace meshlink {
  27         class mesh;
  28         class node;
  29         class channel;
  30
  31         /// Severity of log messages generated by MeshLink.
  32         typedef meshlink_log_level_t log_level_t;
  33
  34         /// Code of most recent error encountered.
  35         typedef meshlink_errno_t errno_t;
  36
  37         /// A callback for receiving data from the mesh.
  38         /** @param mesh      A handle which represents an instance of MeshLink.
  39          *  @param source    A pointer to a meshlink::node describing the source of the data.
  40          *  @param data      A pointer to a buffer containing the data sent by the source.
  41          *  @param len       The length of the received data.
  42          */
  43         typedef void (*receive_cb_t)(mesh *mesh, node *source, const void *data, size_t len);
  44
  45         /// A callback reporting node status changes.
  46         /** @param mesh       A handle which represents an instance of MeshLink.
  47          *  @param node       A pointer to a meshlink::node describing the node whose status changed.
  48          *  @param reachable  True if the node is reachable, false otherwise.
  49          */
  50         typedef void (*node_status_cb_t)(mesh *mesh, node *node, bool reachable);
  51
  52         /// A callback for receiving log messages generated by MeshLink.
  53         /** @param mesh      A handle which represents an instance of MeshLink.
  54          *  @param level     An enum describing the severity level of the message.
  55          *  @param text      A pointer to a string containing the textual log message.
  56          */
  57         typedef void (*log_cb_t)(mesh *mesh, log_level_t level, const char *text);
  58
  59         /// A callback for accepting incoming channels.
  60         /** @param mesh         A handle which represents an instance of MeshLink.
  61          *  @param channel      A handle for the incoming channel.
  62          *  @param node         The node from which this channel is being initiated.
  63          *  @param port         The port number the peer wishes to connect to.
  64          *  @param data         A pointer to a buffer containing data already received. (Not yet used.)
  65          *  @param len          The length of the data. (Not yet used.)
  66          *
  67          *  @return             This function should return true if the application accepts the incoming channel, false otherwise.
  68          *                      If returning false, the channel is invalid and may not be used anymore.
  69          */
  70         typedef bool (*channel_accept_cb_t)(mesh *mesh, channel *channel, node *node, uint16_t port, const void *data, size_t len);
  71
  72         /// A callback for receiving data from a channel.
  73         /** @param mesh         A handle which represents an instance of MeshLink.
  74          *  @param channel      A handle for the channel.
  75          *  @param data         A pointer to a buffer containing data sent by the source.
  76          *  @param len          The length of the data.
  77          */
  78         typedef void (*channel_receive_cb_t)(mesh *mesh, channel *channel, const void *data, size_t len);
  79
  80         /// A callback that is called when data can be send on a channel.
  81         /** @param mesh         A handle which represents an instance of MeshLink.
  82          *  @param channel      A handle for the channel.
  83          *  @param len          The maximum length of data that is guaranteed to be accepted by a call to channel_send().
  84          */
  85         typedef void (*channel_poll_cb_t)(mesh *mesh, channel *channel, size_t len);
  86
  87         /// A class describing a MeshLink node.
  88         class node: public meshlink_node_t {
  89         };
  90
  91         /// A class describing a MeshLink channel.
  92         class channel: public meshlink_channel_t {
  93         };
  94
  95         /// A class describing a MeshLink mesh.
  96         class mesh: public meshlink_handle_t {
  97         public:
  98                 mesh() : meshlink_handle_t() {}
  99
 100                 virtual ~mesh() {
 101                         meshlink_close(this);
 102                 }
 103
 104                 /** instead of registerin callbacks you derive your own class and overwrite the following abstract member functions.
 105                  *  These functions are run in MeshLink's own thread.
 106                  *  It is therefore important that these functions use apprioriate methods (queues, pipes, locking, etc.)
 107                  *  to hand the data over to the application's thread.
 108                  *  These functions should also not block itself and return as quickly as possible.
 109                  * The default member functions are no-ops, so you are not required to overwrite all these member functions
 110                  */
 111
 112                 /// This function is called whenever another node sends data to the local node.
 113                 virtual void receive(node* source, const void* data, size_t length) { /* do nothing */ }
 114
 115                 /// This functions is called  whenever another node's status changed.
 116                 virtual void node_status(node* peer, bool reachable)                { /* do nothing */ }
 117
 118                 /// This functions is called whenever MeshLink has some information to log.
 119                 virtual void log(log_level_t level, const char* message)            { /* do nothing */ }
 120
 121                 /// Start MeshLink.
 122                 /** This function causes MeshLink to open network sockets, make outgoing connections, and
 123                  *  create a new thread, which will handle all network I/O.
 124                  *
 125                  *  @return         This function will return true if MeshLink has succesfully started its thread, false otherwise.
 126                  */
 127                 bool start() {
 128                         meshlink_set_receive_cb    (this, &receive_trampoline);
 129                         meshlink_set_node_status_cb(this, &node_status_trampoline);
 130                         meshlink_set_log_cb        (this, MESHLINK_DEBUG, &log_trampoline);
 131                         return meshlink_start(this);
 132                 }
 133
 134                 /// Stop MeshLink.
 135                 /** This function causes MeshLink to disconnect from all other nodes,
 136                  *  close all sockets, and shut down its own thread.
 137                  */
 138                 void stop() {
 139                         meshlink_stop(this);
 140                 }
 141
 142                 /// Send data to another node.
 143                 /** This functions sends one packet of data to another node in the mesh.
 144                  *  The packet is sent using UDP semantics, which means that
 145                  *  the packet is sent as one unit and is received as one unit,
 146                  *  and that there is no guarantee that the packet will arrive at the destination.
 147                  *  The application should take care of getting an acknowledgement and retransmission if necessary.
 148                  *
 149                  *  @param destination  A pointer to a meshlink::node describing the destination for the data.
 150                  *  @param data         A pointer to a buffer containing the data to be sent to the source.
 151                  *  @param len          The length of the data.
 152                  *  @return             This function will return true if MeshLink has queued the message for transmission, and false otherwise.
 153                  *                      A return value of true does not guarantee that the message will actually arrive at the destination.
 154                  */
 155                 bool send(node *destination, const void *data, unsigned int len) {
 156                         return meshlink_send(this, destination, data, len);
 157                 }
 158
 159                 /// Get a handle for a specific node.
 160                 /** This function returns a handle for the node with the given name.
 161                  *
 162                  *  @param name         The name of the node for which a handle is requested.
 163                  *
 164                  *  @return             A pointer to a meshlink::node which represents the requested node,
 165                  *                      or NULL if the requested node does not exist.
 166                  */
 167                 node *get_node(const char *name) {
 168                         return (node *)meshlink_get_node(this, name);
 169                 }
 170
 171                 /// Get a list of all nodes.
 172                 /** This function returns a list with handles for all known nodes.
 173                  *
 174                  *  @param nodes        A pointer to an array of pointers to meshlink::node, which should be allocated by the application.
 175                  *  @param nmemb        The maximum number of pointers that can be stored in the nodes array.
 176                  *
 177                  *  @return             The number of known nodes, or -1 in case of an error.
 178                  *                      This can be larger than nmemb, in which case not all nodes were stored in the nodes array.
 179                  */
 180                 node **get_all_nodes(node **nodes, size_t *nmemb) {
 181                         return (node **)meshlink_get_all_nodes(this, (meshlink_node_t **)nodes, nmemb);
 182                 }
 183
 184                 /// Sign data using the local node's MeshLink key.
 185                 /** This function signs data using the local node's MeshLink key.
 186                  *  The generated signature can be securely verified by other nodes.
 187                  *
 188                  *  @param data         A pointer to a buffer containing the data to be signed.
 189                  *  @param len          The length of the data to be signed.
 190                  *  @param signature    A pointer to a buffer where the signature will be stored.
 191                  *  @param siglen       The size of the signature buffer. Will be changed after the call to match the size of the signature itself.
 192                  *
 193                  *  @return             This function returns true if the signature is valid, false otherwise.
 194                  */
 195                 bool sign(const void *data, size_t len, void *signature, size_t *siglen) {
 196                         return meshlink_sign(this, data, len, signature, siglen);
 197                 }
 198
 199                 /// Verify the signature generated by another node of a piece of data.
 200                 /** This function verifies the signature that another node generated for a piece of data.
 201                  *
 202                  *  @param source       A pointer to a meshlink_node_t describing the source of the signature.
 203                  *  @param data         A pointer to a buffer containing the data to be verified.
 204                  *  @param len          The length of the data to be verified.
 205                  *  @param signature    A pointer to a string containing the signature.
 206                  *  @param siglen       The size of the signature.
 207                  *
 208                  *  @return             This function returns true if the signature is valid, false otherwise.
 209                  */
 210                 bool verify(node *source, const void *data, size_t len, const void *signature, size_t siglen) {
 211                         return meshlink_verify(this, source, data, len, signature, siglen);
 212                 }
 213
 214                 /// Add an Address for the local node.
 215                 /** This function adds an Address for the local node, which will be used for invitation URLs.
 216                  *
 217                  *  @param address      A string containing the address, which can be either in numeric format or a hostname.
 218                  *
 219                  *  @return             This function returns true if the address was added, false otherwise.
 220                  */
 221                 bool add_address(const char *address) {
 222                         return meshlink_add_address(this, address);
 223                 }
 224
 225                 /// Invite another node into the mesh.
 226                 /** This function generates an invitation that can be used by another node to join the same mesh as the local node.
 227                  *  The generated invitation is a string containing a URL.
 228                  *  This URL should be passed by the application to the invitee in a way that no eavesdroppers can see the URL.
 229                  *  The URL can only be used once, after the user has joined the mesh the URL is no longer valid.
 230                  *
 231                  *  @param name         The name that the invitee will use in the mesh.
 232                  *
 233                  *  @return             This function returns a string that contains the invitation URL.
 234                  *                      The application should call free() after it has finished using the URL.
 235                  */
 236                 char *invite(const char *name) {
 237                         return meshlink_invite(this, name);
 238                 }
 239
 240                 /// Use an invitation to join a mesh.
 241                 /** This function allows the local node to join an existing mesh using an invitation URL generated by another node.
 242                  *  An invitation can only be used if the local node has never connected to other nodes before.
 243                  *  After a succesfully accepted invitation, the name of the local node may have changed.
 244                  *
 245                  *  @param invitation   A string containing the invitation URL.
 246                  *
 247                  *  @return             This function returns true if the local node joined the mesh it was invited to, false otherwise.
 248                  */
 249                 bool join(const char *invitation) {
 250                         return meshlink_join(this, invitation);
 251                 }
 252
 253                 /// Export the local node's key and addresses.
 254                 /** This function generates a string that contains the local node's public key and one or more IP addresses.
 255                  *  The application can pass it in some way to another node, which can then import it,
 256                  *  granting the local node access to the other node's mesh.
 257                  *
 258                  *  @return             This function returns a string that contains the exported key and addresses.
 259                  *                      The application should call free() after it has finished using this string.
 260                  */
 261                 char *export_key() {
 262                         return meshlink_export(this);
 263                 }
 264
 265                 /// Import another node's key and addresses.
 266                 /** This function accepts a string containing the exported public key and addresses of another node.
 267                  *  By importing this data, the local node grants the other node access to its mesh.
 268                  *
 269                  *  @param data         A string containing the other node's exported key and addresses.
 270                  *
 271                  *  @return             This function returns true if the data was valid and the other node has been granted access to the mesh, false otherwise.
 272                  */
 273                 bool import_key(const char *data) {
 274                         return meshlink_import(this, data);
 275                 }
 276
 277                 /// Blacklist a node from the mesh.
 278                 /** This function causes the local node to blacklist another node.
 279                  *  The local node will drop any existing connections to that node,
 280                  *  and will not send data to it nor accept any data received from it any more.
 281                  *
 282                  *  @param node         A pointer to a meshlink::node describing the node to be blacklisted.
 283                  */
 284                 void blacklist(node *node) {
 285                         return meshlink_blacklist(this, node);
 286                 }
 287
 288                 /// Set the accept callback.
 289                 /** This functions sets the callback that is called whenever another node sends data to the local node.
 290                  *  The callback is run in MeshLink's own thread.
 291                  *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
 292                  *  to hand the data over to the application's thread.
 293                  *  The callback should also not block itself and return as quickly as possible.
 294                  *
 295                  *  @param channel   A handle for the channel.
 296                  *  @param cb        A pointer to the function which will be called when another node sends data to the local node.
 297                  */
 298                 void set_channel_accept_cb(channel *channel, channel_accept_cb_t cb) {
 299                         return meshlink_set_channel_accept_cb(this, (meshlink_channel_accept_cb_t)cb);
 300                 }
 301
 302                 /// Set the poll callback.
 303                 /** This functions sets the callback that is called whenever data can be sent to another node.
 304                  *  The callback is run in MeshLink's own thread.
 305                  *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
 306                  *  to pass data to or from the application's thread.
 307                  *  The callback should also not block itself and return as quickly as possible.
 308                  *
 309                  *  @param channel   A handle for the channel.
 310                  *  @param cb        A pointer to the function which will be called when data can be sent to another node.
 311                  *                   If a NULL pointer is given, the callback will be disabled.
 312                  */
 313                 void set_channel_poll_cb(channel *channel, channel_poll_cb_t cb) {
 314                         return meshlink_set_channel_poll_cb(this, (meshlink_channel_poll_cb_t)cb);
 315                 }
 316
 317                 /// Open a reliable stream channel to another node.
 318                 /** This function is called whenever a remote node wants to open a channel to the local node.
 319                  *  The application then has to decide whether to accept or reject this channel.
 320                  *
 321                  *  @param node         The node to which this channel is being initiated.
 322                  *  @param port         The port number the peer wishes to connect to.
 323                  *  @param cb           A pointer to the function which will be called when the remote node sends data to the local node.
 324                  *  @param data         A pointer to a buffer containing data to already queue for sending.
 325                  *  @param len          The length of the data.
 326                  *
 327                  *  @return             A handle for the channel, or NULL in case of an error.
 328                  */
 329                 channel *channel_open(node *node, uint16_t port, channel_receive_cb_t cb, const void *data, size_t len) {
 330                         return (channel *)meshlink_channel_open(this, node, port, (meshlink_channel_receive_cb_t)cb, data, len);
 331                 }
 332
 333                 /// Partially close a reliable stream channel.
 334                 /** This shuts down the read or write side of a channel, or both, without closing the handle.
 335                  *  It can be used to inform the remote node that the local node has finished sending all data on the channel,
 336                  *  but still allows waiting for incoming data from the remote node.
 337                  *
 338                  *  @param channel      A handle for the channel.
 339                  *  @param direction    Must be one of SHUT_RD, SHUT_WR or SHUT_RDWR.
 340                  */
 341                 void channel_shutdown(channel *channel, int direction) {
 342                         return meshlink_channel_shutdown(this, channel, direction);
 343                 }
 344
 345                 /// Close a reliable stream channel.
 346                 /** This informs the remote node that the local node has finished sending all data on the channel.
 347                  *  It also causes the local node to stop accepting incoming data from the remote node.
 348                  *  Afterwards, the channel handle is invalid and must not be used any more.
 349                  *
 350                  *  @param channel      A handle for the channel.
 351                  */
 352                 void channel_close(meshlink_channel_t *channel) {
 353                         return meshlink_channel_close(this, channel);
 354                 }
 355
 356                 /// Transmit data on a channel
 357                 /** This queues data to send to the remote node.
 358                  *
 359                  *  @param channel      A handle for the channel.
 360                  *  @param data         A pointer to a buffer containing data sent by the source.
 361                  *  @param len          The length of the data.
 362                  *
 363                  *  @return             The amount of data that was queued, which can be less than len, or a negative value in case of an error.
 364                  */
 365                 ssize_t channel_send(channel *channel, void *data, size_t len) {
 366                         return meshlink_channel_send(this, channel, data, len);
 367                 }
 368
 369         private:
 370                 // non-copyable:
 371                 mesh(const mesh&) /* TODO: C++11: = delete */;
 372                 void operator=(const mesh&) /* TODO: C++11: = delete */ ;
 373
 374                 /// static callback trampolines:
 375                 static void receive_trampoline(meshlink_handle_t* handle, meshlink_node_t* source, const void* data, size_t length)
 376                 {
 377                         mesh* that = static_cast<mesh*>(handle);
 378                         that->receive(static_cast<node*>(source), data, length);
 379                 }
 380
 381                 static void node_status_trampoline(meshlink_handle_t* handle, meshlink_node_t* peer, bool reachable)
 382                 {
 383                         mesh* that = static_cast<mesh*>(handle);
 384                         that->node_status(static_cast<node*>(peer), reachable);
 385                 }
 386
 387                 static void log_trampoline(meshlink_handle_t* handle, log_level_t level, const char* message)
 388                 {
 389                         mesh* that = static_cast<mesh*>(handle);
 390                         that->log(level, message);
 391                 }
 392         };
 393
 394         /// Initialize MeshLink's configuration directory.
 395         /** This function causes MeshLink to initialize its configuration directory,
 396          *  if it hasn't already been initialized.
 397          *  It only has to be run the first time the application starts,
 398          *  but it is not a problem if it is run more than once, as long as
 399          *  the arguments given are the same.
 400          *
 401          *  This function does not start any network I/O yet. The application should
 402          *  first set callbacks, and then call meshlink_start().
 403          *
 404          *  @param confbase The directory in which MeshLink will store its configuration files.
 405          *  @param name     The name which this instance of the application will use in the mesh.
 406          *  @param appname  The application name which will be used in the mesh.
 407          *  @param dclass   The device class which will be used in the mesh.
 408          *
 409          *  @return         This function will return a pointer to a meshlink::mesh if MeshLink has succesfully set up its configuration files, NULL otherwise.
 410          */
 411         template<class MESH>
 412         static MESH* open(const char *confbase, const char *name, const char* appname, dev_class_t devclass) {
 413                 void* mp = (void *)meshlink_open_with_size(confbase, name, appname, devclass, sizeof(MESH));
 414                 return new (mp) MESH;
 415         }
 416
 417         /// Close the MeshLink handle.
 418         /** This function calls meshlink_stop() if necessary,
 419          *  and frees all memory allocated by MeshLink.
 420          *  Afterwards, the handle and any pointers to a struct meshlink_node are invalid.
 421          */
 422         static void close(mesh *mesh) {
 423                 meshlink_close(mesh);
 424         }
 425
 426         static const char *strerror(errno_t err = meshlink_errno) {
 427                 return meshlink_strerror(err);
 428         }
 429
 430 }
 431
 432 #endif // MESHLINKPP_H