2 meshlink.h -- MeshLink API
3 Copyright (C) 2014 Guus Sliepen <guus@meshlink.io>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
32 /// The length in bytes of a signature made with meshlink_sign()
33 #define MESHLINK_SIGLEN (64)
35 /// A handle for an instance of MeshLink.
36 typedef struct meshlink_handle meshlink_handle_t;
38 /// A handle for a MeshLink node.
39 typedef struct meshlink_node meshlink_node_t;
41 /// A handle for a MeshLink channel.
42 typedef struct meshlink_channel meshlink_channel_t;
44 /// Code of most recent error encountered.
46 MESHLINK_OK, ///< Everything is fine
47 MESHLINK_ENOMEM, ///< Out of memory
48 MESHLINK_ENOENT, ///< Node is not known
51 /// A variable holding the last encountered error from MeshLink.
52 extern __thread meshlink_errno_t meshlink_errno;
54 #ifndef MESHLINK_INTERNAL_H
56 struct meshlink_handle {
59 struct meshlink_node {
60 const char *name; ///< Textual name of this node.
61 void *priv; ///< Private pointer which the application can set at will.
64 struct meshlink_channel {
67 #endif // MESHLINK_INTERNAL_H
69 /// Get the text for the given MeshLink error code.
70 /** This function returns a pointer to the string containing the description of the given error code.
72 * @param err An error code returned by MeshLink.
74 * @return A pointer to a string containing the description of the error code.
75 * This function will always return a valid pointer, even if an invalid error code has been passed.
77 extern const char *meshlink_strerror(meshlink_errno_t err);
79 /// Open or create a MeshLink instance.
80 /** This function opens or creates a MeshLink instance.
81 * The state is stored in the configuration directory passed in the variable @a confbase @a.
82 * If the configuration directory does not exist yet, for example when it is the first time
83 * this instance is opened, the configuration directory will be automatically created and initialized.
84 * However, the parent directory should already exist, otherwise an error will be returned.
86 * The name given should be a unique identifier for this instance.
88 * This function returns a pointer to a struct meshlink_handle that will be allocated by MeshLink.
89 * When the application does no longer need to use this handle, it must call meshlink_close() to
92 * This function does not start any network I/O yet. The application should
93 * first set callbacks, and then call meshlink_start().
95 * @param confbase The directory in which MeshLink will store its configuration files.
96 * After the function returns, the application is free to overwrite or free @a confbase @a.
97 * @param name The name which this instance of the application will use in the mesh.
98 * After the function returns, the application is free to overwrite or free @a name @a.
100 * @return A pointer to a meshlink_handle_t which represents this instance of MeshLink, or NULL in case of an error.
101 * The pointer is valid until meshlink_close() is called.
103 extern meshlink_handle_t *meshlink_open(const char *confbase, const char *name);
106 /** This function causes MeshLink to open network sockets, make outgoing connections, and
107 * create a new thread, which will handle all network I/O.
109 * @param mesh A handle which represents an instance of MeshLink.
111 * @return This function will return true if MeshLink has succesfully started its thread, false otherwise.
113 extern bool meshlink_start(meshlink_handle_t *mesh);
116 /** This function causes MeshLink to disconnect from all other nodes,
117 * close all sockets, and shut down its own thread.
119 * @param mesh A handle which represents an instance of MeshLink.
121 extern void meshlink_stop(meshlink_handle_t *mesh);
123 /// Close the MeshLink handle.
124 /** This function calls meshlink_stop() if necessary,
125 * and frees the struct meshlink_handle and all associacted memory allocated by MeshLink.
126 * Afterwards, the handle and any pointers to a struct meshlink_node or struct meshlink_channel are invalid.
128 * @param mesh A handle which represents an instance of MeshLink.
130 extern void meshlink_close(meshlink_handle_t *mesh);
132 /// A callback for receiving data from the mesh.
133 /** @param mesh A handle which represents an instance of MeshLink.
134 * @param source A pointer to a meshlink_node_t describing the source of the data.
135 * @param data A pointer to a buffer containing the data sent by the source.
136 * The pointer is only valid during the lifetime of the callback.
137 * The callback should mempcy() the data if it needs to be available outside the callback.
138 * @param len The length of the received data.
140 typedef void (*meshlink_receive_cb_t)(meshlink_handle_t *mesh, meshlink_node_t *source, const void *data, size_t len);
142 /// Set the receive callback.
143 /** This functions sets the callback that is called whenever another node sends data to the local node.
144 * The callback is run in MeshLink's own thread.
145 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
146 * to hand the data over to the application's thread.
147 * The callback should also not block itself and return as quickly as possible.
149 * @param mesh A handle which represents an instance of MeshLink.
150 * @param cb A pointer to the function which will be called when another node sends data to the local node.
151 * If a NULL pointer is given, the callback will be disabled.
153 extern void meshlink_set_receive_cb(meshlink_handle_t *mesh, meshlink_receive_cb_t cb);
155 /// A callback reporting node status changes.
156 /** @param mesh A handle which represents an instance of MeshLink.
157 * @param node A pointer to a meshlink_node_t describing the node whose status changed.
158 * @param reachable True if the node is reachable, false otherwise.
160 typedef void (*meshlink_node_status_cb_t)(meshlink_handle_t *mesh, meshlink_node_t *node, bool reachable);
162 /// Set the node status callback.
163 /** This functions sets the callback that is called whenever another node's status changed.
164 * The callback is run in MeshLink's own thread.
165 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
166 * to hand the data over to the application's thread.
167 * The callback should also not block itself and return as quickly as possible.
169 * @param mesh A handle which represents an instance of MeshLink.
170 * @param cb A pointer to the function which will be called when another node's status changes.
171 * If a NULL pointer is given, the callback will be disabled.
173 extern void meshlink_set_node_status_cb(meshlink_handle_t *mesh, meshlink_node_status_cb_t cb);
175 /// Severity of log messages generated by MeshLink.
177 MESHLINK_DEBUG, ///< Internal debugging messages. Only useful during application development.
178 MESHLINK_INFO, ///< Informational messages.
179 MESHLINK_WARNING, ///< Warnings which might indicate problems, but which are not real errors.
180 MESHLINK_ERROR, ///< Errors which hamper correct functioning of MeshLink, without causing it to fail completely.
181 MESHLINK_CRITICAL, ///< Critical errors which cause MeshLink to fail completely.
182 } meshlink_log_level_t;
184 /// A callback for receiving log messages generated by MeshLink.
185 /** @param mesh A handle which represents an instance of MeshLink.
186 * @param level An enum describing the severity level of the message.
187 * @param text A pointer to a string containing the textual log message.
188 * This pointer is only valid for the duration of the callback.
189 * The application should strdup() the text if it has to be available outside the callback.
191 typedef void (*meshlink_log_cb_t)(meshlink_handle_t *mesh, meshlink_log_level_t level, const char *text);
193 /// Set the log callback.
194 /** This functions sets the callback that is called whenever MeshLink has some information to log.
195 * The callback is run in MeshLink's own thread.
196 * It is important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
197 * to hand the data over to the application's thread.
198 * The callback should also not block itself and return as quickly as possible.
200 * @param mesh A handle which represents an instance of MeshLink.
201 * @param level An enum describing the minimum severity level. Debugging information with a lower level will not trigger the callback.
202 * @param cb A pointer to the function which will be called when another node sends data to the local node.
203 * If a NULL pointer is given, the callback will be disabled.
205 extern void meshlink_set_log_cb(meshlink_handle_t *mesh, meshlink_log_level_t level, meshlink_log_cb_t cb);
207 /// Send data to another node.
208 /** This functions sends one packet of data to another node in the mesh.
209 * The packet is sent using UDP semantics, which means that
210 * the packet is sent as one unit and is received as one unit,
211 * and that there is no guarantee that the packet will arrive at the destination.
212 * The application should take care of getting an acknowledgement and retransmission if necessary.
214 * @param mesh A handle which represents an instance of MeshLink.
215 * @param destination A pointer to a meshlink_node_t describing the destination for the data.
216 * @param data A pointer to a buffer containing the data to be sent to the source.
217 * After meshlink_send() returns, the application is free to overwrite or free this buffer.
218 * @param len The length of the data.
219 * @return This function will return true if MeshLink has queued the message for transmission, and false otherwise.
220 * A return value of true does not guarantee that the message will actually arrive at the destination.
222 extern bool meshlink_send(meshlink_handle_t *mesh, meshlink_node_t *destination, const void *data, unsigned int len);
224 /// Get a handle for a specific node.
225 /** This function returns a handle for the node with the given name.
227 * @param mesh A handle which represents an instance of MeshLink.
228 * @param name The name of the node for which a handle is requested.
229 * After this function returns, the application is free to overwrite or free @a name @a.
231 * @return A pointer to a meshlink_node_t which represents the requested node,
232 * or NULL if the requested node does not exist.
233 * The pointer is guaranteed to be valid until meshlink_close() is called.
235 extern meshlink_node_t *meshlink_get_node(meshlink_handle_t *mesh, const char *name);
237 /// Get a list of all nodes.
238 /** This function returns a list with handles for all known nodes.
240 * @param mesh A handle which represents an instance of MeshLink.
241 * @param nodes A pointer to an array of pointers to meshlink_node_t, which should be allocated by the application.
242 * The pointers are valid until meshlink_close() is called.
243 * @param nmemb The maximum number of pointers that can be stored in the nodes array.
245 * @return The number of known nodes, or -1 in case of an error.
246 * The returned number of nodes can be larger than nmemb, in which case not all nodes were stored in the nodes array.
248 extern ssize_t meshlink_get_all_nodes(meshlink_handle_t *mesh, meshlink_node_t **nodes, size_t nmemb);
250 /// Sign data using the local node's MeshLink key.
251 /** This function signs data using the local node's MeshLink key.
252 * The generated signature can be securely verified by other nodes.
254 * @param mesh A handle which represents an instance of MeshLink.
255 * @param data A pointer to a buffer containing the data to be signed.
256 * @param len The length of the data to be signed.
257 * @param signature A pointer to a buffer where the signature will be stored.
258 * The buffer must be allocated by the application, and should be at least MESHLINK_SIGLEN bytes big.
259 * @param siglen The size of the signature buffer. Will be changed after the call to match the size of the signature itself.
261 * @return This function returns true if the signature was correctly generated, false otherwise.
263 extern bool meshlink_sign(meshlink_handle_t *mesh, const void *data, size_t len, void *signature, size_t *siglen);
265 /// Verify the signature generated by another node of a piece of data.
266 /** This function verifies the signature that another node generated for a piece of data.
268 * @param mesh A handle which represents an instance of MeshLink.
269 * @param source A pointer to a meshlink_node_t describing the source of the signature.
270 * @param data A pointer to a buffer containing the data to be verified.
271 * @param len The length of the data to be verified.
272 * @param signature A pointer to a buffer where the signature will be stored.
273 * @param siglen A pointer to a variable holding the size of the signature buffer.
274 * The contents of the variable will be changed by meshlink_sign() to reflect the actual size of the signature.
276 * @return This function returns true if the signature is valid, false otherwise.
278 extern bool meshlink_verify(meshlink_handle_t *mesh, meshlink_node_t *source, const void *data, size_t len, const void *signature, size_t siglen);
280 /// Add an Address for the local node.
281 /** This function adds an Address for the local node, which will be used for invitation URLs.
283 * @param mesh A handle which represents an instance of MeshLink.
284 * @param address A string containing the address, which can be either in numeric format or a hostname.
286 * @return This function returns true if the address was added, false otherwise.
288 extern bool meshlink_add_address(meshlink_handle_t *mesh, const char *address);
290 /// Invite another node into the mesh.
291 /** This function generates an invitation that can be used by another node to join the same mesh as the local node.
292 * The generated invitation is a string containing a URL.
293 * This URL should be passed by the application to the invitee in a way that no eavesdroppers can see the URL.
294 * The URL can only be used once, after the user has joined the mesh the URL is no longer valid.
296 * @param mesh A handle which represents an instance of MeshLink.
297 * @param name The name that the invitee will use in the mesh.
298 * After this function returns, the application is free to overwrite or free @a name @a.
300 * @return This function returns a string that contains the invitation URL, or NULL in case of an error.
301 * The application should call free() after it has finished using the URL.
303 extern char *meshlink_invite(meshlink_handle_t *mesh, const char *name);
305 /// Use an invitation to join a mesh.
306 /** This function allows the local node to join an existing mesh using an invitation URL generated by another node.
307 * An invitation can only be used if the local node has never connected to other nodes before.
308 * After a succesfully accepted invitation, the name of the local node may have changed.
310 * @param mesh A handle which represents an instance of MeshLink.
311 * @param invitation A string containing the invitation URL.
312 * After this function returns, the application is free to overwrite or free @a invitation @a.
314 * @return This function returns true if the local node joined the mesh it was invited to, false otherwise.
316 extern bool meshlink_join(meshlink_handle_t *mesh, const char *invitation);
318 /// Export the local node's key and addresses.
319 /** This function generates a string that contains the local node's public key and one or more IP addresses.
320 * The application can pass it in some way to another node, which can then import it,
321 * granting the local node access to the other node's mesh.
323 * @param mesh A handle which represents an instance of MeshLink.
325 * @return This function returns a string that contains the exported key and addresses, or NULL in case of an error.
326 * The application should call free() after it has finished using this string.
328 extern char *meshlink_export(meshlink_handle_t *mesh);
330 /// Import another node's key and addresses.
331 /** This function accepts a string containing the exported public key and addresses of another node.
332 * By importing this data, the local node grants the other node access to its mesh.
334 * @param mesh A handle which represents an instance of MeshLink.
335 * @param data A string containing the other node's exported key and addresses.
336 * After this function returns, the application is free to overwrite or free @a data @a.
338 * @return This function returns true if the data was valid and the other node has been granted access to the mesh, false otherwise.
340 extern bool meshlink_import(meshlink_handle_t *mesh, const char *data);
342 /// Blacklist a node from the mesh.
343 /** This function causes the local node to blacklist another node.
344 * The local node will drop any existing connections to that node,
345 * and will not send data to it nor accept any data received from it any more.
347 * @param mesh A handle which represents an instance of MeshLink.
348 * @param node A pointer to a meshlink_node_t describing the node to be blacklisted.
350 extern void meshlink_blacklist(meshlink_handle_t *mesh, meshlink_node_t *node);
352 /// A callback for accepting incoming channels.
353 /** This function is called whenever a remote node wants to open a channel to the local node.
354 * The application then has to decide whether to accept or reject this channel.
356 * @param mesh A handle which represents an instance of MeshLink.
357 * @param channel A handle for the incoming channel.
358 * If the application accepts the incoming channel by returning true,
359 * then this handle is valid until meshlink_channel_close() is called on it.
360 * If the application rejects the incoming channel by returning false,
361 * then this handle is invalid after the callback returns
362 * (the callback does not need to call meshlink_channel_close() itself in this case).
363 * @param node The node from which this channel is being initiated.
364 * The pointer is guaranteed to be valid until meshlink_close() is called.
365 * @param port The port number the peer wishes to connect to.
366 * @param data A pointer to a buffer containing data already received. (Not yet used.)
367 * The pointer is only valid during the lifetime of the callback.
368 * The callback should mempcy() the data if it needs to be available outside the callback.
369 * @param len The length of the data. (Not yet used.)
371 * @return This function should return true if the application accepts the incoming channel, false otherwise.
372 * If returning false, the channel is invalid and may not be used anymore.
374 typedef bool (*meshlink_channel_accept_cb_t)(meshlink_handle_t *mesh, meshlink_channel_t *channel, meshlink_node_t *node, uint16_t port, const void *data, size_t len);
376 /// A callback for receiving data from a channel.
377 /** This function is called whenever a remote node wants to open a channel to the local node.
378 * The application then has to decide whether to accept or reject this channel.
380 * @param mesh A handle which represents an instance of MeshLink.
381 * @param channel A handle for the channel.
382 * @param data A pointer to a buffer containing data sent by the source.
383 * The pointer is only valid during the lifetime of the callback.
384 * The callback should mempcy() the data if it needs to be available outside the callback.
385 * @param len The length of the data.
387 typedef void (*meshlink_channel_receive_cb_t)(meshlink_handle_t *mesh, meshlink_channel_t *channel, const void *data, size_t len);
389 /// Set the accept callback.
390 /** This functions sets the callback that is called whenever another node sends data to the local node.
391 * The callback is run in MeshLink's own thread.
392 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
393 * to hand the data over to the application's thread.
394 * The callback should also not block itself and return as quickly as possible.
396 * If no accept callback is set, incoming channels are rejected.
398 * @param mesh A handle which represents an instance of MeshLink.
399 * @param cb A pointer to the function which will be called when another node sends data to the local node.
400 * If a NULL pointer is given, the callback will be disabled.
402 extern void meshlink_set_channel_accept_cb(meshlink_handle_t *mesh, meshlink_channel_accept_cb_t cb);
404 /// Set the receive callback.
405 /** This functions sets the callback that is called whenever another node sends data to the local node.
406 * The callback is run in MeshLink's own thread.
407 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
408 * to hand the data over to the application's thread.
409 * The callback should also not block itself and return as quickly as possible.
411 * @param mesh A handle which represents an instance of MeshLink.
412 * @param channel A handle for the channel.
413 * @param cb A pointer to the function which will be called when another node sends data to the local node.
414 * If a NULL pointer is given, the callback will be disabled.
416 extern void meshlink_set_channel_receive_cb(meshlink_handle_t *mesh, meshlink_channel_t *channel, meshlink_channel_receive_cb_t cb);
418 /// Open a reliable stream channel to another node.
419 /** This function is called whenever a remote node wants to open a channel to the local node.
420 * The application then has to decide whether to accept or reject this channel.
422 * This function returns a pointer to a struct meshlink_channel that will be allocated by MeshLink.
423 * When the application does no longer need to use this channel, it must call meshlink_close()
424 * to free its resources.
426 * @param mesh A handle which represents an instance of MeshLink.
427 * @param node The node to which this channel is being initiated.
428 * @param port The port number the peer wishes to connect to.
429 * @param cb A pointer to the function which will be called when the remote node sends data to the local node.
430 * @param data A pointer to a buffer containing data to already queue for sending.
431 * After meshlink_send() returns, the application is free to overwrite or free this buffer.
432 * @param len The length of the data.
434 * @return A handle for the channel, or NULL in case of an error.
435 * The handle is valid until meshlink_channel_close() is called.
437 extern meshlink_channel_t *meshlink_channel_open(meshlink_handle_t *mesh, meshlink_node_t *node, uint16_t port, meshlink_channel_receive_cb_t cb, const void *data, size_t len);
439 /// Partially close a reliable stream channel.
440 /** This shuts down the read or write side of a channel, or both, without closing the handle.
441 * It can be used to inform the remote node that the local node has finished sending all data on the channel,
442 * but still allows waiting for incoming data from the remote node.
444 * Shutting down the receive direction is also possible, and is equivalent to setting the receive callback to NULL.
446 * @param mesh A handle which represents an instance of MeshLink.
447 * @param channel A handle for the channel.
448 * @param direction Must be one of SHUT_RD, SHUT_WR or SHUT_RDWR.
450 extern void meshlink_channel_shutdown(meshlink_handle_t *mesh, meshlink_channel_t *channel, int direction);
452 /// Close a reliable stream channel.
453 /** This informs the remote node that the local node has finished sending all data on the channel.
454 * It also causes the local node to stop accepting incoming data from the remote node.
455 * It will free the struct meshlink_channel and all associated resources.
456 * Afterwards, the channel handle is invalid and must not be used any more.
458 * @param mesh A handle which represents an instance of MeshLink.
459 * @param channel A handle for the channel.
461 extern void meshlink_channel_close(meshlink_handle_t *mesh, meshlink_channel_t *channel);
463 /// Transmit data on a channel
464 /** This queues data to send to the remote node.
466 * @param mesh A handle which represents an instance of MeshLink.
467 * @param channel A handle for the channel.
468 * @param data A pointer to a buffer containing data sent by the source.
469 * After meshlink_send() returns, the application is free to overwrite or free this buffer.
470 * @param len The length of the data.
472 * @return The amount of data that was queued, which can be less than len, or a negative value in case of an error.
474 extern ssize_t meshlink_channel_send(meshlink_handle_t *mesh, meshlink_channel_t *channel, const void *data, size_t len);