]> git.meshlink.io Git - meshlink/blob - src/meshlink.h
put macro value in parentheses
[meshlink] / src / meshlink.h
1 /*
2     meshlink.h -- MeshLink API
3     Copyright (C) 2014 Guus Sliepen <guus@meshlink.io>
4
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.
9
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.
14
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.
18 */
19
20 #ifndef MESHLINK_H
21 #define MESHLINK_H
22
23 #include <stdint.h>
24 #include <stdbool.h>
25 #include <stddef.h>
26 #include <unistd.h>
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 /// The length in bytes of a signature made with meshlink_sign()
33 #define MESHLINK_SIGLEN  (64)
34
35 /// A handle for an instance of MeshLink.
36 typedef struct meshlink_handle meshlink_handle_t;
37
38 /// A handle for a MeshLink node.
39 typedef struct meshlink_node meshlink_node_t;
40
41 /// A handle for a MeshLink channel.
42 typedef struct meshlink_channel meshlink_channel_t;
43
44 /// Code of most recent error encountered.
45 typedef enum {
46         MESHLINK_OK,     ///< Everything is fine
47         MESHLINK_ENOMEM, ///< Out of memory
48         MESHLINK_ENOENT, ///< Node is not known
49 } meshlink_errno_t;
50
51 /// A variable holding the last encountered error from MeshLink.
52 extern __thread meshlink_errno_t meshlink_errno;
53
54 #ifndef MESHLINK_INTERNAL_H
55
56 struct meshlink_handle {
57 };
58
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.
62 };
63
64 struct meshlink_channel {
65 };
66
67 #endif // MESHLINK_INTERNAL_H
68
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.
71  *
72  *  @param err      An error code returned by MeshLink.
73  *
74  *  @return         A pointer to a string containing the description of the error code.
75  */
76 extern const char *meshlink_strerror(meshlink_errno_t err);
77
78 /// Open or create a MeshLink instance.
79 /** This function opens or creates a MeshLink instance.
80  *  The state is stored in the configuration directory passed in the variable @a confbase @a.
81  *  If the configuration directory does not exist yet, for example when it is the first time
82  *  this instance is opened, the configuration directory will be automatically created and initialized.
83  *  However, the parent directory should already exist, otherwise an error will be returned.
84  *
85  *  The name given should be a unique identifier for this instance.
86  *
87  *  This function returns a pointer to a struct meshlink_handle that will be allocated by MeshLink.
88  *  When the application does no longer need to use this handle, it must call meshlink_close() to
89  *  free its resources.
90  *
91  *  This function does not start any network I/O yet. The application should
92  *  first set callbacks, and then call meshlink_start().
93  *
94  *  @param confbase The directory in which MeshLink will store its configuration files.
95  *                  After the function returns, the application is free to overwrite or free @a confbase @a.
96  *  @param name     The name which this instance of the application will use in the mesh.
97  *                  After the function returns, the application is free to overwrite or free @a name @a.
98  *
99  *  @return         A pointer to a meshlink_handle_t which represents this instance of MeshLink.
100  *                  The pointer is valid until meshlink_close() is called.
101  */
102 extern meshlink_handle_t *meshlink_open(const char *confbase, const char *name);
103
104 /// Start MeshLink.
105 /** This function causes MeshLink to open network sockets, make outgoing connections, and
106  *  create a new thread, which will handle all network I/O.
107  *
108  *  @param mesh     A handle which represents an instance of MeshLink.
109  *
110  *  @return         This function will return true if MeshLink has succesfully started its thread, false otherwise.
111  */
112 extern bool meshlink_start(meshlink_handle_t *mesh);
113
114 /// Stop MeshLink.
115 /** This function causes MeshLink to disconnect from all other nodes,
116  *  close all sockets, and shut down its own thread.
117  *
118  *  @param mesh     A handle which represents an instance of MeshLink.
119  */
120 extern void meshlink_stop(meshlink_handle_t *mesh);
121
122 /// Close the MeshLink handle.
123 /** This function calls meshlink_stop() if necessary,
124  *  and frees the struct meshlink_handle and all associacted memory allocated by MeshLink.
125  *  Afterwards, the handle and any pointers to a struct meshlink_node or struct meshlink_channel are invalid.
126  *
127  *  @param mesh     A handle which represents an instance of MeshLink.
128  */
129 extern void meshlink_close(meshlink_handle_t *mesh);
130
131 /// A callback for receiving data from the mesh.
132 /** @param mesh      A handle which represents an instance of MeshLink.
133  *  @param source    A pointer to a meshlink_node_t describing the source of the data.
134  *  @param data      A pointer to a buffer containing the data sent by the source.
135  *                   The pointer is only valid during the lifetime of the callback.
136  *                   The callback should mempcy() the data if it needs to be available outside the callback.
137  *  @param len       The length of the received data.
138  */
139 typedef void (*meshlink_receive_cb_t)(meshlink_handle_t *mesh, meshlink_node_t *source, const void *data, size_t len);
140
141 /// Set the receive callback.
142 /** This functions sets the callback that is called whenever another node sends data to the local node.
143  *  The callback is run in MeshLink's own thread.
144  *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
145  *  to hand the data over to the application's thread.
146  *  The callback should also not block itself and return as quickly as possible.
147  *
148  *  @param mesh      A handle which represents an instance of MeshLink.
149  *  @param cb        A pointer to the function which will be called when another node sends data to the local node.
150  *                   If a NULL pointer is given, the callback will be disabled.
151  */
152 extern void meshlink_set_receive_cb(meshlink_handle_t *mesh, meshlink_receive_cb_t cb);
153
154 /// A callback reporting node status changes.
155 /** @param mesh       A handle which represents an instance of MeshLink.
156  *  @param node       A pointer to a meshlink_node_t describing the node whose status changed.
157  *  @param reachable  True if the node is reachable, false otherwise.
158  */
159 typedef void (*meshlink_node_status_cb_t)(meshlink_handle_t *mesh, meshlink_node_t *node, bool reachable);
160
161 /// Set the node status callback.
162 /** This functions sets the callback that is called whenever another node's status changed.
163  *  The callback is run in MeshLink's own thread.
164  *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
165  *  to hand the data over to the application's thread.
166  *  The callback should also not block itself and return as quickly as possible.
167  *
168  *  @param mesh      A handle which represents an instance of MeshLink.
169  *  @param cb        A pointer to the function which will be called when another node's status changes.
170  *                   If a NULL pointer is given, the callback will be disabled.
171  */
172 extern void meshlink_set_node_status_cb(meshlink_handle_t *mesh, meshlink_node_status_cb_t cb);
173
174 /// Severity of log messages generated by MeshLink.
175 typedef enum {
176         MESHLINK_DEBUG,    ///< Internal debugging messages. Only useful during application development.
177         MESHLINK_INFO,     ///< Informational messages.
178         MESHLINK_WARNING,  ///< Warnings which might indicate problems, but which are not real errors.
179         MESHLINK_ERROR,    ///< Errors which hamper correct functioning of MeshLink, without causing it to fail completely.
180         MESHLINK_CRITICAL, ///< Critical errors which cause MeshLink to fail completely.
181 } meshlink_log_level_t;
182
183 /// A callback for receiving log messages generated by MeshLink.
184 /** @param mesh      A handle which represents an instance of MeshLink.
185  *  @param level     An enum describing the severity level of the message.
186  *  @param text      A pointer to a string containing the textual log message.
187  *                   This pointer is only valid for the duration of the callback.
188  *                   The application should strdup() the text if it has to be available outside the callback.
189  */
190 typedef void (*meshlink_log_cb_t)(meshlink_handle_t *mesh, meshlink_log_level_t level, const char *text);
191
192 /// Set the log callback.
193 /** This functions sets the callback that is called whenever MeshLink has some information to log.
194  *  The callback is run in MeshLink's own thread.
195  *  It is important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
196  *  to hand the data over to the application's thread.
197  *  The callback should also not block itself and return as quickly as possible.
198  *
199  *  @param mesh      A handle which represents an instance of MeshLink.
200  *  @param level     An enum describing the minimum severity level. Debugging information with a lower level will not trigger the callback.
201  *  @param cb        A pointer to the function which will be called when another node sends data to the local node.
202  *                   If a NULL pointer is given, the callback will be disabled.
203  */
204 extern void meshlink_set_log_cb(meshlink_handle_t *mesh, meshlink_log_level_t level, meshlink_log_cb_t cb);
205
206 /// Send data to another node.
207 /** This functions sends one packet of data to another node in the mesh.
208  *  The packet is sent using UDP semantics, which means that
209  *  the packet is sent as one unit and is received as one unit,
210  *  and that there is no guarantee that the packet will arrive at the destination.
211  *  The application should take care of getting an acknowledgement and retransmission if necessary.
212  *
213  *  @param mesh         A handle which represents an instance of MeshLink.
214  *  @param destination  A pointer to a meshlink_node_t describing the destination for the data.
215  *  @param data         A pointer to a buffer containing the data to be sent to the source.
216  *                      After meshlink_send() returns, the application is free to overwrite or free this buffer.
217  *  @param len          The length of the data.
218  *  @return             This function will return true if MeshLink has queued the message for transmission, and false otherwise.
219  *                      A return value of true does not guarantee that the message will actually arrive at the destination.
220  */
221 extern bool meshlink_send(meshlink_handle_t *mesh, meshlink_node_t *destination, const void *data, unsigned int len);
222
223 /// Get a handle for a specific node.
224 /** This function returns a handle for the node with the given name.
225  *
226  *  @param mesh         A handle which represents an instance of MeshLink.
227  *  @param name         The name of the node for which a handle is requested.
228  *                      After this function returns, the application is free to overwrite or free @a name @a.
229  *
230  *  @return             A pointer to a meshlink_node_t which represents the requested node,
231  *                      or NULL if the requested node does not exist.
232  *                      The pointer is guaranteed to be valid until meshlink_close() is called.
233  */
234 extern meshlink_node_t *meshlink_get_node(meshlink_handle_t *mesh, const char *name);
235
236 /// Get a list of all nodes.
237 /** This function returns a list with handles for all known nodes.
238  *
239  *  @param mesh         A handle which represents an instance of MeshLink.
240  *  @param nodes        A pointer to an array of pointers to meshlink_node_t, which should be allocated by the application.
241  *                      The pointers are valid until meshlink_close() is called.
242  *  @param nmemb        The maximum number of pointers that can be stored in the nodes array.
243  *
244  *  @return             The number of known nodes, or -1 in case of an error.
245  *                      The returned number of nodes can be larger than nmemb, in which case not all nodes were stored in the nodes array.
246  */
247 extern ssize_t meshlink_get_all_nodes(meshlink_handle_t *mesh, meshlink_node_t **nodes, size_t nmemb);
248
249 /// Sign data using the local node's MeshLink key.
250 /** This function signs data using the local node's MeshLink key.
251  *  The generated signature can be securely verified by other nodes.
252  *
253  *  @param mesh         A handle which represents an instance of MeshLink.
254  *  @param data         A pointer to a buffer containing the data to be signed.
255  *  @param len          The length of the data to be signed.
256  *  @param signature    A pointer to a buffer where the signature will be stored.
257  *                      The buffer must be allocated by the application, and should be at least MESHLINK_SIGLEN bytes big.
258  *  @param siglen       The size of the signature buffer. Will be changed after the call to match the size of the signature itself.
259  *
260  *  @return             This function returns true if the signature was correctly generated, false otherwise.
261  */
262 extern bool meshlink_sign(meshlink_handle_t *mesh, const void *data, size_t len, void *signature, size_t *siglen);
263
264 /// Verify the signature generated by another node of a piece of data.
265 /** This function verifies the signature that another node generated for a piece of data.
266  *
267  *  @param mesh         A handle which represents an instance of MeshLink.
268  *  @param source       A pointer to a meshlink_node_t describing the source of the signature.
269  *  @param data         A pointer to a buffer containing the data to be verified.
270  *  @param len          The length of the data to be verified.
271  *  @param signature    A pointer to a buffer where the signature will be stored.
272  *  @param siglen       A pointer to a variable holding the size of the signature buffer.
273  *                      The contents of the variable will be changed by meshlink_sign() to reflect the actual size of the signature.
274  *
275  *  @return             This function returns true if the signature is valid, false otherwise.
276  */
277 extern bool meshlink_verify(meshlink_handle_t *mesh, meshlink_node_t *source, const void *data, size_t len, const void *signature, size_t siglen);
278
279 /// Add an Address for the local node.
280 /** This function adds an Address for the local node, which will be used for invitation URLs.
281  *
282  *  @param mesh         A handle which represents an instance of MeshLink.
283  *  @param address      A string containing the address, which can be either in numeric format or a hostname.
284  *
285  *  @return             This function returns true if the address was added, false otherwise.
286  */
287 extern bool meshlink_add_address(meshlink_handle_t *mesh, const char *address);
288
289 /// Invite another node into the mesh.
290 /** This function generates an invitation that can be used by another node to join the same mesh as the local node.
291  *  The generated invitation is a string containing a URL.
292  *  This URL should be passed by the application to the invitee in a way that no eavesdroppers can see the URL.
293  *  The URL can only be used once, after the user has joined the mesh the URL is no longer valid.
294  *
295  *  @param mesh         A handle which represents an instance of MeshLink.
296  *  @param name         The name that the invitee will use in the mesh.
297  *                      After this function returns, the application is free to overwrite or free @a name @a.
298  *
299  *  @return             This function returns a string that contains the invitation URL.
300  *                      The application should call free() after it has finished using the URL.
301  */
302 extern char *meshlink_invite(meshlink_handle_t *mesh, const char *name);
303
304 /// Use an invitation to join a mesh.
305 /** This function allows the local node to join an existing mesh using an invitation URL generated by another node.
306  *  An invitation can only be used if the local node has never connected to other nodes before.
307  *  After a succesfully accepted invitation, the name of the local node may have changed.
308  *
309  *  @param mesh         A handle which represents an instance of MeshLink.
310  *  @param invitation   A string containing the invitation URL.
311  *                      After this function returns, the application is free to overwrite or free @a invitation @a.
312  *
313  *  @return             This function returns true if the local node joined the mesh it was invited to, false otherwise.
314  */
315 extern bool meshlink_join(meshlink_handle_t *mesh, const char *invitation);
316
317 /// Export the local node's key and addresses.
318 /** This function generates a string that contains the local node's public key and one or more IP addresses.
319  *  The application can pass it in some way to another node, which can then import it,
320  *  granting the local node access to the other node's mesh.
321  *
322  *  @param mesh         A handle which represents an instance of MeshLink.
323  *
324  *  @return             This function returns a string that contains the exported key and addresses.
325  *                      The application should call free() after it has finished using this string.
326  */
327 extern char *meshlink_export(meshlink_handle_t *mesh);
328
329 /// Import another node's key and addresses.
330 /** This function accepts a string containing the exported public key and addresses of another node.
331  *  By importing this data, the local node grants the other node access to its mesh.
332  *
333  *  @param mesh         A handle which represents an instance of MeshLink.
334  *  @param data         A string containing the other node's exported key and addresses.
335  *                      After this function returns, the application is free to overwrite or free @a data @a.
336  *
337  *  @return             This function returns true if the data was valid and the other node has been granted access to the mesh, false otherwise.
338  */
339 extern bool meshlink_import(meshlink_handle_t *mesh, const char *data);
340
341 /// Blacklist a node from the mesh.
342 /** This function causes the local node to blacklist another node.
343  *  The local node will drop any existing connections to that node,
344  *  and will not send data to it nor accept any data received from it any more.
345  *
346  *  @param mesh         A handle which represents an instance of MeshLink.
347  *  @param node         A pointer to a meshlink_node_t describing the node to be blacklisted.
348  */
349 extern void meshlink_blacklist(meshlink_handle_t *mesh, meshlink_node_t *node);
350
351 /// A callback for accepting incoming channels.
352 /** This function is called whenever a remote node wants to open a channel to the local node.
353  *  The application then has to decide whether to accept or reject this channel.
354  *
355  *  @param mesh         A handle which represents an instance of MeshLink.
356  *  @param channel      A handle for the incoming channel.
357  *                      If the application accepts the incoming channel by returning true,
358  *                      then this handle is valid until meshlink_channel_close() is called on it.
359  *                      If the application rejects the incoming channel by returning false,
360  *                      then this handle is invalid after the callback returns
361  *                      (the callback does not need to call meshlink_channel_close() itself in this case).
362  *  @param node         The node from which this channel is being initiated.
363  *                      The pointer is guaranteed to be valid until meshlink_close() is called.
364  *  @param port         The port number the peer wishes to connect to.
365  *  @param data         A pointer to a buffer containing data already received. (Not yet used.)
366  *                      The pointer is only valid during the lifetime of the callback.
367  *                      The callback should mempcy() the data if it needs to be available outside the callback.
368  *  @param len          The length of the data. (Not yet used.)
369  *
370  *  @return             This function should return true if the application accepts the incoming channel, false otherwise.
371  *                      If returning false, the channel is invalid and may not be used anymore.
372  */
373 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);
374
375 /// A callback for receiving data from a channel.
376 /** This function is called whenever a remote node wants to open a channel to the local node.
377  *  The application then has to decide whether to accept or reject this channel.
378  *
379  *  @param mesh         A handle which represents an instance of MeshLink.
380  *  @param channel      A handle for the channel.
381  *  @param data         A pointer to a buffer containing data sent by the source.
382  *                      The pointer is only valid during the lifetime of the callback.
383  *                      The callback should mempcy() the data if it needs to be available outside the callback.
384  *  @param len          The length of the data.
385  */
386 typedef void (*meshlink_channel_receive_cb_t)(meshlink_handle_t *mesh, meshlink_channel_t *channel, const void *data, size_t len);
387
388 /// Set the accept callback.
389 /** This functions sets the callback that is called whenever another node sends data to the local node.
390  *  The callback is run in MeshLink's own thread.
391  *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
392  *  to hand the data over to the application's thread.
393  *  The callback should also not block itself and return as quickly as possible.
394  *
395  *  If no accept callback is set, incoming channels are rejected.
396  *
397  *  @param mesh      A handle which represents an instance of MeshLink.
398  *  @param cb        A pointer to the function which will be called when another node sends data to the local node.
399  *                   If a NULL pointer is given, the callback will be disabled.
400  */
401 extern void meshlink_set_channel_accept_cb(meshlink_handle_t *mesh, meshlink_channel_accept_cb_t cb);
402
403 /// Set the receive callback.
404 /** This functions sets the callback that is called whenever another node sends data to the local node.
405  *  The callback is run in MeshLink's own thread.
406  *  It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
407  *  to hand the data over to the application's thread.
408  *  The callback should also not block itself and return as quickly as possible.
409  *
410  *  @param mesh      A handle which represents an instance of MeshLink.
411  *  @param channel   A handle for the channel.
412  *  @param cb        A pointer to the function which will be called when another node sends data to the local node.
413  *                   If a NULL pointer is given, the callback will be disabled.
414  */
415 extern void meshlink_set_channel_receive_cb(meshlink_handle_t *mesh, meshlink_channel_t *channel, meshlink_channel_receive_cb_t cb);
416
417 /// Open a reliable stream channel to another node.
418 /** This function is called whenever a remote node wants to open a channel to the local node.
419  *  The application then has to decide whether to accept or reject this channel.
420  *
421  *  This function returns a pointer to a struct meshlink_channel that will be allocated by MeshLink.
422  *  When the application does no longer need to use this channel, it must call meshlink_close()
423  *  to free its resources.
424  *
425  *  @param mesh         A handle which represents an instance of MeshLink.
426  *  @param node         The node to which this channel is being initiated.
427  *  @param port         The port number the peer wishes to connect to.
428  *  @param cb           A pointer to the function which will be called when the remote node sends data to the local node.
429  *  @param data         A pointer to a buffer containing data to already queue for sending.
430  *                      After meshlink_send() returns, the application is free to overwrite or free this buffer.
431  *  @param len          The length of the data.
432  *
433  *  @return             A handle for the channel, or NULL in case of an error.
434  *                      The handle is valid until meshlink_channel_close() is called.
435  */
436 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);
437
438 /// Partially close a reliable stream channel.
439 /** This shuts down the read or write side of a channel, or both, without closing the handle.
440  *  It can be used to inform the remote node that the local node has finished sending all data on the channel,
441  *  but still allows waiting for incoming data from the remote node.
442  *
443  *  Shutting down the receive direction is also possible, and is equivalent to setting the receive callback to NULL.
444  *
445  *  @param mesh         A handle which represents an instance of MeshLink.
446  *  @param channel      A handle for the channel.
447  *  @param direction    Must be one of SHUT_RD, SHUT_WR or SHUT_RDWR.
448  */
449 extern void meshlink_channel_shutdown(meshlink_handle_t *mesh, meshlink_channel_t *channel, int direction);
450
451 /// Close a reliable stream channel.
452 /** This informs the remote node that the local node has finished sending all data on the channel.
453  *  It also causes the local node to stop accepting incoming data from the remote node.
454  *  It will free the struct meshlink_channel and all associated resources.
455  *  Afterwards, the channel handle is invalid and must not be used any more.
456  *
457  *  @param mesh         A handle which represents an instance of MeshLink.
458  *  @param channel      A handle for the channel.
459  */
460 extern void meshlink_channel_close(meshlink_handle_t *mesh, meshlink_channel_t *channel);
461
462 /// Transmit data on a channel
463 /** This queues data to send to the remote node.
464  *
465  *  @param mesh         A handle which represents an instance of MeshLink.
466  *  @param channel      A handle for the channel.
467  *  @param data         A pointer to a buffer containing data sent by the source.
468  *                      After meshlink_send() returns, the application is free to overwrite or free this buffer.
469  *  @param len          The length of the data.
470  *
471  *  @return             The amount of data that was queued, which can be less than len, or a negative value in case of an error.
472  */
473 extern ssize_t meshlink_channel_send(meshlink_handle_t *mesh, meshlink_channel_t *channel, const void *data, size_t len);
474
475 #ifdef __cplusplus
476 }
477 #endif
478
479 #endif // MESHLINK_H