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