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 callback that loads a configuration object.
142 /** @param mesh A handle which represents an instance of MeshLink.
143 * @param key The key under which the configuration object was stored before.
144 * @param[out] data A pointer to a pointer to the buffer where the object has to be copied into.
145 * No more than len bytes should be written to this buffer.
146 * @param[in,out] len A pointer to the size of object.
147 * MeshLink sets this to the size of the buffer.
148 * The application must write the actual size of the object to it,
149 * regardless of whether it is larger or smaller than the buffer.
151 * @return This function must return true if the object was read and copied into the buffer succesfully,
153 * If the buffer provided by MeshLink was too small for the whole object, but no other errors
154 * occured, true must be returned.
156 typedef bool (*load_cb_t)(mesh *mesh, const char *filename, void *data, size_t *len);
158 /// A callback that stores a configuration object.
159 /** @param mesh A handle which represents an instance of MeshLink.
160 * @param key The key under which the object should be stored.
161 * @param data A pointer to the buffer holding the data that must be stored.
162 * @param len The size of the buffer that must be stored.
164 * @return This function must return true if the file was written succesfully, false otherwise.
166 typedef bool (*store_cb_t)(mesh *mesh, const char *filename, const void *data, size_t len);
168 /// A callback that reports the presence of a configuration object.
169 /** @param mesh A handle which represents an instance of MeshLink.
170 * @param key The key the object is stored under.
171 * @param len The size of the object if easy to obtain, zero otherwise.
173 * @return The return value. If it is false, the ls callback should immediately stop and return false as well.
175 typedef bool (*ls_entry_cb_t)(mesh *mesh, const char *key, size_t len);
177 /// A callback that lists all configuration files.
178 /** @param mesh A handle which represents an instance of MeshLink.
179 * @param entry_cb A callback that must be called once for every configuration file found.
181 * @return This function must return true if all configuration files were listed
182 * and all entry callbacks return true as well, false otherwise.
184 typedef bool (*ls_cb_t)(mesh *mesh, ls_entry_cb_t entry_cb);
187 /// A class describing a MeshLink node.
188 class node: public meshlink_node_t {
191 /// A class describing a MeshLink Sub-Mesh.
192 class submesh: public meshlink_submesh_t {
195 /// A class describing a MeshLink channel.
196 class channel: public meshlink_channel_t {
198 static const uint32_t RELIABLE = MESHLINK_CHANNEL_RELIABLE;
199 static const uint32_t ORDERED = MESHLINK_CHANNEL_ORDERED;
200 static const uint32_t FRAMED = MESHLINK_CHANNEL_FRAMED;
201 static const uint32_t DROP_LATE = MESHLINK_CHANNEL_DROP_LATE;
202 static const uint32_t NO_PARTIAL = MESHLINK_CHANNEL_NO_PARTIAL;
203 static const uint32_t TCP = MESHLINK_CHANNEL_TCP;
204 static const uint32_t UDP = MESHLINK_CHANNEL_UDP;
209 meshlink_open_params_t *params;
212 open_params(const char *confbase, const char *name, const char *appname, dev_class_t devclass):
213 params(meshlink_open_params_init(confbase, name, appname, devclass)) {}
216 meshlink_open_params_free(params);
219 bool set_netns(int netns) {
220 return meshlink_open_params_set_netns(params, netns);
223 bool set_storage_callbacks(meshlink_load_cb_t load_cb, meshlink_store_cb_t store_cb, meshlink_ls_cb_t ls_cb) {
224 return meshlink_open_params_set_storage_callbacks(params, load_cb, store_cb, ls_cb);
227 bool set_storage_key(const void *key, size_t keylen) {
228 return meshlink_open_params_set_storage_key(params, key, keylen);
231 bool set_storage_policy(meshlink_storage_policy_t policy) {
232 return meshlink_open_params_set_storage_policy(params, policy);
235 bool set_lock_filename(const char *filename) {
236 return meshlink_open_params_set_lock_filename(params, filename);
240 /// A class describing a MeshLink mesh.
243 mesh() : handle(0) {}
249 bool isOpen() const {
250 return (handle != 0);
253 // TODO: please enable C++11 in autoconf to enable "move constructors":
254 // mesh(mesh&& other)
255 // : handle(other.handle)
258 // handle->priv = this;
262 /// Initialize MeshLink's configuration directory.
263 /** This function causes MeshLink to initialize its configuration directory,
264 * if it hasn't already been initialized.
265 * It only has to be run the first time the application starts,
266 * but it is not a problem if it is run more than once, as long as
267 * the arguments given are the same.
269 * This function does not start any network I/O yet. The application should
270 * first set callbacks, and then call meshlink_start().
272 * @param confbase The directory in which MeshLink will store its configuration files.
273 * @param name The name which this instance of the application will use in the mesh.
274 * @param appname The application name which will be used in the mesh.
275 * @param devclass The device class which will be used in the mesh.
277 * @return This function will return a pointer to a meshlink::mesh if MeshLink has successfully set up its configuration files, NULL otherwise.
279 bool open(const char *confbase, const char *name, const char *appname, dev_class_t devclass) {
280 handle = meshlink_open(confbase, name, appname, devclass);
289 bool open(const open_params ¶ms) {
290 handle = meshlink_open_ex(params.params);
299 mesh(const char *confbase, const char *name, const char *appname, dev_class_t devclass) {
300 open(confbase, name, appname, devclass);
303 mesh(const open_params ¶ms) {
307 /// Close the MeshLink handle.
308 /** This function calls meshlink_stop() if necessary,
309 * and frees all memory allocated by MeshLink.
310 * Afterwards, the handle and any pointers to a struct meshlink_node are invalid.
315 meshlink_close(handle);
321 /** instead of registerin callbacks you derive your own class and overwrite the following abstract member functions.
322 * These functions are run in MeshLink's own thread.
323 * It is therefore important that these functions use apprioriate methods (queues, pipes, locking, etc.)
324 * to hand the data over to the application's thread.
325 * These functions should also not block itself and return as quickly as possible.
326 * The default member functions are no-ops, so you are not required to overwrite all these member functions
329 /// This function is called whenever another node sends data to the local node.
330 virtual void receive(node *source, const void *data, size_t length) {
337 /// This functions is called whenever another node's status changed.
338 virtual void node_status(node *peer, bool reachable) {
344 /// This functions is called whenever another node's path MTU changes.
345 virtual void node_pmtu(node *peer, uint16_t pmtu) {
351 /// This functions is called whenever a duplicate node is detected.
352 virtual void node_duplicate(node *peer) {
357 /// This functions is called whenever MeshLink has some information to log.
358 virtual void log(log_level_t level, const char *message) {
364 /// This functions is called whenever MeshLink has encountered a serious error.
365 virtual void error(meshlink_errno_t meshlink_errno) {
367 (void)meshlink_errno;
370 /// This functions is called whenever MeshLink is blacklisted by another node.
371 virtual void blacklisted(node *peer) {
376 /// This functions is called whenever the MeshLink thread status changes.
377 virtual void thread_status(bool status) {
382 /// This functions is called whenever MeshLink a meta-connection attempt is made.
383 virtual void connection_try(node *peer) {
388 /// This functions is called to determine if we are listening for incoming channels.
390 * The function is run in MeshLink's own thread.
391 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
392 * to pass data to or from the application's thread.
393 * The callback should also not block itself and return as quickly as possible.
395 * @param node A handle for the node that wants to open a channel.
396 * @param port The port number the peer wishes to connect to.
398 * @return This function should return true if the application accepts the incoming channel, false otherwise.
400 virtual bool channel_listen(node *node, uint16_t port) {
401 /* by default accept all channels */
407 /// This functions is called whenever another node attempts to open a channel to the local node.
409 * If the channel is accepted, the poll_callback will be set to channel_poll and can be
410 * changed using set_channel_poll_cb(). Likewise, the receive callback is set to
413 * The function is run in MeshLink's own thread.
414 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
415 * to pass data to or from the application's thread.
416 * The callback should also not block itself and return as quickly as possible.
418 * @param channel A handle for the incoming channel.
419 * @param port The port number the peer wishes to connect to.
420 * @param data A pointer to a buffer containing data already received. (Not yet used.)
421 * @param len The length of the data. (Not yet used.)
423 * @return This function should return true if the application accepts the incoming channel, false otherwise.
424 * If returning false, the channel is invalid and may not be used anymore.
426 virtual bool channel_accept(channel *channel, uint16_t port, const void *data, size_t len) {
427 /* by default reject all channels */
435 /// This function is called by Meshlink for receiving data from a channel.
437 * The function is run in MeshLink's own thread.
438 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
439 * to pass data to or from the application's thread.
440 * The callback should also not block itself and return as quickly as possible.
442 * @param channel A handle for the channel.
443 * @param data A pointer to a buffer containing data sent by the source.
444 * @param len The length of the data.
446 virtual void channel_receive(channel *channel, const void *data, size_t len) {
453 /// This function is called by Meshlink when data can be send on a channel.
455 * The function is run in MeshLink's own thread.
456 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
457 * to pass data to or from the application's thread.
459 * The callback should also not block itself and return as quickly as possible.
460 * @param channel A handle for the channel.
461 * @param len The maximum length of data that is guaranteed to be accepted by a call to channel_send().
463 virtual void channel_poll(channel *channel, size_t len) {
470 /** This function causes MeshLink to open network sockets, make outgoing connections, and
471 * create a new thread, which will handle all network I/O.
473 * @return This function will return true if MeshLink has successfully started its thread, false otherwise.
476 meshlink_set_receive_cb(handle, &receive_trampoline);
477 meshlink_set_node_status_cb(handle, &node_status_trampoline);
478 meshlink_set_node_pmtu_cb(handle, &node_pmtu_trampoline);
479 meshlink_set_node_duplicate_cb(handle, &node_duplicate_trampoline);
480 meshlink_set_log_cb(handle, MESHLINK_DEBUG, &log_trampoline);
481 meshlink_set_error_cb(handle, &error_trampoline);
482 meshlink_set_blacklisted_cb(handle, &blacklisted_trampoline);
483 meshlink_set_thread_status_cb(handle, &thread_status_trampoline);
484 meshlink_set_channel_listen_cb(handle, &channel_listen_trampoline);
485 meshlink_set_channel_accept_cb(handle, &channel_accept_trampoline);
486 meshlink_set_connection_try_cb(handle, &connection_try_trampoline);
487 return meshlink_start(handle);
491 /** This function causes MeshLink to disconnect from all other nodes,
492 * close all sockets, and shut down its own thread.
495 meshlink_stop(handle);
498 /// Send data to another node.
499 /** This functions sends one packet of data to another node in the mesh.
500 * The packet is sent using UDP semantics, which means that
501 * the packet is sent as one unit and is received as one unit,
502 * and that there is no guarantee that the packet will arrive at the destination.
503 * The application should take care of getting an acknowledgement and retransmission if necessary.
505 * @param destination A pointer to a meshlink::node describing the destination for the data.
506 * @param data A pointer to a buffer containing the data to be sent to the source.
507 * @param len The length of the data.
508 * @return This function will return true if MeshLink has queued the message for transmission, and false otherwise.
509 * A return value of true does not guarantee that the message will actually arrive at the destination.
511 bool send(node *destination, const void *data, unsigned int len) {
512 return meshlink_send(handle, destination, data, len);
515 /// Get a handle for a specific node.
516 /** This function returns a handle for the node with the given name.
518 * @param name The name of the node for which a handle is requested.
520 * @return A pointer to a meshlink::node which represents the requested node,
521 * or NULL if the requested node does not exist.
523 node *get_node(const char *name) {
524 return (node *)meshlink_get_node(handle, name);
527 /// Get a node's reachability status.
528 /** This function returns the current reachability of a given node, and the times of the last state changes.
529 * If a given state change never happened, the time returned will be 0.
531 * @param node A pointer to a meshlink::node describing the node.
532 * @param last_reachable A pointer to a time_t variable that will be filled in with the last time the node became reachable.
533 * @param last_unreachable A pointer to a time_t variable that will be filled in with the last time the node became unreachable.
535 * @return This function returns true if the node is currently reachable, false otherwise.
537 bool get_node_reachability(node *node, time_t *last_reachable = NULL, time_t *last_unreachable = NULL) {
538 return meshlink_get_node_reachability(handle, node, last_reachable, last_unreachable);
541 /// Get a node's blacklist status.
542 /** This function returns the current blacklist status of a given node.
544 * @param node A pointer to a meshlink::node describing the node.
546 * @return This function returns true if the node is currently blacklisted, false otherwise.
548 bool get_node_blacklisted(node *node) {
549 return meshlink_get_node_blacklisted(handle, node);
552 /// Get the node's tiny status.
553 /** This function returns true if the given node is a tiny node.
554 * Note that the tiny status of a node will only be known if the node has been reachable at least once.
556 * @param node A pointer to a meshlink::node describing the node.
558 * @return This function returns true if the node is a tiny node.
560 bool get_node_tiny(node *node) {
561 return meshlink_get_node_tiny(handle, node);
564 /// Get a handle for a specific submesh.
565 /** This function returns a handle for the submesh with the given name.
567 * @param name The name of the submesh for which a handle is requested.
569 * @return A pointer to a meshlink::submesh which represents the requested submesh,
570 * or NULL if the requested submesh does not exist.
572 submesh *get_submesh(const char *name) {
573 return (submesh *)meshlink_get_submesh(handle, name);
576 /// Get a handle for our own node.
577 /** This function returns a handle for the local node.
579 * @return A pointer to a meshlink::node which represents the local node.
582 return (node *)meshlink_get_self(handle);
585 /// Get a list of all nodes.
586 /** This function returns a list with handles for all known nodes.
588 * @param nodes A pointer to an array of pointers to meshlink::node, which should be allocated by the application.
589 * @param nmemb The maximum number of pointers that can be stored in the nodes array.
591 * @return The number of known nodes, or -1 in case of an error.
592 * This can be larger than nmemb, in which case not all nodes were stored in the nodes array.
594 node **get_all_nodes(node **nodes, size_t *nmemb) {
595 return (node **)meshlink_get_all_nodes(handle, (meshlink_node_t **)nodes, nmemb);
598 /// Get a list of all nodes by blacklist status.
599 /** This function returns a list with handles for all the nodes who were either blacklisted or whitelisted.
601 * @param blacklisted If true, a list of blacklisted nodes will be returned, otherwise whitelisted nodes.
602 * @param nodes A pointer to an array of pointers to meshlink::node, which should be allocated by the application.
603 * @param nmemb The maximum number of pointers that can be stored in the nodes array.
605 * @return A pointer to an array containing pointers to all known nodes with the given blacklist status.
606 * If the @a nodes argument was not NULL, then the return value can either be the same value or a different value.
607 * If it is a new value, the old value of @a nodes should not be used anymore.
608 * If the new value is NULL, then the old array will have been freed by MeshLink.
610 node **get_all_nodes_by_blacklisted(bool blacklisted, node **nodes, size_t *nmemb) {
611 return (node **)meshlink_get_all_nodes_by_blacklisted(handle, blacklisted, (meshlink_node_t **)nodes, nmemb);
614 /// Sign data using the local node's MeshLink key.
615 /** This function signs data using the local node's MeshLink key.
616 * The generated signature can be securely verified by other nodes.
618 * @param data A pointer to a buffer containing the data to be signed.
619 * @param len The length of the data to be signed.
620 * @param signature A pointer to a buffer where the signature will be stored.
621 * @param siglen The size of the signature buffer. Will be changed after the call to match the size of the signature itself.
623 * @return This function returns true if the signature is valid, false otherwise.
625 bool sign(const void *data, size_t len, void *signature, size_t *siglen) {
626 return meshlink_sign(handle, data, len, signature, siglen);
629 /// Verify the signature generated by another node of a piece of data.
630 /** This function verifies the signature that another node generated for a piece of data.
632 * @param source A pointer to a meshlink_node_t describing the source of the signature.
633 * @param data A pointer to a buffer containing the data to be verified.
634 * @param len The length of the data to be verified.
635 * @param signature A pointer to a string containing the signature.
636 * @param siglen The size of the signature.
638 * @return This function returns true if the signature is valid, false otherwise.
640 bool verify(node *source, const void *data, size_t len, const void *signature, size_t siglen) {
641 return meshlink_verify(handle, source, data, len, signature, siglen);
644 /// Set the canonical Address for a node.
645 /** This function sets the canonical Address for a node.
646 * This address is stored permanently until it is changed by another call to this function,
647 * unlike other addresses associated with a node,
648 * such as those added with meshlink_hint_address() or addresses discovered at runtime.
650 * If a canonical Address is set for the local node,
651 * it will be used for the hostname part of generated invitation URLs.
653 * @param node A pointer to a meshlink_node_t describing the node.
654 * @param address A nul-terminated C string containing the address, which can be either in numeric format or a hostname.
655 * @param port A nul-terminated C string containing the port, which can be either in numeric or symbolic format.
656 * If it is NULL, the listening port's number will be used.
658 * @return This function returns true if the address was added, false otherwise.
660 bool set_canonical_address(node *node, const char *address, const char *port = NULL) {
661 return meshlink_set_canonical_address(handle, node, address, port);
664 /// Clear the canonical Address for a node.
665 /** This function clears the canonical Address for a node.
667 * @param node A pointer to a struct meshlink_node describing the node.
669 * @return This function returns true if the address was removed, false otherwise.
671 bool clear_canonical_address(node *node) {
672 return meshlink_clear_canonical_address(handle, node);
675 /// Add an invitation address for the local node.
676 /** This function adds an address for the local node, which will be used only for invitation URLs.
677 * This address is not stored permanently.
678 * Multiple addresses can be added using multiple calls to this function.
680 * @param address A nul-terminated C string containing the address, which can be either in numeric format or a hostname.
681 * @param port A nul-terminated C string containing the port, which can be either in numeric or symbolic format.
682 * If it is NULL, the listening port's number will be used.
684 * @return This function returns true if the address was added, false otherwise.
686 bool add_invitation_address(const char *address, const char *port) {
687 return meshlink_add_invitation_address(handle, address, port);
690 /// Clears all invitation address for the local node.
691 /** This function removes all addresses added with meshlink_add_invitation_address().
693 void clear_invitation_addresses() {
694 return meshlink_clear_invitation_addresses(handle);
697 /// Add an Address for the local node.
698 /** This function adds an Address for the local node, which will be used for invitation URLs.
699 * @deprecated This function is deprecated, use set_canonical_address() and/or add_invitation_address().
701 * @param address A string containing the address, which can be either in numeric format or a hostname.
703 * @return This function returns true if the address was added, false otherwise.
705 bool add_address(const char *address) __attribute__((__deprecated__("use set_canonical_address() and/or add_invitation_address() instead"))) {
706 return meshlink_set_canonical_address(handle, get_self(), address, NULL);
709 /** This function performs tries to discover the local node's external address
710 * by contacting the meshlink.io server. If a reverse lookup of the address works,
711 * the FQDN associated with the address will be returned.
713 * Please note that this is function only returns a single address,
714 * even if the local node might have more than one external address.
715 * In that case, there is no control over which address will be selected.
716 * Also note that if you have a dynamic IP address, or are behind carrier-grade NAT,
717 * there is no guarantee that the external address will be valid for an extended period of time.
719 * This function is blocking. It can take several seconds before it returns.
720 * There is no guarantee it will be able to resolve the external address.
721 * Failures might be because by temporary network outages.
723 * @param family The address family to check, for example AF_INET or AF_INET6. If AF_UNSPEC is given,
724 * this might return the external address for any working address family.
726 * @return This function returns a pointer to a C string containing the discovered external address,
727 * or NULL if there was an error looking up the address.
728 * After get_external_address() returns, the application is free to overwrite or free this string.
730 bool get_external_address(int family = AF_UNSPEC) {
731 return meshlink_get_external_address_for_family(handle, family);
734 /** This function performs tries to discover the address of the local interface used for outgoing connection.
736 * Please note that this is function only returns a single address,
737 * even if the local node might have more than one external address.
738 * In that case, there is no control over which address will be selected.
739 * Also note that if you have a dynamic IP address, or are behind carrier-grade NAT,
740 * there is no guarantee that the external address will be valid for an extended period of time.
742 * This function will fail if it couldn't find a local address for the given address family.
743 * If hostname resolving is requested, this function may block for a few seconds.
745 * @param family The address family to check, for example AF_INET or AF_INET6. If AF_UNSPEC is given,
746 * this might return the external address for any working address family.
748 * @return This function returns a pointer to a C string containing the discovered external address,
749 * or NULL if there was an error looking up the address.
750 * After get_external_address() returns, the application is free to overwrite or free this string.
752 bool get_local_address(int family = AF_UNSPEC) {
753 return meshlink_get_local_address_for_family(handle, family);
756 /// Try to discover the external address for the local node, and add it to its list of addresses.
757 /** This function is equivalent to:
759 * mesh->add_address(mesh->get_external_address());
761 * Read the description of get_external_address() for the limitations of this function.
763 * @return This function returns true if the address was added, false otherwise.
765 bool add_external_address() {
766 return meshlink_add_external_address(handle);
769 /// Get the network port used by the local node.
770 /** This function returns the network port that the local node is listening on.
772 * @return This function returns the port number, or -1 in case of an error.
775 return meshlink_get_port(handle);
778 /// Set the network port used by the local node.
779 /** This function sets the network port that the local node is listening on.
780 * It may only be called when the mesh is not running.
781 * If unsure, call stop() before calling this function.
782 * Also note that if your node is already part of a mesh with other nodes,
783 * that the other nodes may no longer be able to initiate connections to the local node,
784 * since they will try to connect to the previously configured port.
786 * @param port The port number to listen on. This must be between 0 and 65535.
787 * If the port is set to 0, then MeshLink will listen on a port
788 * that is randomly assigned by the operating system every time open() is called.
790 * @return This function returns true if the port was successfully changed
791 * to the desired port, false otherwise. If it returns false, there
792 * is no guarantee that MeshLink is listening on the old port.
794 bool set_port(int port) {
795 return meshlink_set_port(handle, port);
798 /// Set the timeout for invitations.
799 /** This function sets the timeout for invitations.
800 * The timeout is retroactively applied to all outstanding invitations.
802 * @param timeout The timeout for invitations in seconds.
804 void set_invitation_timeout(int timeout) {
805 meshlink_set_invitation_timeout(handle, timeout);
808 /// Set the scheduling granularity of the application
809 /** This should be set to the effective scheduling granularity for the application.
810 * This depends on the scheduling granularity of the operating system, the application's
811 * process priority and whether it is running as realtime or not.
812 * The default value is 10000 (10 milliseconds).
814 * @param granularity The scheduling granularity of the application in microseconds.
816 void set_granularity(long granularity) {
817 meshlink_set_scheduling_granularity(handle, granularity);
820 /// Sets the storage policy used by MeshLink
821 /** This sets the policy MeshLink uses when it has new information about nodes.
822 * By default, all udpates will be stored to disk (unless an ephemeral instance has been opened).
823 * Setting the policy to MESHLINK_STORAGE_KEYS_ONLY, only updates that contain new keys for nodes
824 * are stored, as well as blacklist/whitelist settings.
825 * By setting the policy to MESHLINK_STORAGE_DISABLED, no updates will be stored.
827 * @param policy The storage policy to use.
829 void set_storage_policy(meshlink_storage_policy_t policy) {
830 meshlink_set_storage_policy(handle, policy);
833 /// Invite another node into the mesh.
834 /** This function generates an invitation that can be used by another node to join the same mesh as the local node.
835 * The generated invitation is a string containing a URL.
836 * This URL should be passed by the application to the invitee in a way that no eavesdroppers can see the URL.
837 * The URL can only be used once, after the user has joined the mesh the URL is no longer valid.
839 * @param submesh A handle to the submesh to put the invitee in.
840 * @param name The name that the invitee will use in the mesh.
841 * @param flags A bitwise-or'd combination of flags that controls how the URL is generated.
843 * @return This function returns a string that contains the invitation URL.
844 * The application should call free() after it has finished using the URL.
846 char *invite(submesh *submesh, const char *name, uint32_t flags = 0) {
847 return meshlink_invite_ex(handle, submesh, name, flags);
850 /// Use an invitation to join a mesh.
851 /** This function allows the local node to join an existing mesh using an invitation URL generated by another node.
852 * An invitation can only be used if the local node has never connected to other nodes before.
853 * After a successfully accepted invitation, the name of the local node may have changed.
855 * 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.
857 * This function is blocking. It can take several seconds before it returns.
858 * There is no guarantee it will perform a successful join.
859 * Failures might be caused by temporary network outages, or by the invitation having expired.
861 * @param invitation A string containing the invitation URL.
863 * @return This function returns true if the local node joined the mesh it was invited to, false otherwise.
865 bool join(const char *invitation) {
866 return meshlink_join(handle, invitation);
869 /// Export the local node's key and addresses.
870 /** This function generates a string that contains the local node's public key and one or more IP addresses.
871 * The application can pass it in some way to another node, which can then import it,
872 * granting the local node access to the other node's mesh.
874 * @return This function returns a string that contains the exported key and addresses.
875 * The application should call free() after it has finished using this string.
878 return meshlink_export(handle);
881 /// Import another node's key and addresses.
882 /** This function accepts a string containing the exported public key and addresses of another node.
883 * By importing this data, the local node grants the other node access to its mesh.
885 * @param data A string containing the other node's exported key and addresses.
887 * @return This function returns true if the data was valid and the other node has been granted access to the mesh, false otherwise.
889 bool import_key(const char *data) {
890 return meshlink_import(handle, data);
893 /// Forget any information about a node.
894 /** This function allows the local node to forget any information it has about a node,
895 * and if possible will remove any data it has stored on disk about the node.
897 * Any open channels to this node must be closed before calling this function.
899 * After this call returns, the node handle is invalid and may no longer be used, regardless
900 * of the return value of this call.
902 * Note that this function does not prevent MeshLink from actually forgetting about a node,
903 * or re-learning information about a node at a later point in time. It is merely a hint that
904 * the application does not care about this node anymore and that any resources kept could be
907 * \memberof meshlink_node
908 * @param node A pointer to a struct meshlink_node describing the node to be forgotten.
910 * @return This function returns true if all currently known data about the node has been forgotten, false otherwise.
912 bool forget_node(node *node) {
913 return meshlink_forget_node(handle, node);
916 /// Blacklist a node from the mesh.
917 /** This function causes the local node to blacklist another node.
918 * The local node will drop any existing connections to that node,
919 * and will not send data to it nor accept any data received from it any more.
921 * @param node A pointer to a meshlink::node describing the node to be blacklisted.
923 * @return This function returns true if the node has been whitelisted, false otherwise.
925 bool blacklist(node *node) {
926 return meshlink_blacklist(handle, node);
929 /// Blacklist a node from the mesh by name.
930 /** This function causes the local node to blacklist another node by name.
931 * The local node will drop any existing connections to that node,
932 * and will not send data to it nor accept any data received from it any more.
934 * If no node by the given name is known, it is created.
936 * @param name The name of the node to blacklist.
938 * @return This function returns true if the node has been blacklisted, false otherwise.
940 bool blacklist_by_name(const char *name) {
941 return meshlink_blacklist_by_name(handle, name);
944 /// Whitelist a node on the mesh.
945 /** This function causes the local node to whitelist another node.
946 * The local node will allow connections to and from that node,
947 * and will send data to it and accept any data received from it.
949 * @param node A pointer to a meshlink::node describing the node to be whitelisted.
951 * @return This function returns true if the node has been whitelisted, false otherwise.
953 bool whitelist(node *node) {
954 return meshlink_whitelist(handle, node);
957 /// Whitelist a node on the mesh by name.
958 /** This function causes the local node to whitelist a node by name.
959 * The local node will allow connections to and from that node,
960 * and will send data to it and accept any data received from it.
962 * If no node by the given name is known, it is created.
963 * This is useful if new nodes are blacklisted by default.
965 * \memberof meshlink_node
966 * @param name The name of the node to whitelist.
968 * @return This function returns true if the node has been whitelisted, false otherwise.
970 bool whitelist_by_name(const char *name) {
971 return meshlink_whitelist_by_name(handle, name);
974 /// Set the poll callback.
975 /** This functions sets the callback that is called whenever data can be sent to another node.
976 * The callback is run in MeshLink's own thread.
977 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
978 * to pass data to or from the application's thread.
979 * The callback should also not block itself and return as quickly as possible.
981 * @param channel A handle for the channel.
982 * @param cb A pointer to the function which will be called when data can be sent to another node.
983 * If a NULL pointer is given, the callback will be disabled.
985 void set_channel_poll_cb(channel *channel, channel_poll_cb_t cb) {
986 meshlink_set_channel_poll_cb(handle, channel, (meshlink_channel_poll_cb_t)cb);
989 /// Set the send buffer size of a channel.
990 /** This function sets the desired size of the send buffer.
991 * The default size is 128 kB.
993 * @param channel A handle for the channel.
994 * @param size The desired size for the send buffer.
995 * If a NULL pointer is given, the callback will be disabled.
997 void set_channel_sndbuf(channel *channel, size_t size) {
998 meshlink_set_channel_sndbuf(handle, channel, size);
1001 /// Set the receive buffer size of a channel.
1002 /** This function sets the desired size of the receive buffer.
1003 * The default size is 128 kB.
1005 * @param channel A handle for the channel.
1006 * @param size The desired size for the send buffer.
1007 * If a NULL pointer is given, the callback will be disabled.
1009 void set_channel_rcvbuf(channel *channel, size_t size) {
1010 meshlink_set_channel_rcvbuf(handle, channel, size);
1013 /// Set the flags of a channel.
1014 /** This function allows changing some of the channel flags.
1015 * Currently only MESHLINK_CHANNEL_NO_PARTIAL and MESHLINK_CHANNEL_DROP_LATE are supported, other flags are ignored.
1016 * These flags only affect the local side of the channel with the peer.
1017 * The changes take effect immediately.
1019 * @param channel A handle for the channel.
1020 * @param flags A bitwise-or'd combination of flags that set the semantics for this channel.
1022 void set_channel_flags(channel *channel, uint32_t flags) {
1023 meshlink_set_channel_flags(handle, channel, flags);
1026 /// Set the send buffer storage of a channel.
1027 /** This function provides MeshLink with a send buffer allocated by the application.
1029 * @param channel A handle for the channel.
1030 * @param buf A pointer to the start of the buffer.
1031 * If a NULL pointer is given, MeshLink will use its own internal buffer again.
1032 * @param size The size of the buffer.
1034 void set_channel_sndbuf_storage(channel *channel, void *buf, size_t size) {
1035 meshlink_set_channel_sndbuf_storage(handle, channel, buf, size);
1038 /// Set the receive buffer storage of a channel.
1039 /** This function provides MeshLink with a receive buffer allocated by the application.
1041 * @param channel A handle for the channel.
1042 * @param buf A pointer to the start of the buffer.
1043 * If a NULL pointer is given, MeshLink will use its own internal buffer again.
1044 * @param size The size of the buffer.
1046 void set_channel_rcvbuf_storage(channel *channel, void *buf, size_t size) {
1047 meshlink_set_channel_rcvbuf_storage(handle, channel, buf, size);
1050 /// Set the connection timeout used for channels to the given node.
1051 /** This sets the timeout after which unresponsive channels will be reported as closed.
1052 * The timeout is set for all current and future channels to the given node.
1054 * @param node The node to set the channel timeout for.
1055 * @param timeout The timeout in seconds after which unresponsive channels will be reported as closed.
1056 * The default is 60 seconds.
1058 void set_node_channel_timeout(node *node, int timeout) {
1059 meshlink_set_node_channel_timeout(handle, node, timeout);
1062 /// Open a reliable stream channel to another node.
1063 /** This function is called whenever a remote node wants to open a channel to the local node.
1064 * The application then has to decide whether to accept or reject this channel.
1066 * This function sets the channel poll callback to channel_poll_trampoline, which in turn
1067 * calls channel_poll. To set a different, channel-specific poll callback, use set_channel_poll_cb.
1069 * @param node The node to which this channel is being initiated.
1070 * @param port The port number the peer wishes to connect to.
1071 * @param cb A pointer to the function which will be called when the remote node sends data to the local node.
1072 * @param data A pointer to a buffer containing data to already queue for sending.
1073 * @param len The length of the data.
1074 * If len is 0, the data pointer is copied into the channel's priv member.
1075 * @param flags A bitwise-or'd combination of flags that set the semantics for this channel.
1077 * @return A handle for the channel, or NULL in case of an error.
1079 channel *channel_open(node *node, uint16_t port, channel_receive_cb_t cb, const void *data, size_t len, uint32_t flags = channel::TCP) {
1080 channel *ch = (channel *)meshlink_channel_open_ex(handle, node, port, (meshlink_channel_receive_cb_t)cb, data, len, flags);
1081 meshlink_set_channel_poll_cb(handle, ch, &channel_poll_trampoline);
1085 /// Open a reliable stream channel to another node.
1086 /** This function is called whenever a remote node wants to open a channel to the local node.
1087 * The application then has to decide whether to accept or reject this channel.
1089 * This function sets the channel receive callback to channel_receive_trampoline,
1090 * which in turn calls channel_receive.
1092 * This function sets the channel poll callback to channel_poll_trampoline, which in turn
1093 * calls channel_poll. To set a different, channel-specific poll callback, use set_channel_poll_cb.
1095 * @param node The node to which this channel is being initiated.
1096 * @param port The port number the peer wishes to connect to.
1097 * @param data A pointer to a buffer containing data to already queue for sending.
1098 * @param len The length of the data.
1099 * If len is 0, the data pointer is copied into the channel's priv member.
1100 * @param flags A bitwise-or'd combination of flags that set the semantics for this channel.
1102 * @return A handle for the channel, or NULL in case of an error.
1104 channel *channel_open(node *node, uint16_t port, const void *data, size_t len, uint32_t flags = channel::TCP) {
1105 channel *ch = (channel *)meshlink_channel_open_ex(handle, node, port, &channel_receive_trampoline, data, len, flags);
1106 meshlink_set_channel_poll_cb(handle, ch, &channel_poll_trampoline);
1110 /// Partially close a reliable stream channel.
1111 /** This shuts down the read or write side of a channel, or both, without closing the handle.
1112 * It can be used to inform the remote node that the local node has finished sending all data on the channel,
1113 * but still allows waiting for incoming data from the remote node.
1115 * @param channel A handle for the channel.
1116 * @param direction Must be one of SHUT_RD, SHUT_WR or SHUT_RDWR.
1118 void channel_shutdown(channel *channel, int direction) {
1119 return meshlink_channel_shutdown(handle, channel, direction);
1122 /// Close a reliable stream channel.
1123 /** This informs the remote node that the local node has finished sending all data on the channel.
1124 * It also causes the local node to stop accepting incoming data from the remote node.
1125 * Afterwards, the channel handle is invalid and must not be used any more.
1127 * It is allowed to call this function at any time on a valid handle, even inside callback functions.
1128 * If called with a valid handle, this function always succeeds, otherwise the result is undefined.
1130 * @param channel A handle for the channel.
1132 void channel_close(meshlink_channel_t *channel) {
1133 return meshlink_channel_close(handle, channel);
1136 /// Abort a reliable stream channel.
1137 /** This aborts a channel.
1138 * Data that was in the send and receive buffers is dropped, so potentially there is some data that
1139 * was sent on this channel that will not be received by the peer.
1140 * Afterwards, the channel handle is invalid and must not be used any more.
1142 * It is allowed to call this function at any time on a valid handle, even inside callback functions.
1143 * If called with a valid handle, this function always succeeds, otherwise the result is undefined.
1145 * @param channel A handle for the channel.
1147 void channel_abort(meshlink_channel_t *channel) {
1148 return meshlink_channel_abort(handle, channel);
1151 /// Transmit data on a channel
1152 /** This queues data to send to the remote node.
1154 * @param channel A handle for the channel.
1155 * @param data A pointer to a buffer containing data sent by the source.
1156 * @param len The length of the data.
1158 * @return The amount of data that was queued, which can be less than len, or a negative value in case of an error.
1159 * If MESHLINK_CHANNEL_NO_PARTIAL is set, then the result will either be len,
1160 * 0 if the buffer is currently too full, or -1 if len is too big even for an empty buffer.
1162 ssize_t channel_send(channel *channel, void *data, size_t len) {
1163 return meshlink_channel_send(handle, channel, data, len);
1166 /// Transmit data on a channel asynchronously
1167 /** This registers a buffer that will be used to send data to the remote node.
1168 * Multiple buffers can be registered, in which case data will be sent in the order the buffers were registered.
1169 * While there are still buffers with unsent data, the poll callback will not be called.
1171 * @param channel A handle for the channel.
1172 * @param data A pointer to a buffer containing data sent by the source, or NULL if there is no data to send.
1173 * After meshlink_channel_aio_send() returns, the buffer may not be modified or freed by the application
1174 * until the callback routine is called.
1175 * @param len The length of the data, or 0 if there is no data to send.
1176 * @param cb A pointer to the function which will be called when MeshLink has finished using the buffer.
1177 * @param priv A private pointer which was set by the application when submitting the buffer.
1179 * @return True if the buffer was enqueued, false otherwise.
1181 bool channel_aio_send(channel *channel, const void *data, size_t len, meshlink_aio_cb_t cb, void *priv) {
1182 return meshlink_channel_aio_send(handle, channel, data, len, cb, priv);
1185 /// Transmit data on a channel asynchronously from a filedescriptor
1186 /** This will read up to the specified length number of bytes from the given filedescriptor, and send it over the channel.
1187 * The callback may be returned early if there is an error reading from the filedescriptor.
1188 * While there is still with unsent data, the poll callback will not be called.
1190 * @param channel A handle for the channel.
1191 * @param fd A file descriptor from which data will be read.
1192 * @param len The length of the data, or 0 if there is no data to send.
1193 * @param cb A pointer to the function which will be called when MeshLink has finished using the filedescriptor.
1194 * @param priv A private pointer which was set by the application when submitting the buffer.
1196 * @return True if the buffer was enqueued, false otherwise.
1198 bool channel_aio_fd_send(channel *channel, int fd, size_t len, meshlink_aio_fd_cb_t cb, void *priv) {
1199 return meshlink_channel_aio_fd_send(handle, channel, fd, len, cb, priv);
1202 /// Receive data on a channel asynchronously
1203 /** This registers a buffer that will be filled with incoming channel data.
1204 * Multiple buffers can be registered, in which case data will be received in the order the buffers were registered.
1205 * While there are still buffers that have not been filled, the receive callback will not be called.
1207 * @param channel A handle for the channel.
1208 * @param data A pointer to a buffer that will be filled with incoming data.
1209 * After meshlink_channel_aio_receive() returns, the buffer may not be modified or freed by the application
1210 * until the callback routine is called.
1211 * @param len The length of the data.
1212 * @param cb A pointer to the function which will be called when MeshLink has finished using the buffer.
1213 * @param priv A private pointer which was set by the application when submitting the buffer.
1215 * @return True if the buffer was enqueued, false otherwise.
1217 bool channel_aio_receive(channel *channel, const void *data, size_t len, meshlink_aio_cb_t cb, void *priv) {
1218 return meshlink_channel_aio_receive(handle, channel, data, len, cb, priv);
1221 /// Receive data on a channel asynchronously and send it to a filedescriptor
1222 /** This will read up to the specified length number of bytes from the channel, and send it to the filedescriptor.
1223 * The callback may be returned early if there is an error writing to the filedescriptor.
1224 * While there is still unread data, the receive callback will not be called.
1226 * @param channel A handle for the channel.
1227 * @param fd A file descriptor to which data will be written.
1228 * @param len The length of the data.
1229 * @param cb A pointer to the function which will be called when MeshLink has finished using the filedescriptor.
1230 * @param priv A private pointer which was set by the application when submitting the buffer.
1232 * @return True if the buffer was enqueued, false otherwise.
1234 bool channel_aio_fd_receive(channel *channel, int fd, size_t len, meshlink_aio_fd_cb_t cb, void *priv) {
1235 return meshlink_channel_aio_fd_receive(handle, channel, fd, len, cb, priv);
1238 /// Get the amount of bytes in the send buffer.
1239 /** This returns the amount of bytes in the send buffer.
1240 * These bytes have not been received by the peer yet.
1242 * @param channel A handle for the channel.
1244 * @return The amount of un-ACKed bytes in the send buffer.
1246 size_t channel_get_sendq(channel *channel) {
1247 return meshlink_channel_get_sendq(handle, channel);
1250 /// Get the amount of bytes in the receive buffer.
1251 /** This returns the amount of bytes in the receive buffer.
1252 * These bytes have not been processed by the application yet.
1254 * @param channel A handle for the channel.
1256 * @return The amount of bytes in the receive buffer.
1258 size_t channel_get_recvq(channel *channel) {
1259 return meshlink_channel_get_recvq(handle, channel);
1262 /// Get the maximum segment size of a channel.
1263 /** This returns the amount of bytes that can be sent at once for channels with UDP semantics.
1265 * @param channel A handle for the channel.
1267 * @return The amount of bytes in the receive buffer.
1269 size_t channel_get_mss(channel *channel) {
1270 return meshlink_channel_get_mss(handle, channel);
1273 /// Enable or disable zeroconf discovery of local peers
1274 /** This controls whether zeroconf discovery using the Catta library will be
1275 * enabled to search for peers on the local network. By default, it is enabled.
1277 * @param enable Set to true to enable discovery, false to disable.
1279 void enable_discovery(bool enable = true) {
1280 meshlink_enable_discovery(handle, enable);
1283 /// Inform MeshLink that the local network configuration might have changed
1284 /** This is intended to be used when there is no way for MeshLink to get notifications of local network changes.
1285 * It forces MeshLink to scan all network interfaces for changes in up/down status and new/removed addresses,
1286 * and will immediately check if all connections to other nodes are still alive.
1288 void hint_network_change() {
1289 meshlink_hint_network_change(handle);
1292 /// Performs key rotation for an encrypted storage
1293 /** This rotates the (master) key for an encrypted storage and discards the old key
1294 * if the call succeeded. This is an atomic call.
1296 * \memberof meshlink_handle
1297 * @param key A pointer to the new key used to encrypt storage.
1298 * @param keylen The length of the new key in bytes.
1300 * @return This function returns true if the key rotation for the encrypted storage succeeds, false otherwise.
1302 bool encrypted_key_rotate(const void *key, size_t keylen) {
1303 return meshlink_encrypted_key_rotate(handle, key, keylen);
1306 /// Set device class timeouts
1307 /** This sets the ping interval and timeout for a given device class.
1309 * @param devclass The device class to update
1310 * @param pinginterval The interval between keepalive packets, in seconds. The default is 60.
1311 * @param pingtimeout The required time within which a peer should respond, in seconds. The default is 5.
1312 * The timeout must be smaller than the interval.
1314 void set_dev_class_timeouts(dev_class_t devclass, int pinginterval, int pingtimeout) {
1315 meshlink_set_dev_class_timeouts(handle, devclass, pinginterval, pingtimeout);
1318 /// Set device class fast retry period
1319 /** This sets the fast retry period for a given device class.
1320 * During this period after the last time the mesh becomes unreachable, connections are tried once a second.
1322 * @param devclass The device class to update
1323 * @param fast_retry_period The period during which fast connection retries are done. The default is 0.
1325 void set_dev_class_fast_retry_period(dev_class_t devclass, int fast_retry_period) {
1326 meshlink_set_dev_class_fast_retry_period(handle, devclass, fast_retry_period);
1329 /// Set device class maximum timeout
1330 /** This sets the maximum timeout for outgoing connection retries for a given device class.
1332 * @param devclass The device class to update
1333 * @param maxtimeout The maximum timeout between reconnection attempts, in seconds. The default is 900.
1335 void set_dev_class_maxtimeout(dev_class_t devclass, int maxtimeout) {
1336 meshlink_set_dev_class_maxtimeout(handle, devclass, maxtimeout);
1339 /// Set which order invitations are committed
1340 /** This determines in which order configuration files are written to disk during an invitation.
1341 * By default, the invitee saves the configuration to disk first, then the inviter.
1342 * By calling this function with @a inviter_commits_first set to true, the order is reversed.
1344 * @param inviter_commits_first If true, then the node that invited a peer will commit data to disk first.
1346 void set_inviter_commits_first(bool inviter_commits_first) {
1347 meshlink_set_inviter_commits_first(handle, inviter_commits_first);
1350 /// Set the URL used to discover the host's external address
1351 /** For generating invitation URLs, MeshLink can look up the externally visible address of the local node.
1352 * It does so by querying an external service. By default, this is http://meshlink.io/host.cgi.
1353 * Only URLs starting with http:// are supported.
1355 * @param url The URL to use for external address queries, or NULL to revert back to the default URL.
1357 void set_external_address_discovery_url(const char *url) {
1358 meshlink_set_external_address_discovery_url(handle, url);
1363 mesh(const mesh &) /* TODO: C++11: = delete */;
1364 void operator=(const mesh &) /* TODO: C++11: = delete */;
1366 /// static callback trampolines:
1367 static void receive_trampoline(meshlink_handle_t *handle, meshlink_node_t *source, const void *data, size_t length) {
1368 if(!(handle->priv)) {
1372 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1373 that->receive(static_cast<node *>(source), data, length);
1376 static void node_status_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer, bool reachable) {
1377 if(!(handle->priv)) {
1381 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1382 that->node_status(static_cast<node *>(peer), reachable);
1385 static void node_pmtu_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer, uint16_t pmtu) {
1386 if(!(handle->priv)) {
1390 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1391 that->node_pmtu(static_cast<node *>(peer), pmtu);
1394 static void node_duplicate_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer) {
1395 if(!(handle->priv)) {
1399 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1400 that->node_duplicate(static_cast<node *>(peer));
1403 static void log_trampoline(meshlink_handle_t *handle, log_level_t level, const char *message) {
1404 if(!(handle->priv)) {
1408 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1409 that->log(level, message);
1412 static void error_trampoline(meshlink_handle_t *handle, meshlink_errno_t meshlink_errno) {
1413 if(!(handle->priv)) {
1417 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1418 that->error(meshlink_errno);
1421 static void blacklisted_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer) {
1422 if(!(handle->priv)) {
1426 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1427 that->blacklisted(static_cast<node *>(peer));
1430 static void thread_status_trampoline(meshlink_handle_t *handle, bool status) {
1431 if(!(handle->priv)) {
1435 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1436 that->thread_status(status);
1439 static void connection_try_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer) {
1440 if(!(handle->priv)) {
1444 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1445 that->connection_try(static_cast<node *>(peer));
1448 static bool channel_listen_trampoline(meshlink_handle_t *handle, meshlink_node_t *node, uint16_t port) {
1449 if(!(handle->priv)) {
1453 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1454 return that->channel_listen(static_cast<meshlink::node *>(node), port);
1457 static bool channel_accept_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, uint16_t port, const void *data, size_t len) {
1458 if(!(handle->priv)) {
1462 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1463 bool accepted = that->channel_accept(static_cast<meshlink::channel *>(channel), port, data, len);
1466 meshlink_set_channel_receive_cb(handle, channel, &channel_receive_trampoline);
1467 meshlink_set_channel_poll_cb(handle, channel, &channel_poll_trampoline);
1473 static void channel_receive_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, const void *data, size_t len) {
1474 if(!(handle->priv)) {
1478 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1479 that->channel_receive(static_cast<meshlink::channel *>(channel), data, len);
1482 static void channel_poll_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, size_t len) {
1483 if(!(handle->priv)) {
1487 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1488 that->channel_poll(static_cast<meshlink::channel *>(channel), len);
1491 meshlink_handle_t *handle;
1494 static inline const char *strerror(errno_t err = meshlink_errno) {
1495 return meshlink_strerror(err);
1498 /// Destroy a MeshLink instance.
1499 /** This function remove all configuration files of a MeshLink instance. It should only be called when the application
1500 * does not have an open handle to this instance. Afterwards, a call to meshlink_open() will create a completely
1503 * @param confbase The directory in which MeshLink stores its configuration files.
1504 * After the function returns, the application is free to overwrite or free @a confbase @a.
1506 * @return This function will return true if the MeshLink instance was successfully destroyed, false otherwise.
1508 static inline bool destroy(const char *confbase) {
1509 return meshlink_destroy(confbase);
1513 static inline void set_log_cb(meshlink_log_level_t level, meshlink_log_cb_t cb) {
1514 meshlink_set_log_cb(NULL, level, cb);