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