Fix spelling errors.

[meshlink] / src / devtools.h

diff --git a/src/devtools.h b/src/devtools.h
index 76f9ab539786913ab2d9cda6524ce3e16fe1c024..97924384aff55e04fe6034d3b055b3349f5d5696 100644 (file)
--- a/src/devtools.h
+++ b/src/devtools.h
@@ -68,7 +68,7 @@ struct devtool_edge {
  *  @return             A pointer to an array containing devtool_edge_t elements,
  *                      or NULL in case of an error.
  *                      If the @a edges @a argument was not NULL, then the
- *                      retun value can be either the same value or a different
+ *                      return value can be either the same value or a different
  *                      value. If the new values is NULL, then the old array
  *                      will have been freed by Meshlink.
  */
@@ -82,4 +82,73 @@ extern devtool_edge_t *devtool_get_all_edges(meshlink_handle_t *mesh, devtool_ed
  */
 extern bool devtool_export_json_all_edges_state(meshlink_handle_t *mesh, FILE *stream);
 
+/// The status of a node.
+typedef struct devtool_node_status devtool_node_status_t;
+
+/// The status of a node.
+struct devtool_node_status {
+       uint32_t options;
+       uint32_t status;
+       struct sockaddr_storage address;
+       uint16_t mtu;
+       uint16_t minmtu;
+       uint16_t maxmtu;
+       int mtuprobes;
+       enum {
+               DEVTOOL_UDP_FAILED = -2,     /// UDP tried but failed
+               DEVTOOL_UDP_IMPOSSIBLE = -1, /// UDP not possible (node unreachable)
+               DEVTOOL_UDP_UNKNOWN = 0,     /// UDP status not known (never tried to communicate with the node)
+               DEVTOOL_UDP_TRYING,          /// UDP detection in progress
+               DEVTOOL_UDP_WORKING,         /// UDP communication established
+       } udp_status;
+       uint64_t in_packets;
+       uint64_t in_bytes;
+       uint64_t out_packets;
+       uint64_t out_bytes;
+};
+
+/// Get the status of a node.
+/** This function returns a struct containing extra information about a node.
+ *  The information is a snapshot taken at call time.
+ *
+ *  @param mesh         A handle which represents an instance of MeshLink.
+ *  @param node         A pointer to a meshlink_node_t.
+ *  @param status       A pointer to a devtools_node_status_t variable that has
+ *                      to be provided by the caller.
+ *                      The contents of this variable will be changed to reflect
+ *                      the current status of the node.
+ */
+extern void devtool_get_node_status(meshlink_handle_t *mesh, meshlink_node_t *node, devtool_node_status_t *status);
+
+/// Get the list of all submeshes of a meshlink instance.
+/** This function returns an array of submesh handles.
+ *  These pointers are the same pointers that are present in the submeshes list
+ *  in mesh handle.
+ *
+ *  @param mesh         A handle which represents an instance of MeshLink.
+ *  @param submeshes    A pointer to an array of submesh handles if any allocated previously.
+ *  @param nmemb        A pointer to a size_t variable that has
+ *                      to be provided by the caller.
+ *                      The contents of this variable will be changed to indicate
+ *                      the number if array elements.
+ */
+extern meshlink_submesh_t **devtool_get_all_submeshes(meshlink_handle_t *mesh, meshlink_submesh_t **submeshes, size_t *nmemb);
+
+/// Open a MeshLink instance in a given network namespace.
+/** This function opens MeshLink in the given network namespace.
+ *
+ *  @param confbase The directory in which MeshLink will store its configuration files.
+ *                  After the function returns, the application is free to overwrite or free @a confbase @a.
+ *  @param name     The name which this instance of the application will use in the mesh.
+ *                  After the function returns, the application is free to overwrite or free @a name @a.
+ *  @param appname  The application name which will be used in the mesh.
+ *                  After the function returns, the application is free to overwrite or free @a name @a.
+ *  @param devclass The device class which will be used in the mesh.
+ *  @param netns    A filedescriptor that represents the network namespace.
+ *
+ *  @return         A pointer to a meshlink_handle_t which represents this instance of MeshLink, or NULL in case of an error.
+ *                  The pointer is valid until meshlink_close() is called.
+ */
+extern meshlink_handle_t *devtool_open_in_netns(const char *confbase, const char *name, const char *appname, dev_class_t devclass, int netns);
+
 #endif