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