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 node path MTU changes.
  61 /** @param mesh       A handle which represents an instance of MeshLink.
  62  *  @param node       A pointer to a meshlink_node_t describing the node whose status changed.
  63  *                    This pointer is valid until meshlink_close() is called.
  64  *  @param pmtu       The current path MTU to the node, or 0 if UDP communication is not (yet) possible.
  65  */
  66 typedef void (*node_pmtu_cb_t)(mesh *mesh, node *node, uint16_t pmtu);
  67
  68 /// A callback reporting duplicate node detection.
  69 /** @param mesh       A handle which represents an instance of MeshLink.
  70  *  @param node       A pointer to a meshlink_node_t describing the node which is duplicate.
  71  *                    This pointer is valid until meshlink_close() is called.
  72  */
  73 typedef void (*duplicate_cb_t)(mesh *mesh, node *node);
  74
  75 /// A callback for receiving log messages generated by MeshLink.
  76 /** @param mesh      A handle which represents an instance of MeshLink.
  77  *  @param level     An enum describing the severity level of the message.
  78  *  @param text      A pointer to a string containing the textual log message.
  79  */
  80 typedef void (*log_cb_t)(mesh *mesh, log_level_t level, const char *text);
  81
  82 /// A callback for listening for incoming channels.
  83 /** @param mesh         A handle which represents an instance of MeshLink.
  84  *  @param node         A handle for the node that wants to open a channel.
  85  *  @param port         The port number the peer wishes to connect to.
  86  *
  87  *  @return             This function should return true if the application listens for the incoming channel, false otherwise.
  88  */
  89 typedef bool (*meshlink_channel_listen_cb_t)(struct meshlink_handle *mesh, struct meshlink_node *node, uint16_t port);
  90
  91 /// A callback for accepting incoming channels.
  92 /** @param mesh         A handle which represents an instance of MeshLink.
  93  *  @param channel      A handle for the incoming channel.
  94  *  @param port         The port number the peer wishes to connect to.
  95  *  @param data         A pointer to a buffer containing data already received. (Not yet used.)
  96  *  @param len          The length of the data. (Not yet used.)
  97  *
  98  *  @return             This function should return true if the application accepts the incoming channel, false otherwise.
  99  *                      If returning false, the channel is invalid and may not be used anymore.
 100  */
 101 typedef bool (*channel_accept_cb_t)(mesh *mesh, channel *channel, uint16_t port, const void *data, size_t len);
 102
 103 /// A callback for receiving data from a channel.
 104 /** @param mesh         A handle which represents an instance of MeshLink.
 105  *  @param channel      A handle for the channel.
 106  *  @param data         A pointer to a buffer containing data sent by the source.
 107  *  @param len          The length of the data.
 108  */
 109 typedef void (*channel_receive_cb_t)(mesh *mesh, channel *channel, const void *data, size_t len);
 110
 111 /// A callback that is called when data can be send on a channel.
 112 /** @param mesh         A handle which represents an instance of MeshLink.
 113  *  @param channel      A handle for the channel.
 114  *  @param len          The maximum length of data that is guaranteed to be accepted by a call to channel_send().
 115  */
 116 typedef void (*channel_poll_cb_t)(mesh *mesh, channel *channel, size_t len);
 117
 118 /// A callback for cleaning up buffers submitted for asynchronous I/O.
 119 /** This callbacks signals that MeshLink has finished using this buffer.
 120  *  The ownership of the buffer is now back into the application's hands.
 121  *
 122  *  @param mesh      A handle which represents an instance of MeshLink.
 123  *  @param channel   A handle for the channel which used this buffer.
 124  *  @param data      A pointer to a buffer containing the enqueued data.
 125  *  @param len       The length of the buffer.
 126  *  @param priv      A private pointer which was set by the application when submitting the buffer.
 127  */
 128 typedef void (*aio_cb_t)(mesh *mesh, channel *channel, const void *data, size_t len, void *priv);
 129
 130 /// A callback for asynchronous I/O to and from filedescriptors.
 131 /** This callbacks signals that MeshLink has finished using this filedescriptor.
 132  *
 133  *  @param mesh      A handle which represents an instance of MeshLink.
 134  *  @param channel   A handle for the channel which used this filedescriptor.
 135  *  @param fd        The filedescriptor that was used.
 136  *  @param len       The length of the data that was successfully sent or received.
 137  *  @param priv      A private pointer which was set by the application when submitting the buffer.
 138  */
 139 typedef void (*aio_fd_cb_t)(mesh *mesh, channel *channel, int fd, size_t len, void *priv);
 140
 141 /// A class describing a MeshLink node.
 142 class node: public meshlink_node_t {
 143 };
 144
 145 /// A class describing a MeshLink Sub-Mesh.
 146 class submesh: public meshlink_submesh_t {
 147 };
 148
 149 /// A class describing a MeshLink channel.
 150 class channel: public meshlink_channel_t {
 151 public:
 152         static const uint32_t RELIABLE = MESHLINK_CHANNEL_RELIABLE;
 153         static const uint32_t ORDERED = MESHLINK_CHANNEL_ORDERED;
 154         static const uint32_t FRAMED = MESHLINK_CHANNEL_FRAMED;
 155         static const uint32_t DROP_LATE = MESHLINK_CHANNEL_DROP_LATE;
 156         static const uint32_t NO_PARTIAL = MESHLINK_CHANNEL_NO_PARTIAL;
 157         static const uint32_t TCP = MESHLINK_CHANNEL_TCP;
 158         static const uint32_t UDP = MESHLINK_CHANNEL_UDP;
 159 };
 160
 161 /// A class describing a MeshLink mesh.
 162 class mesh {
 163 public:
 164         mesh() : handle(0) {}
 165
 166         virtual ~mesh() {
 167                 this->close();
 168         }
 169
 170         bool isOpen() const {
 171                 return (handle != 0);
 172         }
 173
 174 // TODO: please enable C++11 in autoconf to enable "move constructors":
 175 //              mesh(mesh&& other)
 176 //              : handle(other.handle)
 177 //              {
 178 //                      if(handle)
 179 //                              handle->priv = this;
 180 //                      other.handle = 0;
 181 //              }
 182
 183         /// Initialize MeshLink's configuration directory.
 184         /** This function causes MeshLink to initialize its configuration directory,
 185          *  if it hasn't already been initialized.
 186          *  It only has to be run the first time the application starts,
 187          *  but it is not a problem if it is run more than once, as long as
 188          *  the arguments given are the same.
 189          *
 190          *  This function does not start any network I/O yet. The application should
 191          *  first set callbacks, and then call meshlink_start().
 192          *
 193          *  @param confbase The directory in which MeshLink will store its configuration files.
 194          *  @param name     The name which this instance of the application will use in the mesh.
 195          *  @param appname  The application name which will be used in the mesh.
 196          *  @param devclass The device class which will be used in the mesh.
 197          *
 198          *  @return         This function will return a pointer to a meshlink::mesh if MeshLink has successfully set up its configuration files, NULL otherwise.
 199          */
 200         bool open(const char *confbase, const char *name, const char *appname, dev_class_t devclass) {
 201                 handle = meshlink_open(confbase, name, appname, devclass);
 202
 203                 if(handle) {
 204                         handle->priv = this;
 205                 }
 206
 207                 return isOpen();
 208         }
 209
 210         mesh(const char *confbase, const char *name, const char *appname, dev_class_t devclass) {
 211                 open(confbase, name, appname, devclass);
 212         }
 213
 214         /// Close the MeshLink handle.
 215         /** This function calls meshlink_stop() if necessary,
 216          *  and frees all memory allocated by MeshLink.
 217          *  Afterwards, the handle and any pointers to a struct meshlink_node are invalid.
 218          */
 219         void close() {
 220                 if(handle) {
 221                         handle->priv = 0;
 222                         meshlink_close(handle);
 223                 }
 224
 225                 handle = 0;
 226         }
 227
 228         /** instead of registerin callbacks you derive your own class and overwrite the following abstract member functions.
 229          *  These functions are run in MeshLink's own thread.
 230          *  It is therefore important that these functions use apprioriate methods (queues, pipes, locking, etc.)
 231          *  to hand the data over to the application's thread.
 232          *  These functions should also not block itself and return as quickly as possible.
 233          * The default member functions are no-ops, so you are not required to overwrite all these member functions
 234          */
 235
 236         /// This function is called whenever another node sends data to the local node.
 237         virtual void receive(node *source, const void *data, size_t length) {
 238                 /* do nothing */
 239                 (void)source;
 240                 (void)data;
 241                 (void) length;
 242         }
 243
 244         /// This functions is called whenever another node's status changed.
 245         virtual void node_status(node *peer, bool reachable) {
 246                 /* do nothing */
 247                 (void)peer;
 248                 (void)reachable;
 249         }
 250
 251         /// This functions is called whenever another node's path MTU changes.
 252         virtual void node_pmtu(node *peer, uint16_t pmtu) {
 253                 /* do nothing */
 254                 (void)peer;
 255                 (void)pmtu;
 256         }
 257
 258         /// This functions is called whenever a duplicate node is detected.
 259         virtual void node_duplicate(node *peer) {
 260                 /* do nothing */
 261                 (void)peer;
 262         }
 263
 264         /// This functions is called whenever MeshLink has some information to log.
 265         virtual void log(log_level_t level, const char *message) {
 266                 /* do nothing */
 267                 (void)level;
 268                 (void)message;
 269         }
 270
 271         /// This functions is called whenever MeshLink has encountered a serious error.
 272         virtual void error(meshlink_errno_t meshlink_errno) {
 273                 /* do nothing */
 274                 (void)meshlink_errno;
 275         }
 276
 277         /// This functions is called whenever MeshLink a meta-connection attempt is made.
 278         virtual void connection_try(node *peer) {
 279                 /* do nothing */
 280                 (void)peer;
 281         }
 282
 283         /// This functions is called to determine if we are listening for incoming channels.
 284         /**
 285          *  The function is run in MeshLink's own thread.
 286          *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
 287          *  to pass data to or from the application's thread.
 288          *  The callback should also not block itself and return as quickly as possible.
 289          *
 290          *  @param node         A handle for the node that wants to open a channel.
 291          *  @param port         The port number the peer wishes to connect to.
 292          *
 293          *  @return             This function should return true if the application accepts the incoming channel, false otherwise.
 294          */
 295         virtual bool channel_listen(node *node, uint16_t port) {
 296                 /* by default accept all channels */
 297                 (void)node;
 298                 (void)port;
 299                 return true;
 300         }
 301
 302         /// This functions is called whenever another node attempts to open a channel to the local node.
 303         /**
 304          *  If the channel is accepted, the poll_callback will be set to channel_poll and can be
 305          *  changed using set_channel_poll_cb(). Likewise, the receive callback is set to
 306          *  channel_receive().
 307          *
 308          *  The function is run in MeshLink's own thread.
 309          *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
 310          *  to pass data to or from the application's thread.
 311          *  The callback should also not block itself and return as quickly as possible.
 312          *
 313          *  @param channel      A handle for the incoming channel.
 314          *  @param port         The port number the peer wishes to connect to.
 315          *  @param data         A pointer to a buffer containing data already received. (Not yet used.)
 316          *  @param len          The length of the data. (Not yet used.)
 317          *
 318          *  @return             This function should return true if the application accepts the incoming channel, false otherwise.
 319          *                      If returning false, the channel is invalid and may not be used anymore.
 320          */
 321         virtual bool channel_accept(channel *channel, uint16_t port, const void *data, size_t len) {
 322                 /* by default reject all channels */
 323                 (void)channel;
 324                 (void)port;
 325                 (void)data;
 326                 (void)len;
 327                 return false;
 328         }
 329
 330         /// This function is called by Meshlink for receiving data from a channel.
 331         /**
 332          *  The function is run in MeshLink's own thread.
 333          *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
 334          *  to pass data to or from the application's thread.
 335          *  The callback should also not block itself and return as quickly as possible.
 336          *
 337          *  @param channel      A handle for the channel.
 338          *  @param data         A pointer to a buffer containing data sent by the source.
 339          *  @param len          The length of the data.
 340          */
 341         virtual void channel_receive(channel *channel, const void *data, size_t len) {
 342                 /* do nothing */
 343                 (void)channel;
 344                 (void)data;
 345                 (void)len;
 346         }
 347
 348         /// This function is called by Meshlink when data can be send on a channel.
 349         /**
 350          *  The function is run in MeshLink's own thread.
 351          *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
 352          *  to pass data to or from the application's thread.
 353          *
 354          *  The callback should also not block itself and return as quickly as possible.
 355          *  @param channel      A handle for the channel.
 356          *  @param len          The maximum length of data that is guaranteed to be accepted by a call to channel_send().
 357          */
 358         virtual void channel_poll(channel *channel, size_t len) {
 359                 /* do nothing */
 360                 (void)channel;
 361                 (void)len;
 362         }
 363
 364         /// Start MeshLink.
 365         /** This function causes MeshLink to open network sockets, make outgoing connections, and
 366          *  create a new thread, which will handle all network I/O.
 367          *
 368          *  @return         This function will return true if MeshLink has successfully started its thread, false otherwise.
 369          */
 370         bool start() {
 371                 meshlink_set_receive_cb(handle, &receive_trampoline);
 372                 meshlink_set_node_status_cb(handle, &node_status_trampoline);
 373                 meshlink_set_node_pmtu_cb(handle, &node_pmtu_trampoline);
 374                 meshlink_set_node_duplicate_cb(handle, &node_duplicate_trampoline);
 375                 meshlink_set_log_cb(handle, MESHLINK_DEBUG, &log_trampoline);
 376                 meshlink_set_error_cb(handle, &error_trampoline);
 377                 meshlink_set_channel_listen_cb(handle, &channel_listen_trampoline);
 378                 meshlink_set_channel_accept_cb(handle, &channel_accept_trampoline);
 379                 meshlink_set_connection_try_cb(handle, &connection_try_trampoline);
 380                 return meshlink_start(handle);
 381         }
 382
 383         /// Stop MeshLink.
 384         /** This function causes MeshLink to disconnect from all other nodes,
 385          *  close all sockets, and shut down its own thread.
 386          */
 387         void stop() {
 388                 meshlink_stop(handle);
 389         }
 390
 391         /// Send data to another node.
 392         /** This functions sends one packet of data to another node in the mesh.
 393          *  The packet is sent using UDP semantics, which means that
 394          *  the packet is sent as one unit and is received as one unit,
 395          *  and that there is no guarantee that the packet will arrive at the destination.
 396          *  The application should take care of getting an acknowledgement and retransmission if necessary.
 397          *
 398          *  @param destination  A pointer to a meshlink::node describing the destination for the data.
 399          *  @param data         A pointer to a buffer containing the data to be sent to the source.
 400          *  @param len          The length of the data.
 401          *  @return             This function will return true if MeshLink has queued the message for transmission, and false otherwise.
 402          *                      A return value of true does not guarantee that the message will actually arrive at the destination.
 403          */
 404         bool send(node *destination, const void *data, unsigned int len) {
 405                 return meshlink_send(handle, destination, data, len);
 406         }
 407
 408         /// Get a handle for a specific node.
 409         /** This function returns a handle for the node with the given name.
 410          *
 411          *  @param name         The name of the node for which a handle is requested.
 412          *
 413          *  @return             A pointer to a meshlink::node which represents the requested node,
 414          *                      or NULL if the requested node does not exist.
 415          */
 416         node *get_node(const char *name) {
 417                 return (node *)meshlink_get_node(handle, name);
 418         }
 419
 420         /// Get a node's reachability status.
 421         /** This function returns the current reachability of a given node, and the times of the last state changes.
 422          *  If a given state change never happened, the time returned will be 0.
 423          *
 424          *  @param node              A pointer to a meshlink::node describing the node.
 425          *  @param last_reachable    A pointer to a time_t variable that will be filled in with the last time the node became reachable.
 426          *  @param last_unreachable  A pointer to a time_t variable that will be filled in with the last time the node became unreachable.
 427          *
 428          *  @return                  This function returns true if the node is currently reachable, false otherwise.
 429          */
 430         bool get_node_reachability(node *node, time_t *last_reachable = NULL, time_t *last_unreachable = NULL) {
 431                 return meshlink_get_node_reachability(handle, node, last_reachable, last_unreachable);
 432         }
 433
 434         /// Get a handle for a specific submesh.
 435         /** This function returns a handle for the submesh with the given name.
 436          *
 437          *  @param name         The name of the submesh for which a handle is requested.
 438          *
 439          *  @return             A pointer to a meshlink::submesh which represents the requested submesh,
 440          *                      or NULL if the requested submesh does not exist.
 441          */
 442         submesh *get_submesh(const char *name) {
 443                 return (submesh *)meshlink_get_submesh(handle, name);
 444         }
 445
 446         /// Get a handle for our own node.
 447         /** This function returns a handle for the local node.
 448          *
 449          *  @return             A pointer to a meshlink::node which represents the local node.
 450          */
 451         node *get_self() {
 452                 return (node *)meshlink_get_self(handle);
 453         }
 454
 455         /// Get a list of all nodes.
 456         /** This function returns a list with handles for all known nodes.
 457          *
 458          *  @param nodes        A pointer to an array of pointers to meshlink::node, which should be allocated by the application.
 459          *  @param nmemb        The maximum number of pointers that can be stored in the nodes array.
 460          *
 461          *  @return             The number of known nodes, or -1 in case of an error.
 462          *                      This can be larger than nmemb, in which case not all nodes were stored in the nodes array.
 463          */
 464         node **get_all_nodes(node **nodes, size_t *nmemb) {
 465                 return (node **)meshlink_get_all_nodes(handle, (meshlink_node_t **)nodes, nmemb);
 466         }
 467
 468         /// Sign data using the local node's MeshLink key.
 469         /** This function signs data using the local node's MeshLink key.
 470          *  The generated signature can be securely verified by other nodes.
 471          *
 472          *  @param data         A pointer to a buffer containing the data to be signed.
 473          *  @param len          The length of the data to be signed.
 474          *  @param signature    A pointer to a buffer where the signature will be stored.
 475          *  @param siglen       The size of the signature buffer. Will be changed after the call to match the size of the signature itself.
 476          *
 477          *  @return             This function returns true if the signature is valid, false otherwise.
 478          */
 479         bool sign(const void *data, size_t len, void *signature, size_t *siglen) {
 480                 return meshlink_sign(handle, data, len, signature, siglen);
 481         }
 482
 483         /// Verify the signature generated by another node of a piece of data.
 484         /** This function verifies the signature that another node generated for a piece of data.
 485          *
 486          *  @param source       A pointer to a meshlink_node_t describing the source of the signature.
 487          *  @param data         A pointer to a buffer containing the data to be verified.
 488          *  @param len          The length of the data to be verified.
 489          *  @param signature    A pointer to a string containing the signature.
 490          *  @param siglen       The size of the signature.
 491          *
 492          *  @return             This function returns true if the signature is valid, false otherwise.
 493          */
 494         bool verify(node *source, const void *data, size_t len, const void *signature, size_t siglen) {
 495                 return meshlink_verify(handle, source, data, len, signature, siglen);
 496         }
 497
 498         /// Set the canonical Address for a node.
 499         /** This function sets the canonical Address for a node.
 500          *  This address is stored permanently until it is changed by another call to this function,
 501          *  unlike other addresses associated with a node,
 502          *  such as those added with meshlink_hint_address() or addresses discovered at runtime.
 503          *
 504          *  If a canonical Address is set for the local node,
 505          *  it will be used for the hostname part of generated invitation URLs.
 506          *
 507          *  @param node         A pointer to a meshlink_node_t describing the node.
 508          *  @param address      A nul-terminated C string containing the address, which can be either in numeric format or a hostname.
 509          *  @param port         A nul-terminated C string containing the port, which can be either in numeric or symbolic format.
 510          *                      If it is NULL, the listening port's number will be used.
 511          *
 512          *  @return             This function returns true if the address was added, false otherwise.
 513          */
 514         bool set_canonical_address(node *node, const char *address, const char *port = NULL) {
 515                 return meshlink_set_canonical_address(handle, node, address, port);
 516         }
 517
 518         /// Clear the canonical Address for a node.
 519         /** This function clears the canonical Address for a node.
 520          *
 521          *  @param mesh         A handle which represents an instance of MeshLink.
 522          *  @param node         A pointer to a struct meshlink_node describing the node.
 523          *
 524          *  @return             This function returns true if the address was removed, false otherwise.
 525          */
 526         bool clear_canonical_address(node *node) {
 527                 return meshlink_clear_canonical_address(handle, node);
 528         }
 529
 530         /// Add an invitation address for the local node.
 531         /** This function adds an address for the local node, which will be used only for invitation URLs.
 532          *  This address is not stored permanently.
 533          *  Multiple addresses can be added using multiple calls to this function.
 534          *
 535          *  @param address      A nul-terminated C string containing the address, which can be either in numeric format or a hostname.
 536          *  @param port         A nul-terminated C string containing the port, which can be either in numeric or symbolic format.
 537          *                      If it is NULL, the listening port's number will be used.
 538          *
 539          *  @return             This function returns true if the address was added, false otherwise.
 540          */
 541         bool add_invitation_address(const char *address, const char *port) {
 542                 return meshlink_add_invitation_address(handle, address, port);
 543         }
 544
 545         /// Clears all invitation address for the local node.
 546         /** This function removes all addresses added with meshlink_add_invitation_address().
 547          */
 548         void clear_invitation_addresses() {
 549                 return meshlink_clear_invitation_addresses(handle);
 550         }
 551
 552         /// Add an Address for the local node.
 553         /** This function adds an Address for the local node, which will be used for invitation URLs.
 554          *  @deprecated This function is deprecated, use set_canonical_address() and/or add_invitation_address().
 555          *
 556          *  @param address      A string containing the address, which can be either in numeric format or a hostname.
 557          *
 558          *  @return             This function returns true if the address was added, false otherwise.
 559          */
 560         bool add_address(const char *address) __attribute__((__deprecated__("use set_canonical_address() and/or add_invitation_address() instead"))) {
 561                 return meshlink_set_canonical_address(handle, get_self(), address, NULL);
 562         }
 563
 564         /** This function performs tries to discover the local node's external address
 565          *  by contacting the meshlink.io server. If a reverse lookup of the address works,
 566          *  the FQDN associated with the address will be returned.
 567          *
 568          *  Please note that this is function only returns a single address,
 569          *  even if the local node might have more than one external address.
 570          *  In that case, there is no control over which address will be selected.
 571          *  Also note that if you have a dynamic IP address, or are behind carrier-grade NAT,
 572          *  there is no guarantee that the external address will be valid for an extended period of time.
 573          *
 574          *  This function is blocking. It can take several seconds before it returns.
 575          *  There is no guarantee it will be able to resolve the external address.
 576          *  Failures might be because by temporary network outages.
 577          *
 578          *  @param family       The address family to check, for example AF_INET or AF_INET6. If AF_UNSPEC is given,
 579          *                      this might return the external address for any working address family.
 580          *
 581          *  @return             This function returns a pointer to a C string containing the discovered external address,
 582          *                      or NULL if there was an error looking up the address.
 583          *                      After get_external_address() returns, the application is free to overwrite or free this string.
 584          */
 585         bool get_external_address(int family = AF_UNSPEC) {
 586                 return meshlink_get_external_address_for_family(handle, family);
 587         }
 588
 589         /** This function performs tries to discover the address of the local interface used for outgoing connection.
 590          *
 591          *  Please note that this is function only returns a single address,
 592          *  even if the local node might have more than one external address.
 593          *  In that case, there is no control over which address will be selected.
 594          *  Also note that if you have a dynamic IP address, or are behind carrier-grade NAT,
 595          *  there is no guarantee that the external address will be valid for an extended period of time.
 596          *
 597          *  This function will fail if it couldn't find a local address for the given address family.
 598          *  If hostname resolving is requested, this function may block for a few seconds.
 599          *
 600          *  @param family       The address family to check, for example AF_INET or AF_INET6. If AF_UNSPEC is given,
 601          *                      this might return the external address for any working address family.
 602          *
 603          *  @return             This function returns a pointer to a C string containing the discovered external address,
 604          *                      or NULL if there was an error looking up the address.
 605          *                      After get_external_address() returns, the application is free to overwrite or free this string.
 606          */
 607         bool get_local_address(int family = AF_UNSPEC) {
 608                 return meshlink_get_local_address_for_family(handle, family);
 609         }
 610
 611         /// Try to discover the external address for the local node, and add it to its list of addresses.
 612         /** This function is equivalent to:
 613          *
 614          *    mesh->add_address(mesh->get_external_address());
 615          *
 616          *  Read the description of get_external_address() for the limitations of this function.
 617          *
 618          *  @return             This function returns true if the address was added, false otherwise.
 619          */
 620         bool add_external_address() {
 621                 return meshlink_add_external_address(handle);
 622         }
 623
 624         /// Get the network port used by the local node.
 625         /** This function returns the network port that the local node is listening on.
 626          *
 627          *  @return              This function returns the port number, or -1 in case of an error.
 628          */
 629         int get_port() {
 630                 return meshlink_get_port(handle);
 631         }
 632
 633         /// Set the network port used by the local node.
 634         /** This function sets the network port that the local node is listening on.
 635          *  It may only be called when the mesh is not running.
 636          *  If unsure, call stop() before calling this function.
 637          *  Also note that if your node is already part of a mesh with other nodes,
 638          *  that the other nodes may no longer be able to initiate connections to the local node,
 639          *  since they will try to connect to the previously configured port.
 640          *
 641          *  @param port          The port number to listen on. This must be between 0 and 65535.
 642          *                       If the port is set to 0, then MeshLink will listen on a port
 643          *                       that is randomly assigned by the operating system every time open() is called.
 644          *
 645          *  @return              This function returns true if the port was successfully changed
 646          *                       to the desired port, false otherwise. If it returns false, there
 647          *                       is no guarantee that MeshLink is listening on the old port.
 648          */
 649         bool set_port(int port) {
 650                 return meshlink_set_port(handle, port);
 651         }
 652
 653         /// Set the timeout for invitations.
 654         /** This function sets the timeout for invitations.
 655          *  The timeout is retroactively applied to all outstanding invitations.
 656          *
 657          *  @param timeout      The timeout for invitations in seconds.
 658          */
 659         void set_invitation_timeout(int timeout) {
 660                 meshlink_set_invitation_timeout(handle, timeout);
 661         }
 662
 663         /// Set the scheduling granularity of the application
 664         /** This should be set to the effective scheduling granularity for the application.
 665          *  This depends on the scheduling granularity of the operating system, the application's
 666          *  process priority and whether it is running as realtime or not.
 667          *  The default value is 10000 (10 milliseconds).
 668          *
 669          *  @param granularity  The scheduling granularity of the application in microseconds.
 670          */
 671         void set_granularity(long granularity) {
 672                 meshlink_set_scheduling_granularity(handle, granularity);
 673         }
 674
 675         /// Invite another node into the mesh.
 676         /** This function generates an invitation that can be used by another node to join the same mesh as the local node.
 677          *  The generated invitation is a string containing a URL.
 678          *  This URL should be passed by the application to the invitee in a way that no eavesdroppers can see the URL.
 679          *  The URL can only be used once, after the user has joined the mesh the URL is no longer valid.
 680          *
 681          *  @param submesh      A handle to the submesh to put the invitee in.
 682          *  @param name         The name that the invitee will use in the mesh.
 683          *  @param flags        A bitwise-or'd combination of flags that controls how the URL is generated.
 684          *
 685          *  @return             This function returns a string that contains the invitation URL.
 686          *                      The application should call free() after it has finished using the URL.
 687          */
 688         char *invite(submesh *submesh, const char *name, uint32_t flags = 0) {
 689                 return meshlink_invite_ex(handle, submesh, name, flags);
 690         }
 691
 692         /// Use an invitation to join a mesh.
 693         /** This function allows the local node to join an existing mesh using an invitation URL generated by another node.
 694          *  An invitation can only be used if the local node has never connected to other nodes before.
 695          *  After a successfully accepted invitation, the name of the local node may have changed.
 696          *
 697          *  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.
 698          *
 699          *  This function is blocking. It can take several seconds before it returns.
 700          *  There is no guarantee it will perform a successful join.
 701          *  Failures might be caused by temporary network outages, or by the invitation having expired.
 702          *
 703          *  @param invitation   A string containing the invitation URL.
 704          *
 705          *  @return             This function returns true if the local node joined the mesh it was invited to, false otherwise.
 706          */
 707         bool join(const char *invitation) {
 708                 return meshlink_join(handle, invitation);
 709         }
 710
 711         /// Export the local node's key and addresses.
 712         /** This function generates a string that contains the local node's public key and one or more IP addresses.
 713          *  The application can pass it in some way to another node, which can then import it,
 714          *  granting the local node access to the other node's mesh.
 715          *
 716          *  @return             This function returns a string that contains the exported key and addresses.
 717          *                      The application should call free() after it has finished using this string.
 718          */
 719         char *export_key() {
 720                 return meshlink_export(handle);
 721         }
 722
 723         /// Import another node's key and addresses.
 724         /** This function accepts a string containing the exported public key and addresses of another node.
 725          *  By importing this data, the local node grants the other node access to its mesh.
 726          *
 727          *  @param data         A string containing the other node's exported key and addresses.
 728          *
 729          *  @return             This function returns true if the data was valid and the other node has been granted access to the mesh, false otherwise.
 730          */
 731         bool import_key(const char *data) {
 732                 return meshlink_import(handle, data);
 733         }
 734
 735         /// Forget any information about a node.
 736         /** This function allows the local node to forget any information it has about a node,
 737          *  and if possible will remove any data it has stored on disk about the node.
 738          *
 739          *  Any open channels to this node must be closed before calling this function.
 740          *
 741          *  After this call returns, the node handle is invalid and may no longer be used, regardless
 742          *  of the return value of this call.
 743          *
 744          *  Note that this function does not prevent MeshLink from actually forgetting about a node,
 745          *  or re-learning information about a node at a later point in time. It is merely a hint that
 746          *  the application does not care about this node anymore and that any resources kept could be
 747          *  cleaned up.
 748          *
 749          *  \memberof meshlink_node
 750          *  @param node         A pointer to a struct meshlink_node describing the node to be forgotten.
 751          *
 752          *  @return             This function returns true if all currently known data about the node has been forgotten, false otherwise.
 753          */
 754         bool forget_node(node *node) {
 755                 return meshlink_forget_node(handle, node);
 756         }
 757
 758         /// Blacklist a node from the mesh.
 759         /** This function causes the local node to blacklist another node.
 760          *  The local node will drop any existing connections to that node,
 761          *  and will not send data to it nor accept any data received from it any more.
 762          *
 763          *  @param node         A pointer to a meshlink::node describing the node to be blacklisted.
 764          *
 765          *  @return             This function returns true if the node has been whitelisted, false otherwise.
 766          */
 767         bool blacklist(node *node) {
 768                 return meshlink_blacklist(handle, node);
 769         }
 770
 771         /// Blacklist a node from the mesh by name.
 772         /** This function causes the local node to blacklist another node by name.
 773          *  The local node will drop any existing connections to that node,
 774          *  and will not send data to it nor accept any data received from it any more.
 775          *
 776          *  If no node by the given name is known, it is created.
 777          *
 778          *  @param name         The name of the node to blacklist.
 779          *
 780          *  @return             This function returns true if the node has been blacklisted, false otherwise.
 781          */
 782         bool blacklist_by_name(const char *name) {
 783                 return meshlink_blacklist_by_name(handle, name);
 784         }
 785
 786         /// Whitelist a node on the mesh.
 787         /** This function causes the local node to whitelist another node.
 788          *  The local node will allow connections to and from that node,
 789          *  and will send data to it and accept any data received from it.
 790          *
 791          *  @param node         A pointer to a meshlink::node describing the node to be whitelisted.
 792          *
 793          *  @return             This function returns true if the node has been whitelisted, false otherwise.
 794          */
 795         bool whitelist(node *node) {
 796                 return meshlink_whitelist(handle, node);
 797         }
 798
 799         /// Whitelist a node on the mesh by name.
 800         /** This function causes the local node to whitelist a node by name.
 801          *  The local node will allow connections to and from that node,
 802          *  and will send data to it and accept any data received from it.
 803          *
 804          *  If no node by the given name is known, it is created.
 805          *  This is useful if new nodes are blacklisted by default.
 806          *
 807          *  \memberof meshlink_node
 808          *  @param name         The name of the node to whitelist.
 809          *
 810          *  @return             This function returns true if the node has been whitelisted, false otherwise.
 811          */
 812         bool whitelist_by_name(const char *name) {
 813                 return meshlink_whitelist_by_name(handle, name);
 814         }
 815
 816         /// Set the poll callback.
 817         /** This functions sets the callback that is called whenever data can be sent to another node.
 818          *  The callback is run in MeshLink's own thread.
 819          *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
 820          *  to pass data to or from the application's thread.
 821          *  The callback should also not block itself and return as quickly as possible.
 822          *
 823          *  @param channel   A handle for the channel.
 824          *  @param cb        A pointer to the function which will be called when data can be sent to another node.
 825          *                   If a NULL pointer is given, the callback will be disabled.
 826          */
 827         void set_channel_poll_cb(channel *channel, channel_poll_cb_t cb) {
 828                 meshlink_set_channel_poll_cb(handle, channel, (meshlink_channel_poll_cb_t)cb);
 829         }
 830
 831         /// Set the send buffer size of a channel.
 832         /** This function sets the desired size of the send buffer.
 833          *  The default size is 128 kB.
 834          *
 835          *  @param channel   A handle for the channel.
 836          *  @param size      The desired size for the send buffer.
 837          *                   If a NULL pointer is given, the callback will be disabled.
 838          */
 839         void set_channel_sndbuf(channel *channel, size_t size) {
 840                 meshlink_set_channel_sndbuf(handle, channel, size);
 841         }
 842
 843         /// Set the receive buffer size of a channel.
 844         /** This function sets the desired size of the receive buffer.
 845          *  The default size is 128 kB.
 846          *
 847          *  @param channel   A handle for the channel.
 848          *  @param size      The desired size for the send buffer.
 849          *                   If a NULL pointer is given, the callback will be disabled.
 850          */
 851         void set_channel_rcvbuf(channel *channel, size_t size) {
 852                 meshlink_set_channel_rcvbuf(handle, channel, size);
 853         }
 854
 855         /// Set the connection timeout used for channels to the given node.
 856         /** This sets the timeout after which unresponsive channels will be reported as closed.
 857          *  The timeout is set for all current and future channels to the given node.
 858          *
 859          *  @param node         The node to set the channel timeout for.
 860          *  @param timeout      The timeout in seconds after which unresponsive channels will be reported as closed.
 861          *                      The default is 60 seconds.
 862          */
 863         void set_node_channel_timeout(node *node, int timeout) {
 864                 meshlink_set_node_channel_timeout(handle, node, timeout);
 865         }
 866
 867         /// Open a reliable stream channel to another node.
 868         /** This function is called whenever a remote node wants to open a channel to the local node.
 869          *  The application then has to decide whether to accept or reject this channel.
 870          *
 871          *  This function sets the channel poll callback to channel_poll_trampoline, which in turn
 872          *  calls channel_poll. To set a different, channel-specific poll callback, use set_channel_poll_cb.
 873          *
 874          *  @param node         The node to which this channel is being initiated.
 875          *  @param port         The port number the peer wishes to connect to.
 876          *  @param cb           A pointer to the function which will be called when the remote node sends data to the local node.
 877          *  @param data         A pointer to a buffer containing data to already queue for sending.
 878          *  @param len          The length of the data.
 879          *                      If len is 0, the data pointer is copied into the channel's priv member.
 880          *  @param flags        A bitwise-or'd combination of flags that set the semantics for this channel.
 881          *
 882          *  @return             A handle for the channel, or NULL in case of an error.
 883          */
 884         channel *channel_open(node *node, uint16_t port, channel_receive_cb_t cb, const void *data, size_t len, uint32_t flags = channel::TCP) {
 885                 channel *ch = (channel *)meshlink_channel_open_ex(handle, node, port, (meshlink_channel_receive_cb_t)cb, data, len, flags);
 886                 meshlink_set_channel_poll_cb(handle, ch, &channel_poll_trampoline);
 887                 return ch;
 888         }
 889
 890         /// Open a reliable stream channel to another node.
 891         /** This function is called whenever a remote node wants to open a channel to the local node.
 892          *  The application then has to decide whether to accept or reject this channel.
 893          *
 894          *  This function sets the channel receive callback to channel_receive_trampoline,
 895          *  which in turn calls channel_receive.
 896          *
 897          *  This function sets the channel poll callback to channel_poll_trampoline, which in turn
 898          *  calls channel_poll. To set a different, channel-specific poll callback, use set_channel_poll_cb.
 899          *
 900          *  @param node         The node to which this channel is being initiated.
 901          *  @param port         The port number the peer wishes to connect to.
 902          *  @param data         A pointer to a buffer containing data to already queue for sending.
 903          *  @param len          The length of the data.
 904          *                      If len is 0, the data pointer is copied into the channel's priv member.
 905          *  @param flags        A bitwise-or'd combination of flags that set the semantics for this channel.
 906          *
 907          *  @return             A handle for the channel, or NULL in case of an error.
 908          */
 909         channel *channel_open(node *node, uint16_t port, const void *data, size_t len, uint32_t flags = channel::TCP) {
 910                 channel *ch = (channel *)meshlink_channel_open_ex(handle, node, port, &channel_receive_trampoline, data, len, flags);
 911                 meshlink_set_channel_poll_cb(handle, ch, &channel_poll_trampoline);
 912                 return ch;
 913         }
 914
 915         /// Partially close a reliable stream channel.
 916         /** This shuts down the read or write side of a channel, or both, without closing the handle.
 917          *  It can be used to inform the remote node that the local node has finished sending all data on the channel,
 918          *  but still allows waiting for incoming data from the remote node.
 919          *
 920          *  @param channel      A handle for the channel.
 921          *  @param direction    Must be one of SHUT_RD, SHUT_WR or SHUT_RDWR.
 922          */
 923         void channel_shutdown(channel *channel, int direction) {
 924                 return meshlink_channel_shutdown(handle, channel, direction);
 925         }
 926
 927         /// Close a reliable stream channel.
 928         /** This informs the remote node that the local node has finished sending all data on the channel.
 929          *  It also causes the local node to stop accepting incoming data from the remote node.
 930          *  Afterwards, the channel handle is invalid and must not be used any more.
 931          *
 932          *  @param channel      A handle for the channel.
 933          */
 934         void channel_close(meshlink_channel_t *channel) {
 935                 return meshlink_channel_close(handle, channel);
 936         }
 937
 938         /// Transmit data on a channel
 939         /** This queues data to send to the remote node.
 940          *
 941          *  @param channel      A handle for the channel.
 942          *  @param data         A pointer to a buffer containing data sent by the source.
 943          *  @param len          The length of the data.
 944          *
 945          *  @return             The amount of data that was queued, which can be less than len, or a negative value in case of an error.
 946          *                      If MESHLINK_CHANNEL_NO_PARTIAL is set, then the result will either be len,
 947          *                      0 if the buffer is currently too full, or -1 if len is too big even for an empty buffer.
 948          */
 949         ssize_t channel_send(channel *channel, void *data, size_t len) {
 950                 return meshlink_channel_send(handle, channel, data, len);
 951         }
 952
 953         /// Transmit data on a channel asynchronously
 954         /** This registers a buffer that will be used to send data to the remote node.
 955          *  Multiple buffers can be registered, in which case data will be sent in the order the buffers were registered.
 956          *  While there are still buffers with unsent data, the poll callback will not be called.
 957          *
 958          *  @param channel      A handle for the channel.
 959          *  @param data         A pointer to a buffer containing data sent by the source, or NULL if there is no data to send.
 960          *                      After meshlink_channel_aio_send() returns, the buffer may not be modified or freed by the application
 961          *                      until the callback routine is called.
 962          *  @param len          The length of the data, or 0 if there is no data to send.
 963          *  @param cb           A pointer to the function which will be called when MeshLink has finished using the buffer.
 964          *  @param priv         A private pointer which was set by the application when submitting the buffer.
 965          *
 966          *  @return             True if the buffer was enqueued, false otherwise.
 967          */
 968         bool channel_aio_send(channel *channel, const void *data, size_t len, meshlink_aio_cb_t cb, void *priv) {
 969                 return meshlink_channel_aio_send(handle, channel, data, len, cb, priv);
 970         }
 971
 972         /// Transmit data on a channel asynchronously from a filedescriptor
 973         /** This will read up to the specified length number of bytes from the given filedescriptor, and send it over the channel.
 974          *  The callback may be returned early if there is an error reading from the filedescriptor.
 975          *  While there is still with unsent data, the poll callback will not be called.
 976          *
 977          *  @param channel      A handle for the channel.
 978          *  @param fd           A file descriptor from which data will be read.
 979          *  @param len          The length of the data, or 0 if there is no data to send.
 980          *  @param cb           A pointer to the function which will be called when MeshLink has finished using the filedescriptor.
 981          *  @param priv         A private pointer which was set by the application when submitting the buffer.
 982          *
 983          *  @return             True if the buffer was enqueued, false otherwise.
 984          */
 985         bool channel_aio_fd_send(channel *channel, int fd, size_t len, meshlink_aio_fd_cb_t cb, void *priv) {
 986                 return meshlink_channel_aio_fd_send(handle, channel, fd, len, cb, priv);
 987         }
 988
 989         /// Receive data on a channel asynchronously
 990         /** This registers a buffer that will be filled with incoming channel data.
 991          *  Multiple buffers can be registered, in which case data will be received in the order the buffers were registered.
 992          *  While there are still buffers that have not been filled, the receive callback will not be called.
 993          *
 994          *  @param channel      A handle for the channel.
 995          *  @param data         A pointer to a buffer that will be filled with incoming data.
 996          *                      After meshlink_channel_aio_receive() returns, the buffer may not be modified or freed by the application
 997          *                      until the callback routine is called.
 998          *  @param len          The length of the data.
 999          *  @param cb           A pointer to the function which will be called when MeshLink has finished using the buffer.
1000          *  @param priv         A private pointer which was set by the application when submitting the buffer.
1001          *
1002          *  @return             True if the buffer was enqueued, false otherwise.
1003          */
1004         bool channel_aio_receive(channel *channel, const void *data, size_t len, meshlink_aio_cb_t cb, void *priv) {
1005                 return meshlink_channel_aio_receive(handle, channel, data, len, cb, priv);
1006         }
1007
1008         /// Receive data on a channel asynchronously and send it to a filedescriptor
1009         /** This will read up to the specified length number of bytes from the channel, and send it to the filedescriptor.
1010          *  The callback may be returned early if there is an error writing to the filedescriptor.
1011          *  While there is still unread data, the receive callback will not be called.
1012          *
1013          *  @param channel      A handle for the channel.
1014          *  @param fd           A file descriptor to which data will be written.
1015          *  @param len          The length of the data.
1016          *  @param cb           A pointer to the function which will be called when MeshLink has finished using the filedescriptor.
1017          *  @param priv         A private pointer which was set by the application when submitting the buffer.
1018          *
1019          *  @return             True if the buffer was enqueued, false otherwise.
1020          */
1021         bool channel_aio_fd_receive(channel *channel, int fd, size_t len, meshlink_aio_fd_cb_t cb, void *priv) {
1022                 return meshlink_channel_aio_fd_receive(handle, channel, fd, len, cb, priv);
1023         }
1024
1025         /// Get the amount of bytes in the send buffer.
1026         /** This returns the amount of bytes in the send buffer.
1027          *  These bytes have not been received by the peer yet.
1028          *
1029          *  @param channel      A handle for the channel.
1030          *
1031          *  @return             The amount of un-ACKed bytes in the send buffer.
1032          */
1033         size_t channel_get_sendq(channel *channel) {
1034                 return meshlink_channel_get_sendq(handle, channel);
1035         }
1036
1037         /// Get the amount of bytes in the receive buffer.
1038         /** This returns the amount of bytes in the receive buffer.
1039          *  These bytes have not been processed by the application yet.
1040          *
1041          *  @param channel      A handle for the channel.
1042          *
1043          *  @return             The amount of bytes in the receive buffer.
1044          */
1045         size_t channel_get_recvq(channel *channel) {
1046                 return meshlink_channel_get_recvq(handle, channel);
1047         }
1048
1049         /// Get the maximum segment size of a channel.
1050         /** This returns the amount of bytes that can be sent at once for channels with UDP semantics.
1051          *
1052          *  @param channel      A handle for the channel.
1053          *
1054          *  @return             The amount of bytes in the receive buffer.
1055          */
1056         size_t channel_get_mss(channel *channel) {
1057                 return meshlink_channel_get_mss(handle, channel);
1058         };
1059
1060         /// Enable or disable zeroconf discovery of local peers
1061         /** This controls whether zeroconf discovery using the Catta library will be
1062          *  enabled to search for peers on the local network. By default, it is enabled.
1063          *
1064          *  @param enable  Set to true to enable discovery, false to disable.
1065          */
1066         void enable_discovery(bool enable = true) {
1067                 meshlink_enable_discovery(handle, enable);
1068         }
1069
1070         /// Set device class timeouts
1071         /** This sets the ping interval and timeout for a given device class.
1072          *
1073          *  @param devclass      The device class to update
1074          *  @param pinginterval  The interval between keepalive packets, in seconds. The default is 60.
1075          *  @param pingtimeout   The required time within which a peer should respond, in seconds. The default is 5.
1076          *                       The timeout must be smaller than the interval.
1077          */
1078         void set_dev_class_timeouts(dev_class_t devclass, int pinginterval, int pingtimeout) {
1079                 meshlink_set_dev_class_timeouts(handle, devclass, pinginterval, pingtimeout);
1080         }
1081
1082         /// Set device class fast retry period
1083         /** This sets the fast retry period for a given device class.
1084          *  During this period after the last time the mesh becomes unreachable, connections are tried once a second.
1085          *
1086          *  @param devclass           The device class to update
1087          *  @param fast_retry_period  The period during which fast connection retries are done. The default is 0.
1088          */
1089         void set_dev_class_fast_retry_period(dev_class_t devclass, int fast_retry_period) {
1090                 meshlink_set_dev_class_fast_retry_period(handle, devclass, fast_retry_period);
1091         }
1092
1093         /// Set device class maximum timeout
1094         /** This sets the maximum timeout for outgoing connection retries for a given device class.
1095          *
1096          *  @param devclass      The device class to update
1097          *  @param maxtimeout    The maximum timeout between reconnection attempts, in seconds. The default is 900.
1098          */
1099         void set_dev_class_maxtimeout(dev_class_t devclass, int maxtimeout) {
1100                 meshlink_set_dev_class_maxtimeout(handle, devclass, maxtimeout);
1101         }
1102
1103         /// Set which order invitations are committed
1104         /** This determines in which order configuration files are written to disk during an invitation.
1105          *  By default, the invitee saves the configuration to disk first, then the inviter.
1106          *  By calling this function with @a inviter_commits_first set to true, the order is reversed.
1107          *
1108          *  @param inviter_commits_first  If true, then the node that invited a peer will commit data to disk first.
1109          */
1110         void set_inviter_commits_first(bool inviter_commits_first) {
1111                 meshlink_set_inviter_commits_first(handle, inviter_commits_first);
1112         }
1113
1114         /// Set the URL used to discover the host's external address
1115         /** For generating invitation URLs, MeshLink can look up the externally visible address of the local node.
1116          *  It does so by querying an external service. By default, this is http://meshlink.io/host.cgi.
1117          *  Only URLs starting with http:// are supported.
1118          *
1119          *  @param url   The URL to use for external address queries, or NULL to revert back to the default URL.
1120          */
1121         void set_external_address_discovery_url(const char *url) {
1122                 meshlink_set_external_address_discovery_url(handle, url);
1123         }
1124
1125 private:
1126         // non-copyable:
1127         mesh(const mesh &) /* TODO: C++11: = delete */;
1128         void operator=(const mesh &) /* TODO: C++11: = delete */;
1129
1130         /// static callback trampolines:
1131         static void receive_trampoline(meshlink_handle_t *handle, meshlink_node_t *source, const void *data, size_t length) {
1132                 if(!(handle->priv)) {
1133                         return;
1134                 }
1135
1136                 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1137                 that->receive(static_cast<node *>(source), data, length);
1138         }
1139
1140         static void node_status_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer, bool reachable) {
1141                 if(!(handle->priv)) {
1142                         return;
1143                 }
1144
1145                 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1146                 that->node_status(static_cast<node *>(peer), reachable);
1147         }
1148
1149         static void node_pmtu_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer, uint16_t pmtu) {
1150                 if(!(handle->priv)) {
1151                         return;
1152                 }
1153
1154                 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1155                 that->node_pmtu(static_cast<node *>(peer), pmtu);
1156         }
1157
1158         static void node_duplicate_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer) {
1159                 if(!(handle->priv)) {
1160                         return;
1161                 }
1162
1163                 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1164                 that->node_duplicate(static_cast<node *>(peer));
1165         }
1166
1167         static void log_trampoline(meshlink_handle_t *handle, log_level_t level, const char *message) {
1168                 if(!(handle->priv)) {
1169                         return;
1170                 }
1171
1172                 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1173                 that->log(level, message);
1174         }
1175
1176         static void error_trampoline(meshlink_handle_t *handle, meshlink_errno_t meshlink_errno) {
1177                 if(!(handle->priv)) {
1178                         return;
1179                 }
1180
1181                 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1182                 that->error(meshlink_errno);
1183         }
1184
1185         static void connection_try_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer) {
1186                 if(!(handle->priv)) {
1187                         return;
1188                 }
1189
1190                 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1191                 that->connection_try(static_cast<node *>(peer));
1192         }
1193
1194         static bool channel_listen_trampoline(meshlink_handle_t *handle, meshlink_node_t *node, uint16_t port) {
1195                 if(!(handle->priv)) {
1196                         return false;
1197                 }
1198
1199                 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1200                 return that->channel_listen(static_cast<meshlink::node *>(node), port);
1201         }
1202
1203         static bool channel_accept_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, uint16_t port, const void *data, size_t len) {
1204                 if(!(handle->priv)) {
1205                         return false;
1206                 }
1207
1208                 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1209                 bool accepted = that->channel_accept(static_cast<meshlink::channel *>(channel), port, data, len);
1210
1211                 if(accepted) {
1212                         meshlink_set_channel_receive_cb(handle, channel, &channel_receive_trampoline);
1213                         meshlink_set_channel_poll_cb(handle, channel, &channel_poll_trampoline);
1214                 }
1215
1216                 return accepted;
1217         }
1218
1219         static void channel_receive_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, const void *data, size_t len) {
1220                 if(!(handle->priv)) {
1221                         return;
1222                 }
1223
1224                 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1225                 that->channel_receive(static_cast<meshlink::channel *>(channel), data, len);
1226         }
1227
1228         static void channel_poll_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, size_t len) {
1229                 if(!(handle->priv)) {
1230                         return;
1231                 }
1232
1233                 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1234                 that->channel_poll(static_cast<meshlink::channel *>(channel), len);
1235         }
1236
1237         meshlink_handle_t *handle;
1238 };
1239
1240 static inline const char *strerror(errno_t err = meshlink_errno) {
1241         return meshlink_strerror(err);
1242 }
1243
1244 /// Destroy a MeshLink instance.
1245 /** This function remove all configuration files of a MeshLink instance. It should only be called when the application
1246  *  does not have an open handle to this instance. Afterwards, a call to meshlink_open() will create a completely
1247  *  new instance.
1248  *
1249  *  @param confbase The directory in which MeshLink stores its configuration files.
1250  *                  After the function returns, the application is free to overwrite or free @a confbase @a.
1251  *
1252  *  @return         This function will return true if the MeshLink instance was successfully destroyed, false otherwise.
1253  */
1254 static inline bool destroy(const char *confbase) {
1255         return meshlink_destroy(confbase);
1256 }
1257 }
1258
1259 #endif