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.
30 /// A handle for an instance of MeshLink.
31 typedef struct meshlink_handle meshlink_handle_t;
33 /// A handle for a MeshLink node.
34 typedef struct meshlink_node meshlink_node_t;
36 typedef struct meshlink_connection meshlink_connection_t;
38 /// Code of most recent error encountered.
40 MESHLINK_OK, ///< Everything is fine
41 MESHLINK_ENOMEM, ///< Out of memory
42 MESHLINK_ENOENT, ///< Node is not known
45 #ifndef MESHLINK_INTERNAL_H
47 struct meshlink_handle {
48 meshlink_errno_t meshlink_errno; ///< Code of the last encountered error.
49 const char *errstr; ///< Textual representation of most recent error encountered.
52 struct meshlink_node {
53 const char *name; ///< Textual name of this node.
54 void *priv; ///< Private pointer which the application can set at will.
57 struct meshlink_connection {
61 #endif // MESHLINK_INTERNAL_H
63 /// Get the text for the given MeshLink error code.
64 /** This function returns a pointer to the string containing the description of the given error code.
66 * @param errno An error code returned by MeshLink.
68 * @return A pointer to a string containing the description of the error code.
70 extern const char *meshlink_strerror(meshlink_errno_t errno);
72 /// Initialize MeshLink's configuration directory.
73 /** This function causes MeshLink to initialize its configuration directory,
74 * if it hasn't already been initialized.
75 * It only has to be run the first time the application starts,
76 * but it is not a problem if it is run more than once, as long as
77 * the arguments given are the same.
79 * This function does not start any network I/O yet. The application should
80 * first set callbacks, and then call meshlink_start().
82 * @param confbase The directory in which MeshLink will store its configuration files.
83 * @param name The name which this instance of the application will use in the mesh.
85 * @return This function will return true if MeshLink has succesfully set up its configuration files, false otherwise.
87 extern meshlink_handle_t *meshlink_open(const char *confbase, const char *name);
90 /** This function causes MeshLink to open network sockets, make outgoing connections, and
91 * create a new thread, which will handle all network I/O.
93 * @param mesh A handle which represents an instance of MeshLink.
95 * @return This function will return true if MeshLink has succesfully started its thread, false otherwise.
97 extern bool meshlink_start(meshlink_handle_t *mesh);
100 /** This function causes MeshLink to disconnect from all other nodes,
101 * close all sockets, and shut down its own thread.
103 * @param mesh A handle which represents an instance of MeshLink.
105 extern void meshlink_stop(meshlink_handle_t *mesh);
107 /// Close the MeshLink handle.
108 /** This function calls meshlink_stop() if necessary,
109 * and frees all memory allocated by MeshLink.
110 * Afterwards, the handle and any pointers to a struct meshlink_node are invalid.
112 * @param mesh A handle which represents an instance of MeshLink.
114 extern void meshlink_close(meshlink_handle_t *mesh);
116 /// A callback for receiving data from the mesh.
117 /** @param mesh A handle which represents an instance of MeshLink.
118 * @param source A pointer to a meshlink_node_t describing the source of the data.
119 * @param data A pointer to a buffer containing the data sent by the source.
120 * @param len The length of the received data.
122 typedef void (*meshlink_receive_cb_t)(meshlink_handle_t *mesh, meshlink_node_t *source, const void *data, size_t len);
124 /// Set the receive callback.
125 /** This functions sets the callback that is called whenever another node sends data to the local node.
126 * The callback is run in MeshLink's own thread.
127 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
128 * to hand the data over to the application's thread.
129 * The callback should also not block itself and return as quickly as possible.
131 * @param mesh A handle which represents an instance of MeshLink.
132 * @param cb A pointer to the function which will be called when another node sends data to the local node.
134 extern void meshlink_set_receive_cb(meshlink_handle_t *mesh, meshlink_receive_cb_t cb);
136 /// A callback reporting node status changes.
137 /** @param mesh A handle which represents an instance of MeshLink.
138 * @param node A pointer to a meshlink_node_t describing the node whose status changed.
139 * @param reachable True if the node is reachable, false otherwise.
141 typedef void (*meshlink_node_status_cb_t)(meshlink_handle_t *mesh, meshlink_node_t *node, bool reachable);
143 /// Set the node status callback.
144 /** This functions sets the callback that is called whenever another node's status changed.
145 * The callback is run in MeshLink's own thread.
146 * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
147 * to hand the data over to the application's thread.
148 * The callback should also not block itself and return as quickly as possible.
150 * @param mesh A handle which represents an instance of MeshLink.
151 * @param cb A pointer to the function which will be called when another node's status changes.
153 extern void meshlink_set_node_status_cb(meshlink_handle_t *mesh, meshlink_node_status_cb_t cb);
155 /// Severity of log messages generated by MeshLink.
157 MESHLINK_DEBUG, ///< Internal debugging messages. Only useful during application development.
158 MESHLINK_INFO, ///< Informational messages.
159 MESHLINK_WARNING, ///< Warnings which might indicate problems, but which are not real errors.
160 MESHLINK_ERROR, ///< Errors which hamper correct functioning of MeshLink, without causing it to fail completely.
161 MESHLINK_CRITICAL, ///< Critical errors which cause MeshLink to fail completely.
162 } meshlink_log_level_t;
164 /// A callback for receiving log messages generated by MeshLink.
165 /** @param mesh A handle which represents an instance of MeshLink.
166 * @param level An enum describing the severity level of the message.
167 * @param text A pointer to a string containing the textual log message.
169 typedef void (*meshlink_log_cb_t)(meshlink_handle_t *mesh, meshlink_log_level_t level, const char *text);
171 /// Set the log callback.
172 /** This functions sets the callback that is called whenever MeshLink has some information to log.
173 * The callback is run in MeshLink's own thread.
174 * It is important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
175 * to hand the data over to the application's thread.
176 * The callback should also not block itself and return as quickly as possible.
178 * @param mesh A handle which represents an instance of MeshLink.
179 * @param level An enum describing the minimum severity level. Debugging information with a lower level will not trigger the callback.
180 * @param cb A pointer to the function which will be called when another node sends data to the local node.
182 extern void meshlink_set_log_cb(meshlink_handle_t *mesh, meshlink_log_level_t level, meshlink_log_cb_t cb);
184 /// Send data to another node.
185 /** This functions sends one packet of data to another node in the mesh.
186 * The packet is sent using UDP semantics, which means that
187 * the packet is sent as one unit and is received as one unit,
188 * and that there is no guarantee that the packet will arrive at the destination.
189 * The application should take care of getting an acknowledgement and retransmission if necessary.
191 * @param mesh A handle which represents an instance of MeshLink.
192 * @param destination A pointer to a meshlink_node_t describing the destination for the data.
193 * @param data A pointer to a buffer containing the data to be sent to the source.
194 * @param len The length of the data.
195 * @return This function will return true if MeshLink has queued the message for transmission, and false otherwise.
196 * A return value of true does not guarantee that the message will actually arrive at the destination.
198 extern bool meshlink_send(meshlink_handle_t *mesh, meshlink_node_t *destination, const void *data, unsigned int len);
200 /// Get a handle for a specific node.
201 /** This function returns a handle for the node with the given name.
203 * @param mesh A handle which represents an instance of MeshLink.
204 * @param name The name of the node for which a handle is requested.
206 * @return A pointer to a meshlink_node_t which represents the requested node,
207 * or NULL if the requested node does not exist.
209 extern meshlink_node_t *meshlink_get_node(meshlink_handle_t *mesh, const char *name);
211 /// Get a list of all nodes.
212 /** This function returns a list with handles for all known nodes.
214 * @param mesh A handle which represents an instance of MeshLink.
215 * @param nodes A pointer to an array of pointers to meshlink_node_t, which should be allocated by the application.
216 * @param nmemb The maximum number of pointers that can be stored in the nodes array.
218 * @return The number of known nodes. This can be larger than nmemb, in which case not all nodes were stored in the nodes array.
220 extern size_t meshlink_get_all_nodes(meshlink_handle_t *mesh, meshlink_node_t **nodes, size_t nmemb);
222 /// Sign data using the local node's MeshLink key.
223 /** This function signs data using the local node's MeshLink key.
224 * The generated signature can be securely verified by other nodes.
226 * @param mesh A handle which represents an instance of MeshLink.
227 * @param data A pointer to a buffer containing the data to be signed.
228 * @param len The length of the data to be signed.
230 * @return This function returns a pointer to a string containing the signature, or NULL in case of an error.
231 * The application should call free() after it has finished using the signature.
233 extern char *meshlink_sign(meshlink_handle_t *mesh, const char *data, size_t len);
235 /// Verify the signature generated by another node of a piece of data.
236 /** This function verifies the signature that another node generated for a piece of data.
238 * @param mesh A handle which represents an instance of MeshLink.
239 * @param source A pointer to a meshlink_node_t describing the source of the signature.
240 * @param data A pointer to a buffer containing the data to be verified.
241 * @param len The length of the data to be verified.
242 * @param signature A pointer to a string containing the signature.
244 * @return This function returns true if the signature is valid, false otherwise.
246 extern bool meshlink_verify(meshlink_handle_t *mesh, meshlink_node_t *source, const char *data, size_t len, const char *signature);
248 /// Add an Address for the local node.
249 /** This function adds an Address for the local node, which will be used for invitation URLs.
251 * @param mesh A handle which represents an instance of MeshLink.
252 * @param address A string containing the address, which can be either in numeric format or a hostname.
254 * @return This function returns true if the address was added, false otherwise.
256 extern bool meshlink_add_address(meshlink_handle_t *mesh, const char *address);
258 /// Invite another node into the mesh.
259 /** This function generates an invitation that can be used by another node to join the same mesh as the local node.
260 * The generated invitation is a string containing a URL.
261 * This URL should be passed by the application to the invitee in a way that no eavesdroppers can see the URL.
262 * The URL can only be used once, after the user has joined the mesh the URL is no longer valid.
264 * @param mesh A handle which represents an instance of MeshLink.
265 * @param name The name that the invitee will use in the mesh.
267 * @return This function returns a string that contains the invitation URL.
268 * The application should call free() after it has finished using the URL.
270 extern char *meshlink_invite(meshlink_handle_t *mesh, const char *name);
272 /// Use an invitation to join a mesh.
273 /** This function allows the local node to join an existing mesh using an invitation URL generated by another node.
274 * An invitation can only be used if the local node has never connected to other nodes before.
275 * After a succesfully accepted invitation, the name of the local node may have changed.
277 * @param mesh A handle which represents an instance of MeshLink.
278 * @param invitation A string containing the invitation URL.
280 * @return This function returns true if the local node joined the mesh it was invited to, false otherwise.
282 extern bool meshlink_join(meshlink_handle_t *mesh, const char *invitation);
284 /// Export the local node's key and addresses.
285 /** This function generates a string that contains the local node's public key and one or more IP addresses.
286 * The application can pass it in some way to another node, which can then import it,
287 * granting the local node access to the other node's mesh.
289 * @param mesh A handle which represents an instance of MeshLink.
291 * @return This function returns a string that contains the exported key and addresses.
292 * The application should call free() after it has finished using this string.
294 extern char *meshlink_export(meshlink_handle_t *mesh);
296 /// Import another node's key and addresses.
297 /** This function accepts a string containing the exported public key and addresses of another node.
298 * By importing this data, the local node grants the other node access to its mesh.
300 * @param mesh A handle which represents an instance of MeshLink.
301 * @param data A string containing the other node's exported key and addresses.
303 * @return This function returns true if the data was valid and the other node has been granted access to the mesh, false otherwise.
305 extern bool meshlink_import(meshlink_handle_t *mesh, const char *data);
307 /// Blacklist a node from the mesh.
308 /** This function causes the local node to blacklist another node.
309 * The local node will drop any existing connections to that node,
310 * and will not send data to it nor accept any data received from it any more.
312 * @param mesh A handle which represents an instance of MeshLink.
313 * @param node A pointer to a meshlink_node_t describing the node to be blacklisted.
315 extern void meshlink_blacklist(meshlink_handle_t *mesh, meshlink_node_t *node);
317 /// Open a channel to destination node for reliable data delivery
318 extern meshlink_connection_t* meshlink_open_rchannel(meshlink_handle_t *mesh, meshlink_node_t *destination, uint16_t dport);