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