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

   1 #ifndef MESHLINKPP_H
   2 #define MESHLINKPP_H
   3
   4 /*
   5     meshlink++.h -- MeshLink C++ API
   6     Copyright (C) 2014, 2017 Guus Sliepen <guus@meshlink.io>
   7
   8     This program is free software; you can redistribute it and/or modify
   9     it under the terms of the GNU General Public License as published by
  10     the Free Software Foundation; either version 2 of the License, or
  11     (at your option) any later version.
  12
  13     This program is distributed in the hope that it will be useful,
  14     but WITHOUT ANY WARRANTY; without even the implied warranty of
  15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16     GNU General Public License for more details.
  17
  18     You should have received a copy of the GNU General Public License along
  19     with this program; if not, write to the Free Software Foundation, Inc.,
  20     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21 */
  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 class submesh;
  31
  32 /// Severity of log messages generated by MeshLink.
  33 typedef meshlink_log_level_t log_level_t;
  34
  35 /// Code of most recent error encountered.
  36 typedef meshlink_errno_t errno_t;
  37
  38 /// A callback for receiving data from the mesh.
  39 /** @param mesh      A handle which represents an instance of MeshLink.
  40  *  @param source    A pointer to a meshlink::node describing the source of the data.
  41  *  @param data      A pointer to a buffer containing the data sent by the source.
  42  *  @param len       The length of the received data.
  43  */
  44 typedef void (*receive_cb_t)(mesh *mesh, node *source, const void *data, size_t len);
  45
  46 /// A callback reporting the meta-connection attempt made by the host node to an another node.
  47 /** @param mesh      A handle which represents an instance of MeshLink.
  48  *  @param node      A pointer to a meshlink_node_t describing the node to whom meta-connection is being tried.
  49  *                   This pointer is valid until meshlink_close() is called.
  50  */
  51 typedef void (*connection_try_cb_t)(mesh *mesh, node *node);
  52
  53 /// A callback reporting node status changes.
  54 /** @param mesh       A handle which represents an instance of MeshLink.
  55  *  @param node       A pointer to a meshlink::node describing the node whose status changed.
  56  *  @param reachable  True if the node is reachable, false otherwise.
  57  */
  58 typedef void (*node_status_cb_t)(mesh *mesh, node *node, bool reachable);
  59
  60 /// A callback reporting duplicate node detection.
  61 /** @param mesh       A handle which represents an instance of MeshLink.
  62  *  @param node       A pointer to a meshlink_node_t describing the node which is duplicate.
  63  *                    This pointer is valid until meshlink_close() is called.
  64  */
  65 typedef void (*duplicate_cb_t)(mesh *mesh, node *node);
  66
  67 /// A callback for receiving log messages generated by MeshLink.
  68 /** @param mesh      A handle which represents an instance of MeshLink.
  69  *  @param level     An enum describing the severity level of the message.
  70  *  @param text      A pointer to a string containing the textual log message.
  71  */
  72 typedef void (*log_cb_t)(mesh *mesh, log_level_t level, const char *text);
  73
  74 /// A callback for accepting incoming channels.
  75 /** @param mesh         A handle which represents an instance of MeshLink.
  76  *  @param channel      A handle for the incoming channel.
  77  *  @param port         The port number the peer wishes to connect to.
  78  *  @param data         A pointer to a buffer containing data already received. (Not yet used.)
  79  *  @param len          The length of the data. (Not yet used.)
  80  *
  81  *  @return             This function should return true if the application accepts the incoming channel, false otherwise.
  82  *                      If returning false, the channel is invalid and may not be used anymore.
  83  */
  84 typedef bool (*channel_accept_cb_t)(mesh *mesh, channel *channel, uint16_t port, const void *data, size_t len);
  85
  86 /// A callback for receiving data from a channel.
  87 /** @param mesh         A handle which represents an instance of MeshLink.
  88  *  @param channel      A handle for the channel.
  89  *  @param data         A pointer to a buffer containing data sent by the source.
  90  *  @param len          The length of the data.
  91  */
  92 typedef void (*channel_receive_cb_t)(mesh *mesh, channel *channel, const void *data, size_t len);
  93
  94 /// A callback that is called when data can be send on a channel.
  95 /** @param mesh         A handle which represents an instance of MeshLink.
  96  *  @param channel      A handle for the channel.
  97  *  @param len          The maximum length of data that is guaranteed to be accepted by a call to channel_send().
  98  */
  99 typedef void (*channel_poll_cb_t)(mesh *mesh, channel *channel, size_t len);
 100
 101 /// A class describing a MeshLink node.
 102 class node: public meshlink_node_t {
 103 };
 104
 105 /// A class describing a MeshLink Sub-Mesh.
 106 class submesh: public meshlink_submesh_t {
 107 };
 108
 109 /// A class describing a MeshLink channel.
 110 class channel: public meshlink_channel_t {
 111 public:
 112         static const uint32_t RELIABLE = MESHLINK_CHANNEL_RELIABLE;
 113         static const uint32_t ORDERED = MESHLINK_CHANNEL_ORDERED;
 114         static const uint32_t FRAMED = MESHLINK_CHANNEL_FRAMED;
 115         static const uint32_t DROP_LATE = MESHLINK_CHANNEL_DROP_LATE;
 116         static const uint32_t NO_PARTIAL = MESHLINK_CHANNEL_NO_PARTIAL;
 117         static const uint32_t TCP = MESHLINK_CHANNEL_TCP;
 118         static const uint32_t UDP = MESHLINK_CHANNEL_UDP;
 119 };
 120
 121 /// A class describing a MeshLink mesh.
 122 class mesh {
 123 public:
 124         mesh() : handle(0) {}
 125
 126         virtual ~mesh() {
 127                 this->close();
 128         }
 129
 130         bool isOpen() const {
 131                 return (handle != 0);
 132         }
 133
 134 // TODO: please enable C++11 in autoconf to enable "move constructors":
 135 //              mesh(mesh&& other)
 136 //              : handle(other.handle)
 137 //              {
 138 //                      if(handle)
 139 //                              handle->priv = this;
 140 //                      other.handle = 0;
 141 //              }
 142
 143         /// Initialize MeshLink's configuration directory.
 144         /** This function causes MeshLink to initialize its configuration directory,
 145          *  if it hasn't already been initialized.
 146          *  It only has to be run the first time the application starts,
 147          *  but it is not a problem if it is run more than once, as long as
 148          *  the arguments given are the same.
 149          *
 150          *  This function does not start any network I/O yet. The application should
 151          *  first set callbacks, and then call meshlink_start().
 152          *
 153          *  @param confbase The directory in which MeshLink will store its configuration files.
 154          *  @param name     The name which this instance of the application will use in the mesh.
 155          *  @param appname  The application name which will be used in the mesh.
 156          *  @param devclass The device class which will be used in the mesh.
 157          *
 158          *  @return         This function will return a pointer to a meshlink::mesh if MeshLink has successfully set up its configuration files, NULL otherwise.
 159          */
 160         bool open(const char *confbase, const char *name, const char *appname, dev_class_t devclass) {
 161                 handle = meshlink_open(confbase, name, appname, devclass);
 162
 163                 if(handle) {
 164                         handle->priv = this;
 165                 }
 166
 167                 return isOpen();
 168         }
 169
 170         mesh(const char *confbase, const char *name, const char *appname, dev_class_t devclass) {
 171                 open(confbase, name, appname, devclass);
 172         }
 173
 174         /// Close the MeshLink handle.
 175         /** This function calls meshlink_stop() if necessary,
 176          *  and frees all memory allocated by MeshLink.
 177          *  Afterwards, the handle and any pointers to a struct meshlink_node are invalid.
 178          */
 179         void close() {
 180                 if(handle) {
 181                         handle->priv = 0;
 182                         meshlink_close(handle);
 183                 }
 184
 185                 handle = 0;
 186         }
 187
 188         /** instead of registerin callbacks you derive your own class and overwrite the following abstract member functions.
 189          *  These functions are run in MeshLink's own thread.
 190          *  It is therefore important that these functions use apprioriate methods (queues, pipes, locking, etc.)
 191          *  to hand the data over to the application's thread.
 192          *  These functions should also not block itself and return as quickly as possible.
 193          * The default member functions are no-ops, so you are not required to overwrite all these member functions
 194          */
 195
 196         /// This function is called whenever another node sends data to the local node.
 197         virtual void receive(node *source, const void *data, size_t length) {
 198                 /* do nothing */
 199                 (void)source;
 200                 (void)data;
 201                 (void) length;
 202         }
 203
 204         /// This functions is called whenever another node's status changed.
 205         virtual void node_status(node *peer, bool reachable) {
 206                 /* do nothing */
 207                 (void)peer;
 208                 (void)reachable;
 209         }
 210
 211         /// This functions is called whenever a duplicate node is detected.
 212         virtual void node_duplicate(node *peer) {
 213                 /* do nothing */
 214                 (void)peer;
 215         }
 216
 217         /// This functions is called whenever MeshLink has some information to log.
 218         virtual void log(log_level_t level, const char *message) {
 219                 /* do nothing */
 220                 (void)level;
 221                 (void)message;
 222         }
 223
 224         /// This functions is called whenever MeshLink a meta-connection attempt is made.
 225         virtual void connection_try(node *peer) {
 226                 /* do nothing */
 227                 (void)peer;
 228         }
 229
 230         /// This functions is called whenever another node attempts to open a channel to the local node.
 231         /**
 232          *  If the channel is accepted, the poll_callback will be set to channel_poll and can be
 233          *  changed using set_channel_poll_cb(). Likewise, the receive callback is set to
 234          *  channel_receive().
 235          *
 236          *  The function is run in MeshLink's own thread.
 237          *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
 238          *  to pass data to or from the application's thread.
 239          *  The callback should also not block itself and return as quickly as possible.
 240          *
 241          *  @param channel      A handle for the incoming channel.
 242          *  @param port         The port number the peer wishes to connect to.
 243          *  @param data         A pointer to a buffer containing data already received. (Not yet used.)
 244          *  @param len          The length of the data. (Not yet used.)
 245          *
 246          *  @return             This function should return true if the application accepts the incoming channel, false otherwise.
 247          *                      If returning false, the channel is invalid and may not be used anymore.
 248          */
 249         virtual bool channel_accept(channel *channel, uint16_t port, const void *data, size_t len) {
 250                 /* by default reject all channels */
 251                 (void)channel;
 252                 (void)port;
 253                 (void)data;
 254                 (void)len;
 255                 return false;
 256         }
 257
 258         /// This function is called by Meshlink for receiving data from a channel.
 259         /**
 260          *  The function is run in MeshLink's own thread.
 261          *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
 262          *  to pass data to or from the application's thread.
 263          *  The callback should also not block itself and return as quickly as possible.
 264          *
 265          *  @param channel      A handle for the channel.
 266          *  @param data         A pointer to a buffer containing data sent by the source.
 267          *  @param len          The length of the data.
 268          */
 269         virtual void channel_receive(channel *channel, const void *data, size_t len) {
 270                 /* do nothing */
 271                 (void)channel;
 272                 (void)data;
 273                 (void)len;
 274         }
 275
 276         /// This function is called by Meshlink when data can be send on a channel.
 277         /**
 278          *  The function is run in MeshLink's own thread.
 279          *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
 280          *  to pass data to or from the application's thread.
 281          *
 282          *  The callback should also not block itself and return as quickly as possible.
 283          *  @param channel      A handle for the channel.
 284          *  @param len          The maximum length of data that is guaranteed to be accepted by a call to channel_send().
 285          */
 286         virtual void channel_poll(channel *channel, size_t len) {
 287                 /* do nothing */
 288                 (void)channel;
 289                 (void)len;
 290         }
 291
 292         /// Start MeshLink.
 293         /** This function causes MeshLink to open network sockets, make outgoing connections, and
 294          *  create a new thread, which will handle all network I/O.
 295          *
 296          *  @return         This function will return true if MeshLink has successfully started its thread, false otherwise.
 297          */
 298         bool start() {
 299                 meshlink_set_receive_cb(handle, &receive_trampoline);
 300                 meshlink_set_node_status_cb(handle, &node_status_trampoline);
 301                 meshlink_set_node_duplicate_cb(handle, &node_duplicate_trampoline);
 302                 meshlink_set_log_cb(handle, MESHLINK_DEBUG, &log_trampoline);
 303                 meshlink_set_channel_accept_cb(handle, &channel_accept_trampoline);
 304                 meshlink_set_connection_try_cb(handle, &connection_try_trampoline);
 305                 return meshlink_start(handle);
 306         }
 307
 308         /// Stop MeshLink.
 309         /** This function causes MeshLink to disconnect from all other nodes,
 310          *  close all sockets, and shut down its own thread.
 311          */
 312         void stop() {
 313                 meshlink_stop(handle);
 314         }
 315
 316         /// Send data to another node.
 317         /** This functions sends one packet of data to another node in the mesh.
 318          *  The packet is sent using UDP semantics, which means that
 319          *  the packet is sent as one unit and is received as one unit,
 320          *  and that there is no guarantee that the packet will arrive at the destination.
 321          *  The application should take care of getting an acknowledgement and retransmission if necessary.
 322          *
 323          *  @param destination  A pointer to a meshlink::node describing the destination for the data.
 324          *  @param data         A pointer to a buffer containing the data to be sent to the source.
 325          *  @param len          The length of the data.
 326          *  @return             This function will return true if MeshLink has queued the message for transmission, and false otherwise.
 327          *                      A return value of true does not guarantee that the message will actually arrive at the destination.
 328          */
 329         bool send(node *destination, const void *data, unsigned int len) {
 330                 return meshlink_send(handle, destination, data, len);
 331         }
 332
 333         /// Get a handle for a specific node.
 334         /** This function returns a handle for the node with the given name.
 335          *
 336          *  @param name         The name of the node for which a handle is requested.
 337          *
 338          *  @return             A pointer to a meshlink::node which represents the requested node,
 339          *                      or NULL if the requested node does not exist.
 340          */
 341         node *get_node(const char *name) {
 342                 return (node *)meshlink_get_node(handle, name);
 343         }
 344
 345         /// Get a handle for a specific submesh.
 346         /** This function returns a handle for the submesh with the given name.
 347          *
 348          *  @param name         The name of the submesh for which a handle is requested.
 349          *
 350          *  @return             A pointer to a meshlink::submesh which represents the requested submesh,
 351          *                      or NULL if the requested submesh does not exist.
 352          */
 353         submesh *get_submesh(const char *name) {
 354                 return (submesh *)meshlink_get_submesh(handle, name);
 355         }
 356
 357         /// Get a handle for our own node.
 358         /** This function returns a handle for the local node.
 359          *
 360          *  @return             A pointer to a meshlink::node which represents the local node.
 361          */
 362         node *get_self() {
 363                 return (node *)meshlink_get_self(handle);
 364         }
 365
 366         /// Get a list of all nodes.
 367         /** This function returns a list with handles for all known nodes.
 368          *
 369          *  @param nodes        A pointer to an array of pointers to meshlink::node, which should be allocated by the application.
 370          *  @param nmemb        The maximum number of pointers that can be stored in the nodes array.
 371          *
 372          *  @return             The number of known nodes, or -1 in case of an error.
 373          *                      This can be larger than nmemb, in which case not all nodes were stored in the nodes array.
 374          */
 375         node **get_all_nodes(node **nodes, size_t *nmemb) {
 376                 return (node **)meshlink_get_all_nodes(handle, (meshlink_node_t **)nodes, nmemb);
 377         }
 378
 379         /// Sign data using the local node's MeshLink key.
 380         /** This function signs data using the local node's MeshLink key.
 381          *  The generated signature can be securely verified by other nodes.
 382          *
 383          *  @param data         A pointer to a buffer containing the data to be signed.
 384          *  @param len          The length of the data to be signed.
 385          *  @param signature    A pointer to a buffer where the signature will be stored.
 386          *  @param siglen       The size of the signature buffer. Will be changed after the call to match the size of the signature itself.
 387          *
 388          *  @return             This function returns true if the signature is valid, false otherwise.
 389          */
 390         bool sign(const void *data, size_t len, void *signature, size_t *siglen) {
 391                 return meshlink_sign(handle, data, len, signature, siglen);
 392         }
 393
 394         /// Verify the signature generated by another node of a piece of data.
 395         /** This function verifies the signature that another node generated for a piece of data.
 396          *
 397          *  @param source       A pointer to a meshlink_node_t describing the source of the signature.
 398          *  @param data         A pointer to a buffer containing the data to be verified.
 399          *  @param len          The length of the data to be verified.
 400          *  @param signature    A pointer to a string containing the signature.
 401          *  @param siglen       The size of the signature.
 402          *
 403          *  @return             This function returns true if the signature is valid, false otherwise.
 404          */
 405         bool verify(node *source, const void *data, size_t len, const void *signature, size_t siglen) {
 406                 return meshlink_verify(handle, source, data, len, signature, siglen);
 407         }
 408
 409         /// Set the canonical Address for a node.
 410         /** This function sets the canonical Address for a node.
 411          *  This address is stored permanently until it is changed by another call to this function,
 412          *  unlike other addresses associated with a node,
 413          *  such as those added with meshlink_hint_address() or addresses discovered at runtime.
 414          *
 415          *  If a canonical Address is set for the local node,
 416          *  it will be used for the hostname part of generated invitation URLs.
 417          *
 418          *  @param node         A pointer to a meshlink_node_t describing the node.
 419          *  @param address      A nul-terminated C string containing the address, which can be either in numeric format or a hostname.
 420          *  @param port         A nul-terminated C string containing the port, which can be either in numeric or symbolic format.
 421          *                      If it is NULL, the listening port's number will be used.
 422          *
 423          *  @return             This function returns true if the address was added, false otherwise.
 424          */
 425         bool set_canonical_address(node *node, const char *address, const char *port = NULL) {
 426                 return meshlink_set_canonical_address(handle, node, address, port);
 427         }
 428
 429         /// Set the canonical Address for the local node.
 430         /** This function sets the canonical Address for the local node.
 431          *  This address is stored permanently until it is changed by another call to this function,
 432          *  unlike other addresses associated with a node,
 433          *  such as those added with meshlink_hint_address() or addresses discovered at runtime.
 434          *
 435          *  @param address      A nul-terminated C string containing the address, which can be either in numeric format or a hostname.
 436          *  @param port         A nul-terminated C string containing the port, which can be either in numeric or symbolic format.
 437          *                      If it is NULL, the listening port's number will be used.
 438          *
 439          *  @return             This function returns true if the address was added, false otherwise.
 440          */
 441         bool set_canonical_address(const char *address, const char *port = NULL) {
 442                 return meshlink_set_canonical_address(handle, get_self(), address, port);
 443         }
 444
 445         /// Add an Address for the local node.
 446         /** This function adds an Address for the local node, which will be used for invitation URLs.
 447          *
 448          *  @param address      A string containing the address, which can be either in numeric format or a hostname.
 449          *
 450          *  @return             This function returns true if the address was added, false otherwise.
 451          */
 452         bool add_address(const char *address) {
 453                 return meshlink_add_address(handle, address);
 454         }
 455
 456         /** This function performs tries to discover the local node's external address
 457          *  by contacting the meshlink.io server. If a reverse lookup of the address works,
 458          *  the FQDN associated with the address will be returned.
 459          *
 460          *  Please note that this is function only returns a single address,
 461          *  even if the local node might have more than one external address.
 462          *  In that case, there is no control over which address will be selected.
 463          *  Also note that if you have a dynamic IP address, or are behind carrier-grade NAT,
 464          *  there is no guarantee that the external address will be valid for an extended period of time.
 465          *
 466          *  This function is blocking. It can take several seconds before it returns.
 467          *  There is no guarantee it will be able to resolve the external address.
 468          *  Failures might be because by temporary network outages.
 469          *
 470          *  @param family       The address family to check, for example AF_INET or AF_INET6. If AF_UNSPEC is given,
 471          *                      this might return the external address for any working address family.
 472          *
 473          *  @return             This function returns a pointer to a C string containing the discovered external address,
 474          *                      or NULL if there was an error looking up the address.
 475          *                      After get_external_address() returns, the application is free to overwrite or free this string.
 476          */
 477         bool get_external_address(int family = AF_UNSPEC) {
 478                 return meshlink_get_external_address_for_family(handle, family);
 479         }
 480
 481         /** This function performs tries to discover the address of the local interface used for outgoing connection.
 482          *
 483          *  Please note that this is function only returns a single address,
 484          *  even if the local node might have more than one external address.
 485          *  In that case, there is no control over which address will be selected.
 486          *  Also note that if you have a dynamic IP address, or are behind carrier-grade NAT,
 487          *  there is no guarantee that the external address will be valid for an extended period of time.
 488          *
 489          *  This function will fail if it couldn't find a local address for the given address family.
 490          *  If hostname resolving is requested, this function may block for a few seconds.
 491          *
 492          *  @param family       The address family to check, for example AF_INET or AF_INET6. If AF_UNSPEC is given,
 493          *                      this might return the external address for any working address family.
 494          *
 495          *  @return             This function returns a pointer to a C string containing the discovered external address,
 496          *                      or NULL if there was an error looking up the address.
 497          *                      After get_external_address() returns, the application is free to overwrite or free this string.
 498          */
 499         bool get_local_address(int family = AF_UNSPEC) {
 500                 return meshlink_get_local_address_for_family(handle, family);
 501         }
 502
 503         /// Try to discover the external address for the local node, and add it to its list of addresses.
 504         /** This function is equivalent to:
 505          *
 506          *    mesh->add_address(mesh->get_external_address());
 507          *
 508          *  Read the description of get_external_address() for the limitations of this function.
 509          *
 510          *  @return             This function returns true if the address was added, false otherwise.
 511          */
 512         bool add_external_address() {
 513                 return meshlink_add_external_address(handle);
 514         }
 515
 516         /// Get the network port used by the local node.
 517         /** This function returns the network port that the local node is listening on.
 518          *
 519          *  @return              This function returns the port number, or -1 in case of an error.
 520          */
 521         int get_port() {
 522                 return meshlink_get_port(handle);
 523         }
 524
 525         /// Set the network port used by the local node.
 526         /** This function sets the network port that the local node is listening on.
 527          *  It may only be called when the mesh is not running.
 528          *  If unsure, call stop() before calling this function.
 529          *  Also note that if your node is already part of a mesh with other nodes,
 530          *  that the other nodes may no longer be able to initiate connections to the local node,
 531          *  since they will try to connect to the previously configured port.
 532          *
 533          *  @param port          The port number to listen on. This must be between 0 and 65535.
 534          *                       If the port is set to 0, then MeshLink will listen on a port
 535          *                       that is randomly assigned by the operating system every time open() is called.
 536          *
 537          *  @return              This function returns true if the port was successfully changed
 538          *                       to the desired port, false otherwise. If it returns false, there
 539          *                       is no guarantee that MeshLink is listening on the old port.
 540          */
 541         bool set_port(int port) {
 542                 return meshlink_set_port(handle, port);
 543         }
 544
 545         /// Set the timeout for invitations.
 546         /** This function sets the timeout for invitations.
 547          *  The timeout is retroactively applied to all outstanding invitations.
 548          *
 549          *  @param timeout      The timeout for invitations in seconds.
 550          */
 551         void set_invitation_timeout(int timeout) {
 552                 meshlink_set_invitation_timeout(handle, timeout);
 553         }
 554
 555         /// Invite another node into the mesh.
 556         /** This function generates an invitation that can be used by another node to join the same mesh as the local node.
 557          *  The generated invitation is a string containing a URL.
 558          *  This URL should be passed by the application to the invitee in a way that no eavesdroppers can see the URL.
 559          *  The URL can only be used once, after the user has joined the mesh the URL is no longer valid.
 560          *
 561          *  @param submesh      A handle to the submesh to put the invitee in.
 562          *  @param name         The name that the invitee will use in the mesh.
 563          *  @param flags        A bitwise-or'd combination of flags that controls how the URL is generated.
 564          *
 565          *  @return             This function returns a string that contains the invitation URL.
 566          *                      The application should call free() after it has finished using the URL.
 567          */
 568         char *invite(submesh *submesh, const char *name, uint32_t flags = 0) {
 569                 return meshlink_invite_ex(handle, submesh, name, flags);
 570         }
 571
 572         /// Use an invitation to join a mesh.
 573         /** This function allows the local node to join an existing mesh using an invitation URL generated by another node.
 574          *  An invitation can only be used if the local node has never connected to other nodes before.
 575          *  After a successfully accepted invitation, the name of the local node may have changed.
 576          *
 577          *  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.
 578          *
 579          *  This function is blocking. It can take several seconds before it returns.
 580          *  There is no guarantee it will perform a successful join.
 581          *  Failures might be caused by temporary network outages, or by the invitation having expired.
 582          *
 583          *  @param invitation   A string containing the invitation URL.
 584          *
 585          *  @return             This function returns true if the local node joined the mesh it was invited to, false otherwise.
 586          */
 587         bool join(const char *invitation) {
 588                 return meshlink_join(handle, invitation);
 589         }
 590
 591         /// Export the local node's key and addresses.
 592         /** This function generates a string that contains the local node's public key and one or more IP addresses.
 593          *  The application can pass it in some way to another node, which can then import it,
 594          *  granting the local node access to the other node's mesh.
 595          *
 596          *  @return             This function returns a string that contains the exported key and addresses.
 597          *                      The application should call free() after it has finished using this string.
 598          */
 599         char *export_key() {
 600                 return meshlink_export(handle);
 601         }
 602
 603         /// Import another node's key and addresses.
 604         /** This function accepts a string containing the exported public key and addresses of another node.
 605          *  By importing this data, the local node grants the other node access to its mesh.
 606          *
 607          *  @param data         A string containing the other node's exported key and addresses.
 608          *
 609          *  @return             This function returns true if the data was valid and the other node has been granted access to the mesh, false otherwise.
 610          */
 611         bool import_key(const char *data) {
 612                 return meshlink_import(handle, data);
 613         }
 614
 615         /// Blacklist a node from the mesh.
 616         /** This function causes the local node to blacklist another node.
 617          *  The local node will drop any existing connections to that node,
 618          *  and will not send data to it nor accept any data received from it any more.
 619          *
 620          *  @param node         A pointer to a meshlink::node describing the node to be blacklisted.
 621          */
 622         void blacklist(node *node) {
 623                 return meshlink_blacklist(handle, node);
 624         }
 625
 626         /// Set the poll callback.
 627         /** This functions sets the callback that is called whenever data can be sent to another node.
 628          *  The callback is run in MeshLink's own thread.
 629          *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
 630          *  to pass data to or from the application's thread.
 631          *  The callback should also not block itself and return as quickly as possible.
 632          *
 633          *  @param channel   A handle for the channel.
 634          *  @param cb        A pointer to the function which will be called when data can be sent to another node.
 635          *                   If a NULL pointer is given, the callback will be disabled.
 636          */
 637         void set_channel_poll_cb(channel *channel, channel_poll_cb_t cb) {
 638                 meshlink_set_channel_poll_cb(handle, channel, (meshlink_channel_poll_cb_t)cb);
 639         }
 640
 641         /// Open a reliable stream channel to another node.
 642         /** This function is called whenever a remote node wants to open a channel to the local node.
 643          *  The application then has to decide whether to accept or reject this channel.
 644          *
 645          *  This function sets the channel poll callback to channel_poll_trampoline, which in turn
 646          *  calls channel_poll. To set a different, channel-specific poll callback, use set_channel_poll_cb.
 647          *
 648          *  @param node         The node to which this channel is being initiated.
 649          *  @param port         The port number the peer wishes to connect to.
 650          *  @param cb           A pointer to the function which will be called when the remote node sends data to the local node.
 651          *  @param data         A pointer to a buffer containing data to already queue for sending.
 652          *  @param len          The length of the data.
 653          *  @param flags        A bitwise-or'd combination of flags that set the semantics for this channel.
 654          *
 655          *  @return             A handle for the channel, or NULL in case of an error.
 656          */
 657         channel *channel_open(node *node, uint16_t port, channel_receive_cb_t cb, const void *data, size_t len, uint32_t flags = channel::TCP) {
 658                 channel *ch = (channel *)meshlink_channel_open_ex(handle, node, port, (meshlink_channel_receive_cb_t)cb, data, len, flags);
 659                 meshlink_set_channel_poll_cb(handle, ch, &channel_poll_trampoline);
 660                 return ch;
 661         }
 662
 663         /// Open a reliable stream channel to another node.
 664         /** This function is called whenever a remote node wants to open a channel to the local node.
 665          *  The application then has to decide whether to accept or reject this channel.
 666          *
 667          *  This function sets the channel receive callback to channel_receive_trampoline,
 668          *  which in turn calls channel_receive.
 669          *
 670          *  This function sets the channel poll callback to channel_poll_trampoline, which in turn
 671          *  calls channel_poll. To set a different, channel-specific poll callback, use set_channel_poll_cb.
 672          *
 673          *  @param node         The node to which this channel is being initiated.
 674          *  @param port         The port number the peer wishes to connect to.
 675          *  @param data         A pointer to a buffer containing data to already queue for sending.
 676          *  @param len          The length of the data.
 677          *  @param flags        A bitwise-or'd combination of flags that set the semantics for this channel.
 678          *
 679          *  @return             A handle for the channel, or NULL in case of an error.
 680          */
 681         channel *channel_open(node *node, uint16_t port, const void *data, size_t len, uint32_t flags = channel::TCP) {
 682                 channel *ch = (channel *)meshlink_channel_open_ex(handle, node, port, &channel_receive_trampoline, data, len, flags);
 683                 meshlink_set_channel_poll_cb(handle, ch, &channel_poll_trampoline);
 684                 return ch;
 685         }
 686
 687         /// Partially close a reliable stream channel.
 688         /** This shuts down the read or write side of a channel, or both, without closing the handle.
 689          *  It can be used to inform the remote node that the local node has finished sending all data on the channel,
 690          *  but still allows waiting for incoming data from the remote node.
 691          *
 692          *  @param channel      A handle for the channel.
 693          *  @param direction    Must be one of SHUT_RD, SHUT_WR or SHUT_RDWR.
 694          */
 695         void channel_shutdown(channel *channel, int direction) {
 696                 return meshlink_channel_shutdown(handle, channel, direction);
 697         }
 698
 699         /// Close a reliable stream channel.
 700         /** This informs the remote node that the local node has finished sending all data on the channel.
 701          *  It also causes the local node to stop accepting incoming data from the remote node.
 702          *  Afterwards, the channel handle is invalid and must not be used any more.
 703          *
 704          *  @param channel      A handle for the channel.
 705          */
 706         void channel_close(meshlink_channel_t *channel) {
 707                 return meshlink_channel_close(handle, channel);
 708         }
 709
 710         /// Transmit data on a channel
 711         /** This queues data to send to the remote node.
 712          *
 713          *  @param channel      A handle for the channel.
 714          *  @param data         A pointer to a buffer containing data sent by the source.
 715          *  @param len          The length of the data.
 716          *
 717          *  @return             The amount of data that was queued, which can be less than len, or a negative value in case of an error.
 718          *                      If MESHLINK_CHANNEL_NO_PARTIAL is set, then the result will either be len,
 719          *                      0 if the buffer is currently too full, or -1 if len is too big even for an empty buffer.
 720          */
 721         ssize_t channel_send(channel *channel, void *data, size_t len) {
 722                 return meshlink_channel_send(handle, channel, data, len);
 723         }
 724
 725         /// Get the amount of bytes in the send buffer.
 726         /** This returns the amount of bytes in the send buffer.
 727          *  These bytes have not been received by the peer yet.
 728          *
 729          *  @param channel      A handle for the channel.
 730          *
 731          *  @return             The amount of un-ACKed bytes in the send buffer.
 732          */
 733         size_t channel_get_sendq(channel *channel) {
 734                 return meshlink_channel_get_sendq(handle, channel);
 735         }
 736
 737         /// Get the amount of bytes in the receive buffer.
 738         /** This returns the amount of bytes in the receive buffer.
 739          *  These bytes have not been processed by the application yet.
 740          *
 741          *  @param channel      A handle for the channel.
 742          *
 743          *  @return             The amount of bytes in the receive buffer.
 744          */
 745         size_t channel_get_recvq(channel *channel) {
 746                 return meshlink_channel_get_recvq(handle, channel);
 747         }
 748
 749         /// Enable or disable zeroconf discovery of local peers
 750         /** This controls whether zeroconf discovery using the Catta library will be
 751          *  enabled to search for peers on the local network. By default, it is enabled.
 752          *
 753          *  @param enable  Set to true to enable discovery, false to disable.
 754          */
 755         void enable_discovery(bool enable = true) {
 756                 meshlink_enable_discovery(handle, enable);
 757         }
 758
 759 private:
 760         // non-copyable:
 761         mesh(const mesh &) /* TODO: C++11: = delete */;
 762         void operator=(const mesh &) /* TODO: C++11: = delete */;
 763
 764         /// static callback trampolines:
 765         static void receive_trampoline(meshlink_handle_t *handle, meshlink_node_t *source, const void *data, size_t length) {
 766                 if(!(handle->priv)) {
 767                         return;
 768                 }
 769
 770                 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
 771                 that->receive(static_cast<node *>(source), data, length);
 772         }
 773
 774         static void node_status_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer, bool reachable) {
 775                 if(!(handle->priv)) {
 776                         return;
 777                 }
 778
 779                 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
 780                 that->node_status(static_cast<node *>(peer), reachable);
 781         }
 782
 783         static void node_duplicate_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer) {
 784                 if(!(handle->priv)) {
 785                         return;
 786                 }
 787
 788                 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
 789                 that->node_duplicate(static_cast<node *>(peer));
 790         }
 791
 792         static void log_trampoline(meshlink_handle_t *handle, log_level_t level, const char *message) {
 793                 if(!(handle->priv)) {
 794                         return;
 795                 }
 796
 797                 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
 798                 that->log(level, message);
 799         }
 800
 801         static void connection_try_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer) {
 802                 if(!(handle->priv)) {
 803                         return;
 804                 }
 805
 806                 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
 807                 that->connection_try(static_cast<node *>(peer));
 808         }
 809
 810         static bool channel_accept_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, uint16_t port, const void *data, size_t len) {
 811                 if(!(handle->priv)) {
 812                         return false;
 813                 }
 814
 815                 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
 816                 bool accepted = that->channel_accept(static_cast<meshlink::channel *>(channel), port, data, len);
 817
 818                 if(accepted) {
 819                         meshlink_set_channel_receive_cb(handle, channel, &channel_receive_trampoline);
 820                         meshlink_set_channel_poll_cb(handle, channel, &channel_poll_trampoline);
 821                 }
 822
 823                 return accepted;
 824         }
 825
 826         static void channel_receive_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, const void *data, size_t len) {
 827                 if(!(handle->priv)) {
 828                         return;
 829                 }
 830
 831                 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
 832                 that->channel_receive(static_cast<meshlink::channel *>(channel), data, len);
 833         }
 834
 835         static void channel_poll_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, size_t len) {
 836                 if(!(handle->priv)) {
 837                         return;
 838                 }
 839
 840                 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
 841                 that->channel_poll(static_cast<meshlink::channel *>(channel), len);
 842         }
 843
 844         meshlink_handle_t *handle;
 845 };
 846
 847 static inline const char *strerror(errno_t err = meshlink_errno) {
 848         return meshlink_strerror(err);
 849 }
 850
 851 /// Destroy a MeshLink instance.
 852 /** This function remove all configuration files of a MeshLink instance. It should only be called when the application
 853  *  does not have an open handle to this instance. Afterwards, a call to meshlink_open() will create a completely
 854  *  new instance.
 855  *
 856  *  @param confbase The directory in which MeshLink stores its configuration files.
 857  *                  After the function returns, the application is free to overwrite or free @a confbase @a.
 858  *
 859  *  @return         This function will return true if the MeshLink instance was successfully destroyed, false otherwise.
 860  */
 861 static inline bool destroy(const char *confbase) {
 862         return meshlink_destroy(confbase);
 863 }
 864 }
 865
 866 #endif