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