Avoid allocating packet buffers unnecessarily.

[meshlink] / src / devtools.h

diff --git a/src/devtools.h b/src/devtools.h
index a9badbc5149b234416f9ef2bcaab99bea01b61da..6d0b4989c3ce32c18c124faf8bef9219794ba712 100644 (file)
--- a/src/devtools.h
+++ b/src/devtools.h
@@ -41,7 +41,6 @@ struct devtool_edge {
        //   changed by meshlink.
        struct sockaddr_storage address;///< The address information associated
        //   with this edge.
-       uint32_t options;               ///< Edge options. @TODO what are edge options?
        int weight;                     ///< Weight assigned to this edge.
 };
 
@@ -68,7 +67,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.
  */
@@ -87,9 +86,8 @@ typedef struct devtool_node_status devtool_node_status_t;
 
 /// The status of a node.
 struct devtool_node_status {
-       uint32_t options;
        uint32_t status;
-       sockaddr_t address;
+       struct sockaddr_storage address;
        uint16_t mtu;
        uint16_t minmtu;
        uint16_t maxmtu;
@@ -120,4 +118,62 @@ struct devtool_node_status {
  */
 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);
+
+/// Debug function pointer variable for set port API
+/** This function pointer variable is a userspace tracepoint or debugger callback for
+ *  set port function @a meshlink_set_port @a.
+ *  On assigning a debug function variable invokes callback when try_bind() succeeds in meshlink_set_port API.
+ *
+ */
+extern void (*devtool_trybind_probe)(void);
+
+/// Debug function pointer variable for encrypted key rotate API
+/** This function pointer variable is a userspace tracepoint or debugger callback for
+ *  encrypted key rotation function @a meshlink_encrypted_key_rotate @a.
+ *  On assigning a debug function variable invokes callback for each stage from the key rotate API.
+ *
+ *  @param stage Debug stage number.
+ */
+extern void (*devtool_keyrotate_probe)(int stage);
+
+/// Debug function pointer variable for asserting inviter/invitee committing sequence
+/** This function pointer variable is a userspace tracepoint or debugger callback which
+ *  invokes either after inviter writing invitees host file into the disk
+ *  or after invitee writing it's main config file and host config files that inviter sent into
+ *  the disk.
+ *
+ *  @param inviter_commited_first       true if inviter committed first else false if invitee committed first the other host file into the disk.
+ */
+extern void (*devtool_set_inviter_commits_first)(bool inviter_commited_first);
+
 #endif