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