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 accepting incoming channels.
83 /** @param mesh A handle which represents an instance of MeshLink.
84 * @param channel A handle for the incoming channel.
85 * @param port The port number the peer wishes to connect to.
86 * @param data A pointer to a buffer containing data already received. (Not yet used.)
87 * @param len The length of the data. (Not yet used.)
89 * @return This function should return true if the application accepts the incoming channel, false otherwise.
90 * If returning false, the channel is invalid and may not be used anymore.
92 typedef bool (*channel_accept_cb_t)(mesh *mesh, channel *channel, uint16_t port, const void *data, size_t len);
94 /// A callback for receiving data from a channel.
95 /** @param mesh A handle which represents an instance of MeshLink.
96 * @param channel A handle for the channel.
97 * @param data A pointer to a buffer containing data sent by the source.
98 * @param len The length of the data.
100 typedef void (*channel_receive_cb_t)(mesh *mesh, channel *channel, const void *data, size_t len);
102 /// A callback that is called when data can be send on a channel.
103 /** @param mesh A handle which represents an instance of MeshLink.
104 * @param channel A handle for the channel.
105 * @param len The maximum length of data that is guaranteed to be accepted by a call to channel_send().
107 typedef void (*channel_poll_cb_t)(mesh *mesh, channel *channel, size_t len);
109 /// A callback for cleaning up buffers submitted for asynchronous I/O.
110 /** This callbacks signals that MeshLink has finished using this buffer.
111 * The ownership of the buffer is now back into the application's hands.
113 * @param mesh A handle which represents an instance of MeshLink.
114 * @param channel A handle for the channel which used this buffer.
115 * @param data A pointer to a buffer containing the enqueued data.
116 * @param len The length of the buffer.
117 * @param priv A private pointer which was set by the application when submitting the buffer.
119 typedef void (*aio_cb_t)(mesh *mesh, channel *channel, const void *data, size_t len, void *priv);
121 /// A callback for asynchronous I/O to and from filedescriptors.
122 /** This callbacks signals that MeshLink has finished using this filedescriptor.
124 * @param mesh A handle which represents an instance of MeshLink.
125 * @param channel A handle for the channel which used this filedescriptor.
126 * @param fd The filedescriptor that was used.
127 * @param len The length of the data that was successfully sent or received.
128 * @param priv A private pointer which was set by the application when submitting the buffer.
130 typedef void (*aio_fd_cb_t)(mesh *mesh, channel *channel, int fd, size_t len, void *priv);
132 /// A class describing a MeshLink node.
133 class node: public meshlink_node_t {
136 /// A class describing a MeshLink Sub-Mesh.
137 class submesh: public meshlink_submesh_t {
140 /// A class describing a MeshLink channel.
141 class channel: public meshlink_channel_t {
143 static const uint32_t RELIABLE = MESHLINK_CHANNEL_RELIABLE;
144 static const uint32_t ORDERED = MESHLINK_CHANNEL_ORDERED;
145 static const uint32_t FRAMED = MESHLINK_CHANNEL_FRAMED;
146 static const uint32_t DROP_LATE = MESHLINK_CHANNEL_DROP_LATE;
147 static const uint32_t NO_PARTIAL = MESHLINK_CHANNEL_NO_PARTIAL;
148 static const uint32_t TCP = MESHLINK_CHANNEL_TCP;
149 static const uint32_t UDP = MESHLINK_CHANNEL_UDP;
152 /// A class describing a MeshLink mesh.
155 mesh() : handle(0) {}
161 bool isOpen() const {
162 return (handle != 0);
165 // TODO: please enable C++11 in autoconf to enable "move constructors":
166 // mesh(mesh&& other)
167 // : handle(other.handle)
170 // handle->priv = this;
174 /// Initialize MeshLink's configuration directory.
175 /** This function causes MeshLink to initialize its configuration directory,
176 * if it hasn't already been initialized.
177 * It only has to be run the first time the application starts,
178 * but it is not a problem if it is run more than once, as long as
179 * the arguments given are the same.
181 * This function does not start any network I/O yet. The application should
182 * first set callbacks, and then call meshlink_start().
184 * @param confbase The directory in which MeshLink will store its configuration files.
185 * @param name The name which this instance of the application will use in the mesh.
186 * @param appname The application name which will be used in the mesh.
187 * @param devclass The device class which will be used in the mesh.
189 * @return This function will return a pointer to a meshlink::mesh if MeshLink has successfully set up its configuration files, NULL otherwise.
191 bool open(const char *confbase, const char *name, const char *appname, dev_class_t devclass) {
192 handle = meshlink_open(confbase, name, appname, devclass);
201 mesh(const char *confbase, const char *name, const char *appname, dev_class_t devclass) {
202 open(confbase, name, appname, devclass);
205 /// Close the MeshLink handle.
206 /** This function calls meshlink_stop() if necessary,
207 * and frees all memory allocated by MeshLink.
208 * Afterwards, the handle and any pointers to a struct meshlink_node are invalid.
213 meshlink_close(handle);
219 /** instead of registerin callbacks you derive your own class and overwrite the following abstract member functions.
220 * These functions are run in MeshLink's own thread.
221 * It is therefore important that these functions use apprioriate methods (queues, pipes, locking, etc.)
222 * to hand the data over to the application's thread.
223 * These functions should also not block itself and return as quickly as possible.
224 * The default member functions are no-ops, so you are not required to overwrite all these member functions
227 /// This function is called whenever another node sends data to the local node.
228 virtual void receive(node *source, const void *data, size_t length) {
235 /// This functions is called whenever another node's status changed.
236 virtual void node_status(node *peer, bool reachable) {
242 /// This functions is called whenever another node's path MTU changes.
243 virtual void node_pmtu(node *peer, uint16_t pmtu) {
249 /// This functions is called whenever a duplicate node is detected.
250 virtual void node_duplicate(node *peer) {
255 /// This functions is called whenever MeshLink has some information to log.
256 virtual void log(log_level_t level, const char *message) {
262 /// This functions is called whenever MeshLink has encountered a serious error.
263 virtual void error(meshlink_errno_t meshlink_errno) {
265 (void)meshlink_errno;
268 /// This functions is called whenever MeshLink a meta-connection attempt is made.
269 virtual void connection_try(node *peer) {
274 /// This functions is called whenever another node attempts to open a channel to the local node.
276 * If the channel is accepted, the poll_callback will be set to channel_poll and can be
277 * changed using set_channel_poll_cb(). Likewise, the receive callback is set to
280 * The function is run in MeshLink's own thread.
281 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
282 * to pass data to or from the application's thread.
283 * The callback should also not block itself and return as quickly as possible.
285 * @param channel A handle for the incoming channel.
286 * @param port The port number the peer wishes to connect to.
287 * @param data A pointer to a buffer containing data already received. (Not yet used.)
288 * @param len The length of the data. (Not yet used.)
290 * @return This function should return true if the application accepts the incoming channel, false otherwise.
291 * If returning false, the channel is invalid and may not be used anymore.
293 virtual bool channel_accept(channel *channel, uint16_t port, const void *data, size_t len) {
294 /* by default reject all channels */
302 /// This function is called by Meshlink for receiving data from a channel.
304 * The function is run in MeshLink's own thread.
305 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
306 * to pass data to or from the application's thread.
307 * The callback should also not block itself and return as quickly as possible.
309 * @param channel A handle for the channel.
310 * @param data A pointer to a buffer containing data sent by the source.
311 * @param len The length of the data.
313 virtual void channel_receive(channel *channel, const void *data, size_t len) {
320 /// This function is called by Meshlink when data can be send on a channel.
322 * The function is run in MeshLink's own thread.
323 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
324 * to pass data to or from the application's thread.
326 * The callback should also not block itself and return as quickly as possible.
327 * @param channel A handle for the channel.
328 * @param len The maximum length of data that is guaranteed to be accepted by a call to channel_send().
330 virtual void channel_poll(channel *channel, size_t len) {
337 /** This function causes MeshLink to open network sockets, make outgoing connections, and
338 * create a new thread, which will handle all network I/O.
340 * @return This function will return true if MeshLink has successfully started its thread, false otherwise.
343 meshlink_set_receive_cb(handle, &receive_trampoline);
344 meshlink_set_node_status_cb(handle, &node_status_trampoline);
345 meshlink_set_node_pmtu_cb(handle, &node_pmtu_trampoline);
346 meshlink_set_node_duplicate_cb(handle, &node_duplicate_trampoline);
347 meshlink_set_log_cb(handle, MESHLINK_DEBUG, &log_trampoline);
348 meshlink_set_error_cb(handle, &error_trampoline);
349 meshlink_set_channel_accept_cb(handle, &channel_accept_trampoline);
350 meshlink_set_connection_try_cb(handle, &connection_try_trampoline);
351 return meshlink_start(handle);
355 /** This function causes MeshLink to disconnect from all other nodes,
356 * close all sockets, and shut down its own thread.
359 meshlink_stop(handle);
362 /// Send data to another node.
363 /** This functions sends one packet of data to another node in the mesh.
364 * The packet is sent using UDP semantics, which means that
365 * the packet is sent as one unit and is received as one unit,
366 * and that there is no guarantee that the packet will arrive at the destination.
367 * The application should take care of getting an acknowledgement and retransmission if necessary.
369 * @param destination A pointer to a meshlink::node describing the destination for the data.
370 * @param data A pointer to a buffer containing the data to be sent to the source.
371 * @param len The length of the data.
372 * @return This function will return true if MeshLink has queued the message for transmission, and false otherwise.
373 * A return value of true does not guarantee that the message will actually arrive at the destination.
375 bool send(node *destination, const void *data, unsigned int len) {
376 return meshlink_send(handle, destination, data, len);
379 /// Get a handle for a specific node.
380 /** This function returns a handle for the node with the given name.
382 * @param name The name of the node for which a handle is requested.
384 * @return A pointer to a meshlink::node which represents the requested node,
385 * or NULL if the requested node does not exist.
387 node *get_node(const char *name) {
388 return (node *)meshlink_get_node(handle, name);
391 /// Get a node's reachability status.
392 /** This function returns the current reachability of a given node, and the times of the last state changes.
393 * If a given state change never happened, the time returned will be 0.
395 * @param node A pointer to a meshlink::node describing the node.
396 * @param last_reachable A pointer to a time_t variable that will be filled in with the last time the node became reachable.
397 * @param last_unreachable A pointer to a time_t variable that will be filled in with the last time the node became unreachable.
399 * @return This function returns true if the node is currently reachable, false otherwise.
401 bool get_node_reachability(node *node, time_t *last_reachable = NULL, time_t *last_unreachable = NULL) {
402 return meshlink_get_node_reachability(handle, node, last_reachable, last_unreachable);
405 /// Get a handle for a specific submesh.
406 /** This function returns a handle for the submesh with the given name.
408 * @param name The name of the submesh for which a handle is requested.
410 * @return A pointer to a meshlink::submesh which represents the requested submesh,
411 * or NULL if the requested submesh does not exist.
413 submesh *get_submesh(const char *name) {
414 return (submesh *)meshlink_get_submesh(handle, name);
417 /// Get a handle for our own node.
418 /** This function returns a handle for the local node.
420 * @return A pointer to a meshlink::node which represents the local node.
423 return (node *)meshlink_get_self(handle);
426 /// Get a list of all nodes.
427 /** This function returns a list with handles for all known nodes.
429 * @param nodes A pointer to an array of pointers to meshlink::node, which should be allocated by the application.
430 * @param nmemb The maximum number of pointers that can be stored in the nodes array.
432 * @return The number of known nodes, or -1 in case of an error.
433 * This can be larger than nmemb, in which case not all nodes were stored in the nodes array.
435 node **get_all_nodes(node **nodes, size_t *nmemb) {
436 return (node **)meshlink_get_all_nodes(handle, (meshlink_node_t **)nodes, nmemb);
439 /// Sign data using the local node's MeshLink key.
440 /** This function signs data using the local node's MeshLink key.
441 * The generated signature can be securely verified by other nodes.
443 * @param data A pointer to a buffer containing the data to be signed.
444 * @param len The length of the data to be signed.
445 * @param signature A pointer to a buffer where the signature will be stored.
446 * @param siglen The size of the signature buffer. Will be changed after the call to match the size of the signature itself.
448 * @return This function returns true if the signature is valid, false otherwise.
450 bool sign(const void *data, size_t len, void *signature, size_t *siglen) {
451 return meshlink_sign(handle, data, len, signature, siglen);
454 /// Verify the signature generated by another node of a piece of data.
455 /** This function verifies the signature that another node generated for a piece of data.
457 * @param source A pointer to a meshlink_node_t describing the source of the signature.
458 * @param data A pointer to a buffer containing the data to be verified.
459 * @param len The length of the data to be verified.
460 * @param signature A pointer to a string containing the signature.
461 * @param siglen The size of the signature.
463 * @return This function returns true if the signature is valid, false otherwise.
465 bool verify(node *source, const void *data, size_t len, const void *signature, size_t siglen) {
466 return meshlink_verify(handle, source, data, len, signature, siglen);
469 /// Set the canonical Address for a node.
470 /** This function sets the canonical Address for a node.
471 * This address is stored permanently until it is changed by another call to this function,
472 * unlike other addresses associated with a node,
473 * such as those added with meshlink_hint_address() or addresses discovered at runtime.
475 * If a canonical Address is set for the local node,
476 * it will be used for the hostname part of generated invitation URLs.
478 * @param node A pointer to a meshlink_node_t describing the node.
479 * @param address A nul-terminated C string containing the address, which can be either in numeric format or a hostname.
480 * @param port A nul-terminated C string containing the port, which can be either in numeric or symbolic format.
481 * If it is NULL, the listening port's number will be used.
483 * @return This function returns true if the address was added, false otherwise.
485 bool set_canonical_address(node *node, const char *address, const char *port = NULL) {
486 return meshlink_set_canonical_address(handle, node, address, port);
489 /// Set the canonical Address for the local node.
490 /** This function sets the canonical Address for the local node.
491 * This address is stored permanently until it is changed by another call to this function,
492 * unlike other addresses associated with a node,
493 * such as those added with meshlink_hint_address() or addresses discovered at runtime.
495 * @param address A nul-terminated C string containing the address, which can be either in numeric format or a hostname.
496 * @param port A nul-terminated C string containing the port, which can be either in numeric or symbolic format.
497 * If it is NULL, the listening port's number will be used.
499 * @return This function returns true if the address was added, false otherwise.
501 bool set_canonical_address(const char *address, const char *port = NULL) {
502 return meshlink_set_canonical_address(handle, get_self(), address, port);
505 /// Add an Address for the local node.
506 /** This function adds an Address for the local node, which will be used for invitation URLs.
508 * @param address A string containing the address, which can be either in numeric format or a hostname.
510 * @return This function returns true if the address was added, false otherwise.
512 bool add_address(const char *address) {
513 return meshlink_add_address(handle, address);
516 /** This function performs tries to discover the local node's external address
517 * by contacting the meshlink.io server. If a reverse lookup of the address works,
518 * the FQDN associated with the address will be returned.
520 * Please note that this is function only returns a single address,
521 * even if the local node might have more than one external address.
522 * In that case, there is no control over which address will be selected.
523 * Also note that if you have a dynamic IP address, or are behind carrier-grade NAT,
524 * there is no guarantee that the external address will be valid for an extended period of time.
526 * This function is blocking. It can take several seconds before it returns.
527 * There is no guarantee it will be able to resolve the external address.
528 * Failures might be because by temporary network outages.
530 * @param family The address family to check, for example AF_INET or AF_INET6. If AF_UNSPEC is given,
531 * this might return the external address for any working address family.
533 * @return This function returns a pointer to a C string containing the discovered external address,
534 * or NULL if there was an error looking up the address.
535 * After get_external_address() returns, the application is free to overwrite or free this string.
537 bool get_external_address(int family = AF_UNSPEC) {
538 return meshlink_get_external_address_for_family(handle, family);
541 /** This function performs tries to discover the address of the local interface used for outgoing connection.
543 * Please note that this is function only returns a single address,
544 * even if the local node might have more than one external address.
545 * In that case, there is no control over which address will be selected.
546 * Also note that if you have a dynamic IP address, or are behind carrier-grade NAT,
547 * there is no guarantee that the external address will be valid for an extended period of time.
549 * This function will fail if it couldn't find a local address for the given address family.
550 * If hostname resolving is requested, this function may block for a few seconds.
552 * @param family The address family to check, for example AF_INET or AF_INET6. If AF_UNSPEC is given,
553 * this might return the external address for any working address family.
555 * @return This function returns a pointer to a C string containing the discovered external address,
556 * or NULL if there was an error looking up the address.
557 * After get_external_address() returns, the application is free to overwrite or free this string.
559 bool get_local_address(int family = AF_UNSPEC) {
560 return meshlink_get_local_address_for_family(handle, family);
563 /// Try to discover the external address for the local node, and add it to its list of addresses.
564 /** This function is equivalent to:
566 * mesh->add_address(mesh->get_external_address());
568 * Read the description of get_external_address() for the limitations of this function.
570 * @return This function returns true if the address was added, false otherwise.
572 bool add_external_address() {
573 return meshlink_add_external_address(handle);
576 /// Get the network port used by the local node.
577 /** This function returns the network port that the local node is listening on.
579 * @return This function returns the port number, or -1 in case of an error.
582 return meshlink_get_port(handle);
585 /// Set the network port used by the local node.
586 /** This function sets the network port that the local node is listening on.
587 * It may only be called when the mesh is not running.
588 * If unsure, call stop() before calling this function.
589 * Also note that if your node is already part of a mesh with other nodes,
590 * that the other nodes may no longer be able to initiate connections to the local node,
591 * since they will try to connect to the previously configured port.
593 * @param port The port number to listen on. This must be between 0 and 65535.
594 * If the port is set to 0, then MeshLink will listen on a port
595 * that is randomly assigned by the operating system every time open() is called.
597 * @return This function returns true if the port was successfully changed
598 * to the desired port, false otherwise. If it returns false, there
599 * is no guarantee that MeshLink is listening on the old port.
601 bool set_port(int port) {
602 return meshlink_set_port(handle, port);
605 /// Set the timeout for invitations.
606 /** This function sets the timeout for invitations.
607 * The timeout is retroactively applied to all outstanding invitations.
609 * @param timeout The timeout for invitations in seconds.
611 void set_invitation_timeout(int timeout) {
612 meshlink_set_invitation_timeout(handle, timeout);
615 /// Invite another node into the mesh.
616 /** This function generates an invitation that can be used by another node to join the same mesh as the local node.
617 * The generated invitation is a string containing a URL.
618 * This URL should be passed by the application to the invitee in a way that no eavesdroppers can see the URL.
619 * The URL can only be used once, after the user has joined the mesh the URL is no longer valid.
621 * @param submesh A handle to the submesh to put the invitee in.
622 * @param name The name that the invitee will use in the mesh.
623 * @param flags A bitwise-or'd combination of flags that controls how the URL is generated.
625 * @return This function returns a string that contains the invitation URL.
626 * The application should call free() after it has finished using the URL.
628 char *invite(submesh *submesh, const char *name, uint32_t flags = 0) {
629 return meshlink_invite_ex(handle, submesh, name, flags);
632 /// Use an invitation to join a mesh.
633 /** This function allows the local node to join an existing mesh using an invitation URL generated by another node.
634 * An invitation can only be used if the local node has never connected to other nodes before.
635 * After a successfully accepted invitation, the name of the local node may have changed.
637 * 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.
639 * This function is blocking. It can take several seconds before it returns.
640 * There is no guarantee it will perform a successful join.
641 * Failures might be caused by temporary network outages, or by the invitation having expired.
643 * @param invitation A string containing the invitation URL.
645 * @return This function returns true if the local node joined the mesh it was invited to, false otherwise.
647 bool join(const char *invitation) {
648 return meshlink_join(handle, invitation);
651 /// Export the local node's key and addresses.
652 /** This function generates a string that contains the local node's public key and one or more IP addresses.
653 * The application can pass it in some way to another node, which can then import it,
654 * granting the local node access to the other node's mesh.
656 * @return This function returns a string that contains the exported key and addresses.
657 * The application should call free() after it has finished using this string.
660 return meshlink_export(handle);
663 /// Import another node's key and addresses.
664 /** This function accepts a string containing the exported public key and addresses of another node.
665 * By importing this data, the local node grants the other node access to its mesh.
667 * @param data A string containing the other node's exported key and addresses.
669 * @return This function returns true if the data was valid and the other node has been granted access to the mesh, false otherwise.
671 bool import_key(const char *data) {
672 return meshlink_import(handle, data);
675 /// Forget any information about a node.
676 /** This function allows the local node to forget any information it has about a node,
677 * and if possible will remove any data it has stored on disk about the node.
679 * Any open channels to this node must be closed before calling this function.
681 * After this call returns, the node handle is invalid and may no longer be used, regardless
682 * of the return value of this call.
684 * Note that this function does not prevent MeshLink from actually forgetting about a node,
685 * or re-learning information about a node at a later point in time. It is merely a hint that
686 * the application does not care about this node anymore and that any resources kept could be
689 * \memberof meshlink_node
690 * @param node A pointer to a struct meshlink_node describing the node to be forgotten.
692 * @return This function returns true if all currently known data about the node has been forgotten, false otherwise.
694 bool forget_node(node *node) {
695 return meshlink_forget_node(handle, node);
698 /// Blacklist a node from the mesh.
699 /** This function causes the local node to blacklist another node.
700 * The local node will drop any existing connections to that node,
701 * and will not send data to it nor accept any data received from it any more.
703 * @param node A pointer to a meshlink::node describing the node to be blacklisted.
705 * @return This function returns true if the node has been whitelisted, false otherwise.
707 bool blacklist(node *node) {
708 return meshlink_blacklist(handle, node);
711 /// Blacklist a node from the mesh by name.
712 /** This function causes the local node to blacklist another node by name.
713 * The local node will drop any existing connections to that node,
714 * and will not send data to it nor accept any data received from it any more.
716 * If no node by the given name is known, it is created.
718 * @param name The name of the node to blacklist.
720 * @return This function returns true if the node has been blacklisted, false otherwise.
722 bool blacklist_by_name(const char *name) {
723 return meshlink_blacklist_by_name(handle, name);
726 /// Whitelist a node on the mesh.
727 /** This function causes the local node to whitelist another node.
728 * The local node will allow connections to and from that node,
729 * and will send data to it and accept any data received from it.
731 * @param node A pointer to a meshlink::node describing the node to be whitelisted.
733 * @return This function returns true if the node has been whitelisted, false otherwise.
735 bool whitelist(node *node) {
736 return meshlink_whitelist(handle, node);
739 /// Whitelist a node on the mesh by name.
740 /** This function causes the local node to whitelist a node by name.
741 * The local node will allow connections to and from that node,
742 * and will send data to it and accept any data received from it.
744 * If no node by the given name is known, it is created.
745 * This is useful if new nodes are blacklisted by default.
747 * \memberof meshlink_node
748 * @param node A pointer to a struct meshlink_node describing the node to be whitelisted.
750 * @return This function returns true if the node has been whitelisted, false otherwise.
752 bool whitelist_by_name(const char *name) {
753 return meshlink_whitelist_by_name(handle, name);
756 /// Set the poll callback.
757 /** This functions sets the callback that is called whenever data can be sent to another node.
758 * The callback is run in MeshLink's own thread.
759 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
760 * to pass data to or from the application's thread.
761 * The callback should also not block itself and return as quickly as possible.
763 * @param channel A handle for the channel.
764 * @param cb A pointer to the function which will be called when data can be sent to another node.
765 * If a NULL pointer is given, the callback will be disabled.
767 void set_channel_poll_cb(channel *channel, channel_poll_cb_t cb) {
768 meshlink_set_channel_poll_cb(handle, channel, (meshlink_channel_poll_cb_t)cb);
771 /// Set the send buffer size of a channel.
772 /** This function sets the desired size of the send buffer.
773 * The default size is 128 kB.
775 * @param channel A handle for the channel.
776 * @param size The desired size for the send buffer.
777 * If a NULL pointer is given, the callback will be disabled.
779 void set_channel_sndbuf(channel *channel, size_t size) {
780 meshlink_set_channel_sndbuf(handle, channel, size);
783 /// Set the receive buffer size of a channel.
784 /** This function sets the desired size of the receive buffer.
785 * The default size is 128 kB.
787 * @param channel A handle for the channel.
788 * @param size The desired size for the send buffer.
789 * If a NULL pointer is given, the callback will be disabled.
791 void set_channel_rcvbuf(channel *channel, size_t size) {
792 meshlink_set_channel_rcvbuf(handle, channel, size);
795 /// Set the connection timeout used for channels to the given node.
796 /** This sets the timeout after which unresponsive channels will be reported as closed.
797 * The timeout is set for all current and future channels to the given node.
799 * @param channel A handle for the channel.
800 * @param timeout The timeout in seconds after which unresponsive channels will be reported as closed.
801 * The default is 60 seconds.
803 void set_node_channel_timeout(node *node, int timeout) {
804 meshlink_set_node_channel_timeout(handle, node, timeout);
807 /// Open a reliable stream channel to another node.
808 /** This function is called whenever a remote node wants to open a channel to the local node.
809 * The application then has to decide whether to accept or reject this channel.
811 * This function sets the channel poll callback to channel_poll_trampoline, which in turn
812 * calls channel_poll. To set a different, channel-specific poll callback, use set_channel_poll_cb.
814 * @param node The node to which this channel is being initiated.
815 * @param port The port number the peer wishes to connect to.
816 * @param cb A pointer to the function which will be called when the remote node sends data to the local node.
817 * @param data A pointer to a buffer containing data to already queue for sending.
818 * @param len The length of the data.
819 * If len is 0, the data pointer is copied into the channel's priv member.
820 * @param flags A bitwise-or'd combination of flags that set the semantics for this channel.
822 * @return A handle for the channel, or NULL in case of an error.
824 channel *channel_open(node *node, uint16_t port, channel_receive_cb_t cb, const void *data, size_t len, uint32_t flags = channel::TCP) {
825 channel *ch = (channel *)meshlink_channel_open_ex(handle, node, port, (meshlink_channel_receive_cb_t)cb, data, len, flags);
826 meshlink_set_channel_poll_cb(handle, ch, &channel_poll_trampoline);
830 /// Open a reliable stream channel to another node.
831 /** This function is called whenever a remote node wants to open a channel to the local node.
832 * The application then has to decide whether to accept or reject this channel.
834 * This function sets the channel receive callback to channel_receive_trampoline,
835 * which in turn calls channel_receive.
837 * This function sets the channel poll callback to channel_poll_trampoline, which in turn
838 * calls channel_poll. To set a different, channel-specific poll callback, use set_channel_poll_cb.
840 * @param node The node to which this channel is being initiated.
841 * @param port The port number the peer wishes to connect to.
842 * @param data A pointer to a buffer containing data to already queue for sending.
843 * @param len The length of the data.
844 * If len is 0, the data pointer is copied into the channel's priv member.
845 * @param flags A bitwise-or'd combination of flags that set the semantics for this channel.
847 * @return A handle for the channel, or NULL in case of an error.
849 channel *channel_open(node *node, uint16_t port, const void *data, size_t len, uint32_t flags = channel::TCP) {
850 channel *ch = (channel *)meshlink_channel_open_ex(handle, node, port, &channel_receive_trampoline, data, len, flags);
851 meshlink_set_channel_poll_cb(handle, ch, &channel_poll_trampoline);
855 /// Partially close a reliable stream channel.
856 /** This shuts down the read or write side of a channel, or both, without closing the handle.
857 * It can be used to inform the remote node that the local node has finished sending all data on the channel,
858 * but still allows waiting for incoming data from the remote node.
860 * @param channel A handle for the channel.
861 * @param direction Must be one of SHUT_RD, SHUT_WR or SHUT_RDWR.
863 void channel_shutdown(channel *channel, int direction) {
864 return meshlink_channel_shutdown(handle, channel, direction);
867 /// Close a reliable stream channel.
868 /** This informs the remote node that the local node has finished sending all data on the channel.
869 * It also causes the local node to stop accepting incoming data from the remote node.
870 * Afterwards, the channel handle is invalid and must not be used any more.
872 * @param channel A handle for the channel.
874 void channel_close(meshlink_channel_t *channel) {
875 return meshlink_channel_close(handle, channel);
878 /// Transmit data on a channel
879 /** This queues data to send to the remote node.
881 * @param channel A handle for the channel.
882 * @param data A pointer to a buffer containing data sent by the source.
883 * @param len The length of the data.
885 * @return The amount of data that was queued, which can be less than len, or a negative value in case of an error.
886 * If MESHLINK_CHANNEL_NO_PARTIAL is set, then the result will either be len,
887 * 0 if the buffer is currently too full, or -1 if len is too big even for an empty buffer.
889 ssize_t channel_send(channel *channel, void *data, size_t len) {
890 return meshlink_channel_send(handle, channel, data, len);
893 /// Transmit data on a channel asynchronously
894 /** This registers a buffer that will be used to send data to the remote node.
895 * Multiple buffers can be registered, in which case data will be sent in the order the buffers were registered.
896 * While there are still buffers with unsent data, the poll callback will not be called.
898 * @param channel A handle for the channel.
899 * @param data A pointer to a buffer containing data sent by the source, or NULL if there is no data to send.
900 * After meshlink_channel_aio_send() returns, the buffer may not be modified or freed by the application
901 * until the callback routine is called.
902 * @param len The length of the data, or 0 if there is no data to send.
903 * @param cb A pointer to the function which will be called when MeshLink has finished using the buffer.
904 * @param priv A private pointer which was set by the application when submitting the buffer.
906 * @return True if the buffer was enqueued, false otherwise.
908 bool channel_aio_send(channel *channel, const void *data, size_t len, meshlink_aio_cb_t cb, void *priv) {
909 return meshlink_channel_aio_send(handle, channel, data, len, cb, priv);
912 /// Transmit data on a channel asynchronously from a filedescriptor
913 /** This will read up to the specified length number of bytes from the given filedescriptor, and send it over the channel.
914 * The callback may be returned early if there is an error reading from the filedescriptor.
915 * While there is still with unsent data, the poll callback will not be called.
917 * @param channel A handle for the channel.
918 * @param fd A file descriptor from which data will be read.
919 * @param len The length of the data, or 0 if there is no data to send.
920 * @param cb A pointer to the function which will be called when MeshLink has finished using the filedescriptor.
921 * @param priv A private pointer which was set by the application when submitting the buffer.
923 * @return True if the buffer was enqueued, false otherwise.
925 bool channel_aio_fd_send(channel *channel, int fd, size_t len, meshlink_aio_fd_cb_t cb, void *priv) {
926 return meshlink_channel_aio_fd_send(handle, channel, fd, len, cb, priv);
929 /// Receive data on a channel asynchronously
930 /** This registers a buffer that will be filled with incoming channel data.
931 * Multiple buffers can be registered, in which case data will be received in the order the buffers were registered.
932 * While there are still buffers that have not been filled, the receive callback will not be called.
934 * @param channel A handle for the channel.
935 * @param data A pointer to a buffer that will be filled with incoming data.
936 * After meshlink_channel_aio_receive() returns, the buffer may not be modified or freed by the application
937 * until the callback routine is called.
938 * @param len The length of the data.
939 * @param cb A pointer to the function which will be called when MeshLink has finished using the buffer.
940 * @param priv A private pointer which was set by the application when submitting the buffer.
942 * @return True if the buffer was enqueued, false otherwise.
944 bool channel_aio_receive(channel *channel, const void *data, size_t len, meshlink_aio_cb_t cb, void *priv) {
945 return meshlink_channel_aio_receive(handle, channel, data, len, cb, priv);
948 /// Receive data on a channel asynchronously and send it to a filedescriptor
949 /** This will read up to the specified length number of bytes from the channel, and send it to the filedescriptor.
950 * The callback may be returned early if there is an error writing to the filedescriptor.
951 * While there is still unread data, the receive callback will not be called.
953 * @param channel A handle for the channel.
954 * @param fd A file descriptor to which data will be written.
955 * @param len The length of the data.
956 * @param cb A pointer to the function which will be called when MeshLink has finished using the filedescriptor.
957 * @param priv A private pointer which was set by the application when submitting the buffer.
959 * @return True if the buffer was enqueued, false otherwise.
961 bool channel_aio_fd_receive(channel *channel, int fd, size_t len, meshlink_aio_fd_cb_t cb, void *priv) {
962 return meshlink_channel_aio_fd_receive(handle, channel, fd, len, cb, priv);
965 /// Get the amount of bytes in the send buffer.
966 /** This returns the amount of bytes in the send buffer.
967 * These bytes have not been received by the peer yet.
969 * @param channel A handle for the channel.
971 * @return The amount of un-ACKed bytes in the send buffer.
973 size_t channel_get_sendq(channel *channel) {
974 return meshlink_channel_get_sendq(handle, channel);
977 /// Get the amount of bytes in the receive buffer.
978 /** This returns the amount of bytes in the receive buffer.
979 * These bytes have not been processed by the application yet.
981 * @param channel A handle for the channel.
983 * @return The amount of bytes in the receive buffer.
985 size_t channel_get_recvq(channel *channel) {
986 return meshlink_channel_get_recvq(handle, channel);
989 /// Enable or disable zeroconf discovery of local peers
990 /** This controls whether zeroconf discovery using the Catta library will be
991 * enabled to search for peers on the local network. By default, it is enabled.
993 * @param enable Set to true to enable discovery, false to disable.
995 void enable_discovery(bool enable = true) {
996 meshlink_enable_discovery(handle, enable);
999 /// Set device class timeouts
1000 /** This sets the ping interval and timeout for a given device class.
1002 * @param devclass The device class to update
1003 * @param pinginterval The interval between keepalive packets, in seconds. The default is 60.
1004 * @param pingtimeout The required time within which a peer should respond, in seconds. The default is 5.
1005 * The timeout must be smaller than the interval.
1007 void set_dev_class_timeouts(dev_class_t devclass, int pinginterval, int pingtimeout) {
1008 meshlink_set_dev_class_timeouts(handle, devclass, pinginterval, pingtimeout);
1011 /// Set device class fast retry period
1012 /** This sets the fast retry period for a given device class.
1013 * During this period after the last time the mesh becomes unreachable, connections are tried once a second.
1015 * @param devclass The device class to update
1016 * @param fast_retry_period The period during which fast connection retries are done. The default is 0.
1018 void set_dev_class_fast_retry_period(dev_class_t devclass, int fast_retry_period) {
1019 meshlink_set_dev_class_fast_retry_period(handle, devclass, fast_retry_period);
1022 /// Set which order invitations are committed
1023 /** This determines in which order configuration files are written to disk during an invitation.
1024 * By default, the invitee saves the configuration to disk first, then the inviter.
1025 * By calling this function with @a inviter_commits_first set to true, the order is reversed.
1027 * @param inviter_commits_first If true, then the node that invited a peer will commit data to disk first.
1029 void set_inviter_commits_first(bool inviter_commits_first) {
1030 meshlink_set_inviter_commits_first(handle, inviter_commits_first);
1035 mesh(const mesh &) /* TODO: C++11: = delete */;
1036 void operator=(const mesh &) /* TODO: C++11: = delete */;
1038 /// static callback trampolines:
1039 static void receive_trampoline(meshlink_handle_t *handle, meshlink_node_t *source, const void *data, size_t length) {
1040 if(!(handle->priv)) {
1044 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1045 that->receive(static_cast<node *>(source), data, length);
1048 static void node_status_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer, bool reachable) {
1049 if(!(handle->priv)) {
1053 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1054 that->node_status(static_cast<node *>(peer), reachable);
1057 static void node_pmtu_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer, uint16_t pmtu) {
1058 if(!(handle->priv)) {
1062 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1063 that->node_pmtu(static_cast<node *>(peer), pmtu);
1066 static void node_duplicate_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer) {
1067 if(!(handle->priv)) {
1071 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1072 that->node_duplicate(static_cast<node *>(peer));
1075 static void log_trampoline(meshlink_handle_t *handle, log_level_t level, const char *message) {
1076 if(!(handle->priv)) {
1080 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1081 that->log(level, message);
1084 static void error_trampoline(meshlink_handle_t *handle, meshlink_errno_t meshlink_errno) {
1085 if(!(handle->priv)) {
1089 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1090 that->error(meshlink_errno);
1093 static void connection_try_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer) {
1094 if(!(handle->priv)) {
1098 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1099 that->connection_try(static_cast<node *>(peer));
1102 static bool channel_accept_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, uint16_t port, const void *data, size_t len) {
1103 if(!(handle->priv)) {
1107 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1108 bool accepted = that->channel_accept(static_cast<meshlink::channel *>(channel), port, data, len);
1111 meshlink_set_channel_receive_cb(handle, channel, &channel_receive_trampoline);
1112 meshlink_set_channel_poll_cb(handle, channel, &channel_poll_trampoline);
1118 static void channel_receive_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, const void *data, size_t len) {
1119 if(!(handle->priv)) {
1123 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1124 that->channel_receive(static_cast<meshlink::channel *>(channel), data, len);
1127 static void channel_poll_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, size_t len) {
1128 if(!(handle->priv)) {
1132 meshlink::mesh *that = static_cast<mesh *>(handle->priv);
1133 that->channel_poll(static_cast<meshlink::channel *>(channel), len);
1136 meshlink_handle_t *handle;
1139 static inline const char *strerror(errno_t err = meshlink_errno) {
1140 return meshlink_strerror(err);
1143 /// Destroy a MeshLink instance.
1144 /** This function remove all configuration files of a MeshLink instance. It should only be called when the application
1145 * does not have an open handle to this instance. Afterwards, a call to meshlink_open() will create a completely
1148 * @param confbase The directory in which MeshLink stores its configuration files.
1149 * After the function returns, the application is free to overwrite or free @a confbase @a.
1151 * @return This function will return true if the MeshLink instance was successfully destroyed, false otherwise.
1153 static inline bool destroy(const char *confbase) {
1154 return meshlink_destroy(confbase);