5 meshlink++.h -- MeshLink C++ API
6 Copyright (C) 2014, 2017 Guus Sliepen <guus@meshlink.io>
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.
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.
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.
24 #include <new> // for 'placement new'
32 /// Severity of log messages generated by MeshLink.
33 typedef meshlink_log_level_t log_level_t;
35 /// Code of most recent error encountered.
36 typedef meshlink_errno_t errno_t;
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.
44 typedef void (*receive_cb_t)(mesh *mesh, node *source, const void *data, size_t len);
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.
51 typedef void (*connection_try_cb_t)(mesh *mesh, node *node);
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.
58 typedef void (*node_status_cb_t)(mesh *mesh, node *node, bool reachable);
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.
66 typedef void (*node_pmtu_cb_t)(mesh *mesh, node *node, uint16_t pmtu);
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.
73 typedef void (*duplicate_cb_t)(mesh *mesh, node *node);
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.
80 typedef void (*log_cb_t)(mesh *mesh, log_level_t level, const char *text);
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.
87 * @return This function should return true if the application listens for the incoming channel, false otherwise.
89 typedef bool (*meshlink_channel_listen_cb_t)(struct meshlink_handle *mesh, struct meshlink_node *node, uint16_t port);
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.)
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.
101 typedef bool (*channel_accept_cb_t)(mesh *mesh, channel *channel, uint16_t port, const void *data, size_t len);
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.
109 typedef void (*channel_receive_cb_t)(mesh *mesh, channel *channel, const void *data, size_t len);
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().
116 typedef void (*channel_poll_cb_t)(mesh *mesh, channel *channel, size_t len);
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.
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.
128 typedef void (*aio_cb_t)(mesh *mesh, channel *channel, const void *data, size_t len, void *priv);
130 /// A callback for asynchronous I/O to and from filedescriptors.
131 /** This callbacks signals that MeshLink has finished using this filedescriptor.
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.
139 typedef void (*aio_fd_cb_t)(mesh *mesh, channel *channel, int fd, size_t len, void *priv);
141 /// A class describing a MeshLink node.
142 class node: public meshlink_node_t {
145 /// A class describing a MeshLink Sub-Mesh.
146 class submesh: public meshlink_submesh_t {
149 /// A class describing a MeshLink channel.
150 class channel: public meshlink_channel_t {
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;
161 /// A class describing a MeshLink mesh.
164 mesh() : handle(0) {}
170 bool isOpen() const {
171 return (handle != 0);
174 // TODO: please enable C++11 in autoconf to enable "move constructors":
175 // mesh(mesh&& other)
176 // : handle(other.handle)
179 // handle->priv = this;
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.
190 * This function does not start any network I/O yet. The application should
191 * first set callbacks, and then call meshlink_start().
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.
198 * @return This function will return a pointer to a meshlink::mesh if MeshLink has successfully set up its configuration files, NULL otherwise.
200 bool open(const char *confbase, const char *name, const char *appname, dev_class_t devclass) {
201 handle = meshlink_open(confbase, name, appname, devclass);
210 mesh(const char *confbase, const char *name, const char *appname, dev_class_t devclass) {
211 open(confbase, name, appname, devclass);
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.
222 meshlink_close(handle);
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
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) {
244 /// This functions is called whenever another node's status changed.
245 virtual void node_status(node *peer, bool reachable) {
251 /// This functions is called whenever another node's path MTU changes.
252 virtual void node_pmtu(node *peer, uint16_t pmtu) {
258 /// This functions is called whenever a duplicate node is detected.
259 virtual void node_duplicate(node *peer) {
264 /// This functions is called whenever MeshLink has some information to log.
265 virtual void log(log_level_t level, const char *message) {
271 /// This functions is called whenever MeshLink has encountered a serious error.
272 virtual void error(meshlink_errno_t meshlink_errno) {
274 (void)meshlink_errno;
277 /// This functions is called whenever MeshLink is blacklisted by another node.
278 virtual void blacklisted(node *peer) {
283 /// This functions is called whenever the MeshLink thread status changes.
284 virtual void thread_status(bool status) {
289 /// This functions is called whenever MeshLink a meta-connection attempt is made.
290 virtual void connection_try(node *peer) {
295 /// This functions is called to determine if we are listening for incoming channels.
297 * The function is run in MeshLink's own thread.
298 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
299 * to pass data to or from the application's thread.
300 * The callback should also not block itself and return as quickly as possible.
302 * @param node A handle for the node that wants to open a channel.
303 * @param port The port number the peer wishes to connect to.
305 * @return This function should return true if the application accepts the incoming channel, false otherwise.
307 virtual bool channel_listen(node *node, uint16_t port) {
308 /* by default accept all channels */
314 /// This functions is called whenever another node attempts to open a channel to the local node.
316 * If the channel is accepted, the poll_callback will be set to channel_poll and can be
317 * changed using set_channel_poll_cb(). Likewise, the receive callback is set to
320 * The function is run in MeshLink's own thread.
321 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
322 * to pass data to or from the application's thread.
323 * The callback should also not block itself and return as quickly as possible.
325 * @param channel A handle for the incoming channel.
326 * @param port The port number the peer wishes to connect to.
327 * @param data A pointer to a buffer containing data already received. (Not yet used.)
328 * @param len The length of the data. (Not yet used.)
330 * @return This function should return true if the application accepts the incoming channel, false otherwise.
331 * If returning false, the channel is invalid and may not be used anymore.
333 virtual bool channel_accept(channel *channel, uint16_t port, const void *data, size_t len) {
334 /* by default reject all channels */
342 /// This function is called by Meshlink for receiving data from a channel.
344 * The function is run in MeshLink's own thread.
345 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
346 * to pass data to or from the application's thread.
347 * The callback should also not block itself and return as quickly as possible.
349 * @param channel A handle for the channel.
350 * @param data A pointer to a buffer containing data sent by the source.
351 * @param len The length of the data.
353 virtual void channel_receive(channel *channel, const void *data, size_t len) {
360 /// This function is called by Meshlink when data can be send on a channel.
362 * The function is run in MeshLink's own thread.
363 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
364 * to pass data to or from the application's thread.
366 * The callback should also not block itself and return as quickly as possible.
367 * @param channel A handle for the channel.
368 * @param len The maximum length of data that is guaranteed to be accepted by a call to channel_send().
370 virtual void channel_poll(channel *channel, size_t len) {
377 /** This function causes MeshLink to open network sockets, make outgoing connections, and
378 * create a new thread, which will handle all network I/O.
380 * @return This function will return true if MeshLink has successfully started its thread, false otherwise.
383 meshlink_set_receive_cb(handle, &receive_trampoline);
384 meshlink_set_node_status_cb(handle, &node_status_trampoline);
385 meshlink_set_node_pmtu_cb(handle, &node_pmtu_trampoline);
386 meshlink_set_node_duplicate_cb(handle, &node_duplicate_trampoline);
387 meshlink_set_log_cb(handle, MESHLINK_DEBUG, &log_trampoline);
388 meshlink_set_error_cb(handle, &error_trampoline);
389 meshlink_set_blacklisted_cb(handle, &blacklisted_trampoline);
390 meshlink_set_thread_status_cb(handle, &thread_status_trampoline);
391 meshlink_set_channel_listen_cb(handle, &channel_listen_trampoline);
392 meshlink_set_channel_accept_cb(handle, &channel_accept_trampoline);
393 meshlink_set_connection_try_cb(handle, &connection_try_trampoline);
394 return meshlink_start(handle);
398 /** This function causes MeshLink to disconnect from all other nodes,
399 * close all sockets, and shut down its own thread.
402 meshlink_stop(handle);
405 /// Send data to another node.
406 /** This functions sends one packet of data to another node in the mesh.
407 * The packet is sent using UDP semantics, which means that
408 * the packet is sent as one unit and is received as one unit,
409 * and that there is no guarantee that the packet will arrive at the destination.
410 * The application should take care of getting an acknowledgement and retransmission if necessary.
412 * @param destination A pointer to a meshlink::node describing the destination for the data.
413 * @param data A pointer to a buffer containing the data to be sent to the source.
414 * @param len The length of the data.
415 * @return This function will return true if MeshLink has queued the message for transmission, and false otherwise.
416 * A return value of true does not guarantee that the message will actually arrive at the destination.
418 bool send(node *destination, const void *data, unsigned int len) {
419 return meshlink_send(handle, destination, data, len);
422 /// Get a handle for a specific node.
423 /** This function returns a handle for the node with the given name.
425 * @param name The name of the node for which a handle is requested.
427 * @return A pointer to a meshlink::node which represents the requested node,
428 * or NULL if the requested node does not exist.
430 node *get_node(const char *name) {
431 return (node *)meshlink_get_node(handle, name);
434 /// Get a node's reachability status.
435 /** This function returns the current reachability of a given node, and the times of the last state changes.
436 * If a given state change never happened, the time returned will be 0.
438 * @param node A pointer to a meshlink::node describing the node.
439 * @param last_reachable A pointer to a time_t variable that will be filled in with the last time the node became reachable.
440 * @param last_unreachable A pointer to a time_t variable that will be filled in with the last time the node became unreachable.
442 * @return This function returns true if the node is currently reachable, false otherwise.
444 bool get_node_reachability(node *node, time_t *last_reachable = NULL, time_t *last_unreachable = NULL) {
445 return meshlink_get_node_reachability(handle, node, last_reachable, last_unreachable);
448 /// Get a node's blacklist status.
449 /** This function returns the current blacklist status of a given node.
451 * @param node A pointer to a meshlink::node describing the node.
453 * @return This function returns true if the node is currently blacklisted, false otherwise.
455 bool get_node_blacklisted(node *node) {
456 return meshlink_get_node_blacklisted(handle, node);
459 /// Get the node's tiny status.
460 /** This function returns true if the given node is a tiny node.
461 * Note that the tiny status of a node will only be known if the node has been reachable at least once.
463 * @param node A pointer to a meshlink::node describing the node.
465 * @return This function returns true if the node is a tiny node.
467 bool get_node_tiny(node *node) {
468 return meshlink_get_node_tiny(handle, node);
471 /// Get a handle for a specific submesh.
472 /** This function returns a handle for the submesh with the given name.
474 * @param name The name of the submesh for which a handle is requested.
476 * @return A pointer to a meshlink::submesh which represents the requested submesh,
477 * or NULL if the requested submesh does not exist.
479 submesh *get_submesh(const char *name) {
480 return (submesh *)meshlink_get_submesh(handle, name);
483 /// Get a handle for our own node.
484 /** This function returns a handle for the local node.
486 * @return A pointer to a meshlink::node which represents the local node.
489 return (node *)meshlink_get_self(handle);
492 /// Get a list of all nodes.
493 /** This function returns a list with handles for all known nodes.
495 * @param nodes A pointer to an array of pointers to meshlink::node, which should be allocated by the application.
496 * @param nmemb The maximum number of pointers that can be stored in the nodes array.
498 * @return The number of known nodes, or -1 in case of an error.
499 * This can be larger than nmemb, in which case not all nodes were stored in the nodes array.
501 node **get_all_nodes(node **nodes, size_t *nmemb) {
502 return (node **)meshlink_get_all_nodes(handle, (meshlink_node_t **)nodes, nmemb);
505 /// Get a list of all nodes by blacklist status.
506 /** This function returns a list with handles for all the nodes who were either blacklisted or whitelisted.
508 * @param blacklisted If true, a list of blacklisted nodes will be returned, otherwise whitelisted nodes.
509 * @param nodes A pointer to an array of pointers to meshlink::node, which should be allocated by the application.
510 * @param nmemb The maximum number of pointers that can be stored in the nodes array.
512 * @return A pointer to an array containing pointers to all known nodes with the given blacklist status.
513 * If the @a nodes argument was not NULL, then the return value can either be the same value or a different value.
514 * If it is a new value, the old value of @a nodes should not be used anymore.
515 * If the new value is NULL, then the old array will have been freed by MeshLink.
517 node **get_all_nodes_by_blacklisted(bool blacklisted, node **nodes, size_t *nmemb) {
518 return (node **)meshlink_get_all_nodes_by_blacklisted(handle, blacklisted, (meshlink_node_t **)nodes, nmemb);
521 /// Sign data using the local node's MeshLink key.
522 /** This function signs data using the local node's MeshLink key.
523 * The generated signature can be securely verified by other nodes.
525 * @param data A pointer to a buffer containing the data to be signed.
526 * @param len The length of the data to be signed.
527 * @param signature A pointer to a buffer where the signature will be stored.
528 * @param siglen The size of the signature buffer. Will be changed after the call to match the size of the signature itself.
530 * @return This function returns true if the signature is valid, false otherwise.
532 bool sign(const void *data, size_t len, void *signature, size_t *siglen) {
533 return meshlink_sign(handle, data, len, signature, siglen);
536 /// Verify the signature generated by another node of a piece of data.
537 /** This function verifies the signature that another node generated for a piece of data.
539 * @param source A pointer to a meshlink_node_t describing the source of the signature.
540 * @param data A pointer to a buffer containing the data to be verified.
541 * @param len The length of the data to be verified.
542 * @param signature A pointer to a string containing the signature.
543 * @param siglen The size of the signature.
545 * @return This function returns true if the signature is valid, false otherwise.
547 bool verify(node *source, const void *data, size_t len, const void *signature, size_t siglen) {
548 return meshlink_verify(handle, source, data, len, signature, siglen);
551 /// Set the canonical Address for a node.
552 /** This function sets the canonical Address for a node.
553 * This address is stored permanently until it is changed by another call to this function,
554 * unlike other addresses associated with a node,
555 * such as those added with meshlink_hint_address() or addresses discovered at runtime.
557 * If a canonical Address is set for the local node,
558 * it will be used for the hostname part of generated invitation URLs.
560 * @param node A pointer to a meshlink_node_t describing the node.
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.
565 * @return This function returns true if the address was added, false otherwise.
567 bool set_canonical_address(node *node, const char *address, const char *port = NULL) {
568 return meshlink_set_canonical_address(handle, node, address, port);
571 /// Clear the canonical Address for a node.
572 /** This function clears the canonical Address for a node.
574 * @param node A pointer to a struct meshlink_node describing the node.
576 * @return This function returns true if the address was removed, false otherwise.
578 bool clear_canonical_address(node *node) {
579 return meshlink_clear_canonical_address(handle, node);
582 /// Add an invitation address for the local node.
583 /** This function adds an address for the local node, which will be used only for invitation URLs.
584 * This address is not stored permanently.
585 * Multiple addresses can be added using multiple calls to this function.
587 * @param address A nul-terminated C string containing the address, which can be either in numeric format or a hostname.
588 * @param port A nul-terminated C string containing the port, which can be either in numeric or symbolic format.
589 * If it is NULL, the listening port's number will be used.
591 * @return This function returns true if the address was added, false otherwise.
593 bool add_invitation_address(const char *address, const char *port) {
594 return meshlink_add_invitation_address(handle, address, port);
597 /// Clears all invitation address for the local node.
598 /** This function removes all addresses added with meshlink_add_invitation_address().
600 void clear_invitation_addresses() {
601 return meshlink_clear_invitation_addresses(handle);
604 /// Add an Address for the local node.
605 /** This function adds an Address for the local node, which will be used for invitation URLs.
606 * @deprecated This function is deprecated, use set_canonical_address() and/or add_invitation_address().
608 * @param address A string containing the address, which can be either in numeric format or a hostname.
610 * @return This function returns true if the address was added, false otherwise.
612 bool add_address(const char *address) __attribute__((__deprecated__("use set_canonical_address() and/or add_invitation_address() instead"))) {
613 return meshlink_set_canonical_address(handle, get_self(), address, NULL);
616 /** This function performs tries to discover the local node's external address
617 * by contacting the meshlink.io server. If a reverse lookup of the address works,
618 * the FQDN associated with the address will be returned.
620 * Please note that this is function only returns a single address,
621 * even if the local node might have more than one external address.
622 * In that case, there is no control over which address will be selected.
623 * Also note that if you have a dynamic IP address, or are behind carrier-grade NAT,
624 * there is no guarantee that the external address will be valid for an extended period of time.
626 * This function is blocking. It can take several seconds before it returns.
627 * There is no guarantee it will be able to resolve the external address.
628 * Failures might be because by temporary network outages.
630 * @param family The address family to check, for example AF_INET or AF_INET6. If AF_UNSPEC is given,
631 * this might return the external address for any working address family.
633 * @return This function returns a pointer to a C string containing the discovered external address,
634 * or NULL if there was an error looking up the address.
635 * After get_external_address() returns, the application is free to overwrite or free this string.
637 bool get_external_address(int family = AF_UNSPEC) {
638 return meshlink_get_external_address_for_family(handle, family);
641 /** This function performs tries to discover the address of the local interface used for outgoing connection.
643 * Please note that this is function only returns a single address,
644 * even if the local node might have more than one external address.
645 * In that case, there is no control over which address will be selected.
646 * Also note that if you have a dynamic IP address, or are behind carrier-grade NAT,
647 * there is no guarantee that the external address will be valid for an extended period of time.
649 * This function will fail if it couldn't find a local address for the given address family.
650 * If hostname resolving is requested, this function may block for a few seconds.
652 * @param family The address family to check, for example AF_INET or AF_INET6. If AF_UNSPEC is given,
653 * this might return the external address for any working address family.
655 * @return This function returns a pointer to a C string containing the discovered external address,
656 * or NULL if there was an error looking up the address.
657 * After get_external_address() returns, the application is free to overwrite or free this string.
659 bool get_local_address(int family = AF_UNSPEC) {
660 return meshlink_get_local_address_for_family(handle, family);
663 /// Try to discover the external address for the local node, and add it to its list of addresses.
664 /** This function is equivalent to:
666 * mesh->add_address(mesh->get_external_address());
668 * Read the description of get_external_address() for the limitations of this function.
670 * @return This function returns true if the address was added, false otherwise.
672 bool add_external_address() {
673 return meshlink_add_external_address(handle);
676 /// Get the network port used by the local node.
677 /** This function returns the network port that the local node is listening on.
679 * @return This function returns the port number, or -1 in case of an error.
682 return meshlink_get_port(handle);
685 /// Set the network port used by the local node.
686 /** This function sets the network port that the local node is listening on.
687 * It may only be called when the mesh is not running.
688 * If unsure, call stop() before calling this function.
689 * Also note that if your node is already part of a mesh with other nodes,
690 * that the other nodes may no longer be able to initiate connections to the local node,
691 * since they will try to connect to the previously configured port.
693 * @param port The port number to listen on. This must be between 0 and 65535.
694 * If the port is set to 0, then MeshLink will listen on a port
695 * that is randomly assigned by the operating system every time open() is called.
697 * @return This function returns true if the port was successfully changed
698 * to the desired port, false otherwise. If it returns false, there
699 * is no guarantee that MeshLink is listening on the old port.
701 bool set_port(int port) {
702 return meshlink_set_port(handle, port);
705 /// Set the timeout for invitations.
706 /** This function sets the timeout for invitations.
707 * The timeout is retroactively applied to all outstanding invitations.
709 * @param timeout The timeout for invitations in seconds.
711 void set_invitation_timeout(int timeout) {
712 meshlink_set_invitation_timeout(handle, timeout);
715 /// Set the scheduling granularity of the application
716 /** This should be set to the effective scheduling granularity for the application.
717 * This depends on the scheduling granularity of the operating system, the application's
718 * process priority and whether it is running as realtime or not.
719 * The default value is 10000 (10 milliseconds).
721 * @param granularity The scheduling granularity of the application in microseconds.
723 void set_granularity(long granularity) {
724 meshlink_set_scheduling_granularity(handle, granularity);
727 /// Sets the storage policy used by MeshLink
728 /** This sets the policy MeshLink uses when it has new information about nodes.
729 * By default, all udpates will be stored to disk (unless an ephemeral instance has been opened).
730 * Setting the policy to MESHLINK_STORAGE_KEYS_ONLY, only updates that contain new keys for nodes
731 * are stored, as well as blacklist/whitelist settings.
732 * By setting the policy to MESHLINK_STORAGE_DISABLED, no updates will be stored.
734 * @param policy The storage policy to use.
736 void set_storage_policy(meshlink_storage_policy_t policy) {
737 meshlink_set_storage_policy(handle, policy);
740 /// Invite another node into the mesh.
741 /** This function generates an invitation that can be used by another node to join the same mesh as the local node.
742 * The generated invitation is a string containing a URL.
743 * This URL should be passed by the application to the invitee in a way that no eavesdroppers can see the URL.
744 * The URL can only be used once, after the user has joined the mesh the URL is no longer valid.
746 * @param submesh A handle to the submesh to put the invitee in.
747 * @param name The name that the invitee will use in the mesh.
748 * @param flags A bitwise-or'd combination of flags that controls how the URL is generated.
750 * @return This function returns a string that contains the invitation URL.
751 * The application should call free() after it has finished using the URL.
753 char *invite(submesh *submesh, const char *name, uint32_t flags = 0) {
754 return meshlink_invite_ex(handle, submesh, name, flags);
757 /// Use an invitation to join a mesh.
758 /** This function allows the local node to join an existing mesh using an invitation URL generated by another node.
759 * An invitation can only be used if the local node has never connected to other nodes before.
760 * After a successfully accepted invitation, the name of the local node may have changed.
762 * 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.
764 * This function is blocking. It can take several seconds before it returns.
765 * There is no guarantee it will perform a successful join.
766 * Failures might be caused by temporary network outages, or by the invitation having expired.
768 * @param invitation A string containing the invitation URL.
770 * @return This function returns true if the local node joined the mesh it was invited to, false otherwise.
772 bool join(const char *invitation) {
773 return meshlink_join(handle, invitation);
776 /// Export the local node's key and addresses.
777 /** This function generates a string that contains the local node's public key and one or more IP addresses.
778 * The application can pass it in some way to another node, which can then import it,
779 * granting the local node access to the other node's mesh.
781 * @return This function returns a string that contains the exported key and addresses.
782 * The application should call free() after it has finished using this string.
785 return meshlink_export(handle);
788 /// Import another node's key and addresses.
789 /** This function accepts a string containing the exported public key and addresses of another node.
790 * By importing this data, the local node grants the other node access to its mesh.
792 * @param data A string containing the other node's exported key and addresses.
794 * @return This function returns true if the data was valid and the other node has been granted access to the mesh, false otherwise.
796 bool import_key(const char *data) {
797 return meshlink_import(handle, data);
800 /// Forget any information about a node.
801 /** This function allows the local node to forget any information it has about a node,
802 * and if possible will remove any data it has stored on disk about the node.
804 * Any open channels to this node must be closed before calling this function.
806 * After this call returns, the node handle is invalid and may no longer be used, regardless
807 * of the return value of this call.
809 * Note that this function does not prevent MeshLink from actually forgetting about a node,
810 * or re-learning information about a node at a later point in time. It is merely a hint that
811 * the application does not care about this node anymore and that any resources kept could be
814 * \memberof meshlink_node
815 * @param node A pointer to a struct meshlink_node describing the node to be forgotten.
817 * @return This function returns true if all currently known data about the node has been forgotten, false otherwise.
819 bool forget_node(node *node) {
820 return meshlink_forget_node(handle, node);
823 /// Blacklist a node from the mesh.
824 /** This function causes the local node to blacklist another node.
825 * The local node will drop any existing connections to that node,
826 * and will not send data to it nor accept any data received from it any more.
828 * @param node A pointer to a meshlink::node describing the node to be blacklisted.
830 * @return This function returns true if the node has been whitelisted, false otherwise.
832 bool blacklist(node *node) {
833 return meshlink_blacklist(handle, node);
836 /// Blacklist a node from the mesh by name.
837 /** This function causes the local node to blacklist another node by name.
838 * The local node will drop any existing connections to that node,
839 * and will not send data to it nor accept any data received from it any more.
841 * If no node by the given name is known, it is created.
843 * @param name The name of the node to blacklist.
845 * @return This function returns true if the node has been blacklisted, false otherwise.
847 bool blacklist_by_name(const char *name) {
848 return meshlink_blacklist_by_name(handle, name);
851 /// Whitelist a node on the mesh.
852 /** This function causes the local node to whitelist another node.
853 * The local node will allow connections to and from that node,
854 * and will send data to it and accept any data received from it.
856 * @param node A pointer to a meshlink::node describing the node to be whitelisted.
858 * @return This function returns true if the node has been whitelisted, false otherwise.
860 bool whitelist(node *node) {
861 return meshlink_whitelist(handle, node);
864 /// Whitelist a node on the mesh by name.
865 /** This function causes the local node to whitelist a node by name.
866 * The local node will allow connections to and from that node,
867 * and will send data to it and accept any data received from it.
869 * If no node by the given name is known, it is created.
870 * This is useful if new nodes are blacklisted by default.
872 * \memberof meshlink_node
873 * @param name The name of the node to whitelist.
875 * @return This function returns true if the node has been whitelisted, false otherwise.
877 bool whitelist_by_name(const char *name) {
878 return meshlink_whitelist_by_name(handle, name);
881 /// Set the poll callback.
882 /** This functions sets the callback that is called whenever data can be sent to another node.
883 * The callback is run in MeshLink's own thread.
884 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
885 * to pass data to or from the application's thread.
886 * The callback should also not block itself and return as quickly as possible.
888 * @param channel A handle for the channel.
889 * @param cb A pointer to the function which will be called when data can be sent to another node.
890 * If a NULL pointer is given, the callback will be disabled.
892 void set_channel_poll_cb(channel *channel, channel_poll_cb_t cb) {
893 meshlink_set_channel_poll_cb(handle, channel, (meshlink_channel_poll_cb_t)cb);
896 /// Set the send buffer size of a channel.
897 /** This function sets the desired size of the send buffer.
898 * The default size is 128 kB.
900 * @param channel A handle for the channel.
901 * @param size The desired size for the send buffer.
902 * If a NULL pointer is given, the callback will be disabled.
904 void set_channel_sndbuf(channel *channel, size_t size) {
905 meshlink_set_channel_sndbuf(handle, channel, size);
908 /// Set the receive buffer size of a channel.
909 /** This function sets the desired size of the receive buffer.
910 * The default size is 128 kB.
912 * @param channel A handle for the channel.
913 * @param size The desired size for the send buffer.
914 * If a NULL pointer is given, the callback will be disabled.
916 void set_channel_rcvbuf(channel *channel, size_t size) {
917 meshlink_set_channel_rcvbuf(handle, channel, size);
920 /// Set the flags of a channel.
921 /** This function allows changing some of the channel flags.
922 * Currently only MESHLINK_CHANNEL_NO_PARTIAL and MESHLINK_CHANNEL_DROP_LATE are supported, other flags are ignored.
923 * These flags only affect the local side of the channel with the peer.
924 * The changes take effect immediately.
926 * @param channel A handle for the channel.
927 * @param flags A bitwise-or'd combination of flags that set the semantics for this channel.
929 void set_channel_flags(channel *channel, uint32_t flags) {
930 meshlink_set_channel_flags(handle, channel, flags);
933 /// Set the send buffer storage of a channel.
934 /** This function provides MeshLink with a send buffer allocated by the application.
936 * @param channel A handle for the channel.
937 * @param buf A pointer to the start of the buffer.
938 * If a NULL pointer is given, MeshLink will use its own internal buffer again.
939 * @param size The size of the buffer.
941 void set_channel_sndbuf_storage(channel *channel, void *buf, size_t size) {
942 meshlink_set_channel_sndbuf_storage(handle, channel, buf, size);
945 /// Set the receive buffer storage of a channel.
946 /** This function provides MeshLink with a receive buffer allocated by the application.
948 * @param channel A handle for the channel.
949 * @param buf A pointer to the start of the buffer.
950 * If a NULL pointer is given, MeshLink will use its own internal buffer again.
951 * @param size The size of the buffer.
953 void set_channel_rcvbuf_storage(channel *channel, void *buf, size_t size) {
954 meshlink_set_channel_rcvbuf_storage(handle, channel, buf, size);
957 /// Set the connection timeout used for channels to the given node.
958 /** This sets the timeout after which unresponsive channels will be reported as closed.
959 * The timeout is set for all current and future channels to the given node.
961 * @param node The node to set the channel timeout for.
962 * @param timeout The timeout in seconds after which unresponsive channels will be reported as closed.
963 * The default is 60 seconds.
965 void set_node_channel_timeout(node *node, int timeout) {
966 meshlink_set_node_channel_timeout(handle, node, timeout);
969 /// Open a reliable stream channel to another node.
970 /** This function is called whenever a remote node wants to open a channel to the local node.
971 * The application then has to decide whether to accept or reject this channel.
973 * This function sets the channel poll callback to channel_poll_trampoline, which in turn
974 * calls channel_poll. To set a different, channel-specific poll callback, use set_channel_poll_cb.
976 * @param node The node to which this channel is being initiated.
977 * @param port The port number the peer wishes to connect to.
978 * @param cb A pointer to the function which will be called when the remote node sends data to the local node.
979 * @param data A pointer to a buffer containing data to already queue for sending.
980 * @param len The length of the data.
981 * If len is 0, the data pointer is copied into the channel's priv member.
982 * @param flags A bitwise-or'd combination of flags that set the semantics for this channel.
984 * @return A handle for the channel, or NULL in case of an error.
986 channel *channel_open(node *node, uint16_t port, channel_receive_cb_t cb, const void *data, size_t len, uint32_t flags = channel::TCP) {
987 channel *ch = (channel *)meshlink_channel_open_ex(handle, node, port, (meshlink_channel_receive_cb_t)cb, data, len, flags);
988 meshlink_set_channel_poll_cb(handle, ch, &channel_poll_trampoline);
992 /// Open a reliable stream channel to another node.
993 /** This function is called whenever a remote node wants to open a channel to the local node.
994 * The application then has to decide whether to accept or reject this channel.
996 * This function sets the channel receive callback to channel_receive_trampoline,
997 * which in turn calls channel_receive.
999 * This function sets the channel poll callback to channel_poll_trampoline, which in turn
1000 * calls channel_poll. To set a different, channel-specific poll callback, use set_channel_poll_cb.
1002 * @param node The node to which this channel is being initiated.
1003 * @param port The port number the peer wishes to connect to.
1004 * @param data A pointer to a buffer containing data to already queue for sending.
1005 * @param len The length of the data.
1006 * If len is 0, the data pointer is copied into the channel's priv member.
1007 * @param flags A bitwise-or'd combination of flags that set the semantics for this channel.
1009 * @return A handle for the channel, or NULL in case of an error.
1011 channel *channel_open(node *node, uint16_t port, const void *data, size_t len, uint32_t flags = channel::TCP) {
1012 channel *ch = (channel *)meshlink_channel_open_ex(handle, node, port, &channel_receive_trampoline, data, len, flags);
1013 meshlink_set_channel_poll_cb(handle, ch, &channel_poll_trampoline);
1017 /// Partially close a reliable stream channel.
1018 /** This shuts down the read or write side of a channel, or both, without closing the handle.
1019 * It can be used to inform the remote node that the local node has finished sending all data on the channel,
1020 * but still allows waiting for incoming data from the remote node.
1022 * @param channel A handle for the channel.
1023 * @param direction Must be one of SHUT_RD, SHUT_WR or SHUT_RDWR.
1025 void channel_shutdown(channel *channel, int direction) {
1026 return meshlink_channel_shutdown(handle, channel, direction);
1029 /// Close a reliable stream channel.
1030 /** This informs the remote node that the local node has finished sending all data on the channel.
1031 * It also causes the local node to stop accepting incoming data from the remote node.
1032 * Afterwards, the channel handle is invalid and must not be used any more.
1034 * It is allowed to call this function at any time on a valid handle, even inside callback functions.
1035 * If called with a valid handle, this function always succeeds, otherwise the result is undefined.
1037 * @param channel A handle for the channel.
1039 void channel_close(meshlink_channel_t *channel) {
1040 return meshlink_channel_close(handle, channel);
1043 /// Abort a reliable stream channel.
1044 /** This aborts a channel.
1045 * Data that was in the send and receive buffers is dropped, so potentially there is some data that
1046 * was sent on this channel that will not be received by the peer.
1047 * Afterwards, the channel handle is invalid and must not be used any more.
1049 * It is allowed to call this function at any time on a valid handle, even inside callback functions.
1050 * If called with a valid handle, this function always succeeds, otherwise the result is undefined.
1052 * @param channel A handle for the channel.
1054 void channel_abort(meshlink_channel_t *channel) {
1055 return meshlink_channel_abort(handle, channel);
1058 /// Transmit data on a channel
1059 /** This queues data to send to the remote node.
1061 * @param channel A handle for the channel.
1062 * @param data A pointer to a buffer containing data sent by the source.
1063 * @param len The length of the data.
1065 * @return The amount of data that was queued, which can be less than len, or a negative value in case of an error.
1066 * If MESHLINK_CHANNEL_NO_PARTIAL is set, then the result will either be len,
1067 * 0 if the buffer is currently too full, or -1 if len is too big even for an empty buffer.
1069 ssize_t channel_send(channel *channel, void *data, size_t len) {
1070 return meshlink_channel_send(handle, channel, data, len);
1073 /// Transmit data on a channel asynchronously
1074 /** This registers a buffer that will be used to send data to the remote node.
1075 * Multiple buffers can be registered, in which case data will be sent in the order the buffers were registered.
1076 * While there are still buffers with unsent data, the poll callback will not be called.
1078 * @param channel A handle for the channel.
1079 * @param data A pointer to a buffer containing data sent by the source, or NULL if there is no data to send.
1080 * After meshlink_channel_aio_send() returns, the buffer may not be modified or freed by the application
1081 * until the callback routine is called.
1082 * @param len The length of the data, or 0 if there is no data to send.
1083 * @param cb A pointer to the function which will be called when MeshLink has finished using the buffer.
1084 * @param priv A private pointer which was set by the application when submitting the buffer.
1086 * @return True if the buffer was enqueued, false otherwise.
1088 bool channel_aio_send(channel *channel, const void *data, size_t len, meshlink_aio_cb_t cb, void *priv) {
1089 return meshlink_channel_aio_send(handle, channel, data, len, cb, priv);
1092 /// Transmit data on a channel asynchronously from a filedescriptor
1093 /** This will read up to the specified length number of bytes from the given filedescriptor, and send it over the channel.
1094 * The callback may be returned early if there is an error reading from the filedescriptor.
1095 * While there is still with unsent data, the poll callback will not be called.
1097 * @param channel A handle for the channel.
1098 * @param fd A file descriptor from which data will be read.
1099 * @param len The length of the data, or 0 if there is no data to send.
1100 * @param cb A pointer to the function which will be called when MeshLink has finished using the filedescriptor.
1101 * @param priv A private pointer which was set by the application when submitting the buffer.
1103 * @return True if the buffer was enqueued, false otherwise.
1105 bool channel_aio_fd_send(channel *channel, int fd, size_t len, meshlink_aio_fd_cb_t cb, void *priv) {
1106 return meshlink_channel_aio_fd_send(handle, channel, fd, len, cb, priv);
1109 /// Receive data on a channel asynchronously
1110 /** This registers a buffer that will be filled with incoming channel data.
1111 * Multiple buffers can be registered, in which case data will be received in the order the buffers were registered.
1112 * While there are still buffers that have not been filled, the receive callback will not be called.
1114 * @param channel A handle for the channel.
1115 * @param data A pointer to a buffer that will be filled with incoming data.
1116 * After meshlink_channel_aio_receive() returns, the buffer may not be modified or freed by the application
1117 * until the callback routine is called.
1118 * @param len The length of the data.
1119 * @param cb A pointer to the function which will be called when MeshLink has finished using the buffer.
1120 * @param priv A private pointer which was set by the application when submitting the buffer.
1122 * @return True if the buffer was enqueued, false otherwise.
1124 bool channel_aio_receive(channel *channel, const void *data, size_t len, meshlink_aio_cb_t cb, void *priv) {
1125 return meshlink_channel_aio_receive(handle, channel, data, len, cb, priv);
1128 /// Receive data on a channel asynchronously and send it to a filedescriptor
1129 /** This will read up to the specified length number of bytes from the channel, and send it to the filedescriptor.
1130 * The callback may be returned early if there is an error writing to the filedescriptor.
1131 * While there is still unread data, the receive callback will not be called.
1133 * @param channel A handle for the channel.
1134 * @param fd A file descriptor to which data will be written.
1135 * @param len The length of the data.
1136 * @param cb A pointer to the function which will be called when MeshLink has finished using the filedescriptor.
1137 * @param priv A private pointer which was set by the application when submitting the buffer.
1139 * @return True if the buffer was enqueued, false otherwise.
1141 bool channel_aio_fd_receive(channel *channel, int fd, size_t len, meshlink_aio_fd_cb_t cb, void *priv) {
1142 return meshlink_channel_aio_fd_receive(handle, channel, fd, len, cb, priv);
1145 /// Get the amount of bytes in the send buffer.
1146 /** This returns the amount of bytes in the send buffer.
1147 * These bytes have not been received by the peer yet.
1149 * @param channel A handle for the channel.
1151 * @return The amount of un-ACKed bytes in the send buffer.
1153 size_t channel_get_sendq(channel *channel) {
1154 return meshlink_channel_get_sendq(handle, channel);
1157 /// Get the amount of bytes in the receive buffer.
1158 /** This returns the amount of bytes in the receive buffer.
1159 * These bytes have not been processed by the application yet.
1161 * @param channel A handle for the channel.
1163 * @return The amount of bytes in the receive buffer.
1165 size_t channel_get_recvq(channel *channel) {
1166 return meshlink_channel_get_recvq(handle, channel);
1169 /// Get the maximum segment size of a channel.
1170 /** This returns the amount of bytes that can be sent at once for channels with UDP semantics.
1172 * @param channel A handle for the channel.
1174 * @return The amount of bytes in the receive buffer.
1176 size_t channel_get_mss(channel *channel) {
1177 return meshlink_channel_get_mss(handle, channel);
1180 /// Enable or disable zeroconf discovery of local peers
1181 /** This controls whether zeroconf discovery using the Catta library will be
1182 * enabled to search for peers on the local network. By default, it is enabled.
1184 * @param enable Set to true to enable discovery, false to disable.
1186 void enable_discovery(bool enable = true) {
1187 meshlink_enable_discovery(handle, enable);
1190 /// Inform MeshLink that the local network configuration might have changed
1191 /** This is intended to be used when there is no way for MeshLink to get notifications of local network changes.
1192 * It forces MeshLink to scan all network interfaces for changes in up/down status and new/removed addresses,
1193 * and will immediately check if all connections to other nodes are still alive.
1195 void hint_network_change() {
1196 meshlink_hint_network_change(handle);
1199 /// Set device class timeouts
1200 /** This sets the ping interval and timeout for a given device class.
1202 * @param devclass The device class to update
1203 * @param pinginterval The interval between keepalive packets, in seconds. The default is 60.
1204 * @param pingtimeout The required time within which a peer should respond, in seconds. The default is 5.
1205 * The timeout must be smaller than the interval.
1207 void set_dev_class_timeouts(dev_class_t devclass, int pinginterval, int pingtimeout) {
1208 meshlink_set_dev_class_timeouts(handle, devclass, pinginterval, pingtimeout);
1211 /// Set device class fast retry period
1212 /** This sets the fast retry period for a given device class.
1213 * During this period after the last time the mesh becomes unreachable, connections are tried once a second.
1215 * @param devclass The device class to update
1216 * @param fast_retry_period The period during which fast connection retries are done. The default is 0.
1218 void set_dev_class_fast_retry_period(dev_class_t devclass, int fast_retry_period) {
1219 meshlink_set_dev_class_fast_retry_period(handle, devclass, fast_retry_period);
1222 /// Set device class maximum timeout
1223 /** This sets the maximum timeout for outgoing connection retries for a given device class.
1225 * @param devclass The device class to update
1226 * @param maxtimeout The maximum timeout between reconnection attempts, in seconds. The default is 900.
1228 void set_dev_class_maxtimeout(dev_class_t devclass, int maxtimeout) {
1229 meshlink_set_dev_class_maxtimeout(handle, devclass, maxtimeout);
1232 /// Set which order invitations are committed
1233 /** This determines in which order configuration files are written to disk during an invitation.
1234 * By default, the invitee saves the configuration to disk first, then the inviter.
1235 * By calling this function with @a inviter_commits_first set to true, the order is reversed.
1237 * @param inviter_commits_first If true, then the node that invited a peer will commit data to disk first.
1239 void set_inviter_commits_first(bool inviter_commits_first) {
1240 meshlink_set_inviter_commits_first(handle, inviter_commits_first);
1243 /// Set the URL used to discover the host's external address
1244 /** For generating invitation URLs, MeshLink can look up the externally visible address of the local node.
1245 * It does so by querying an external service. By default, this is http://meshlink.io/host.cgi.
1246 * Only URLs starting with http:// are supported.
1248 * @param url The URL to use for external address queries, or NULL to revert back to the default URL.
1250 void set_external_address_discovery_url(const char *url) {
1251 meshlink_set_external_address_discovery_url(handle, url);
1256 mesh(const mesh &) /* TODO: C++11: = delete */;
1257 void operator=(const mesh &) /* TODO: C++11: = delete */;
1259 /// static callback trampolines:
1260 static void receive_trampoline(meshlink_handle_t *handle, meshlink_node_t *source, const void *data, size_t length) {
1261 if(!(handle->priv)) {
1265 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1266 that->receive(static_cast<node *>(source), data, length);
1269 static void node_status_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer, bool reachable) {
1270 if(!(handle->priv)) {
1274 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1275 that->node_status(static_cast<node *>(peer), reachable);
1278 static void node_pmtu_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer, uint16_t pmtu) {
1279 if(!(handle->priv)) {
1283 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1284 that->node_pmtu(static_cast<node *>(peer), pmtu);
1287 static void node_duplicate_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer) {
1288 if(!(handle->priv)) {
1292 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1293 that->node_duplicate(static_cast<node *>(peer));
1296 static void log_trampoline(meshlink_handle_t *handle, log_level_t level, const char *message) {
1297 if(!(handle->priv)) {
1301 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1302 that->log(level, message);
1305 static void error_trampoline(meshlink_handle_t *handle, meshlink_errno_t meshlink_errno) {
1306 if(!(handle->priv)) {
1310 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1311 that->error(meshlink_errno);
1314 static void blacklisted_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer) {
1315 if(!(handle->priv)) {
1319 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1320 that->blacklisted(static_cast<node *>(peer));
1323 static void thread_status_trampoline(meshlink_handle_t *handle, bool status) {
1324 if(!(handle->priv)) {
1328 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1329 that->thread_status(status);
1332 static void connection_try_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer) {
1333 if(!(handle->priv)) {
1337 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1338 that->connection_try(static_cast<node *>(peer));
1341 static bool channel_listen_trampoline(meshlink_handle_t *handle, meshlink_node_t *node, uint16_t port) {
1342 if(!(handle->priv)) {
1346 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1347 return that->channel_listen(static_cast<meshlink::node *>(node), port);
1350 static bool channel_accept_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, uint16_t port, const void *data, size_t len) {
1351 if(!(handle->priv)) {
1355 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1356 bool accepted = that->channel_accept(static_cast<meshlink::channel *>(channel), port, data, len);
1359 meshlink_set_channel_receive_cb(handle, channel, &channel_receive_trampoline);
1360 meshlink_set_channel_poll_cb(handle, channel, &channel_poll_trampoline);
1366 static void channel_receive_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, const void *data, size_t len) {
1367 if(!(handle->priv)) {
1371 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1372 that->channel_receive(static_cast<meshlink::channel *>(channel), data, len);
1375 static void channel_poll_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, size_t len) {
1376 if(!(handle->priv)) {
1380 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1381 that->channel_poll(static_cast<meshlink::channel *>(channel), len);
1384 meshlink_handle_t *handle;
1387 static inline const char *strerror(errno_t err = meshlink_errno) {
1388 return meshlink_strerror(err);
1391 /// Destroy a MeshLink instance.
1392 /** This function remove all configuration files of a MeshLink instance. It should only be called when the application
1393 * does not have an open handle to this instance. Afterwards, a call to meshlink_open() will create a completely
1396 * @param confbase The directory in which MeshLink stores its configuration files.
1397 * After the function returns, the application is free to overwrite or free @a confbase @a.
1399 * @return This function will return true if the MeshLink instance was successfully destroyed, false otherwise.
1401 static inline bool destroy(const char *confbase) {
1402 return meshlink_destroy(confbase);