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