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