Merge branch 'mesh_topology_output' into roles

[meshlink] / src / meshlink.h

diff --git a/src/meshlink.h b/src/meshlink.h
index 404a8fdec9c308db1509aeb3de43e5b340e267ae..7cf1f4445a5e780f20472dbfdac61b5432232381 100644 (file)
--- a/src/meshlink.h
+++ b/src/meshlink.h
@@ -68,12 +68,14 @@ typedef enum {
        MESHLINK_EPEER, ///< A peer caused an error
 } meshlink_errno_t;
 
-// Device class
+/// Device class
 typedef enum {
-       BACKBONE = 1,
-       STATIONARY = 2,
-       PORTABLE = 3
-} dclass_t;
+       DEV_CLASS_BACKBONE = 0,
+       DEV_CLASS_STATIONARY = 1,
+       DEV_CLASS_PORTABLE = 2,
+       DEV_CLASS_UNKNOWN = 3,
+       _DEV_CLASS_MAX = 3
+} dev_class_t;
 
 /// A variable holding the last encountered error from MeshLink.
 /** This is a thread local variable that contains the error code of the most recent error
@@ -86,12 +88,14 @@ extern __thread meshlink_errno_t meshlink_errno;
 #ifndef MESHLINK_INTERNAL_H
 
 struct meshlink_handle {
-       const char *name;
+       char *name;
+       char *appname;
+       dev_class_t devclass;
        void *priv;
 };
 
 struct meshlink_node {
-       const char *name; ///< Textual name of this node. It is stored in a nul-terminated C string, which is allocated by MeshLink.
+       char *name;       ///< Textual name of this node. It is stored in a nul-terminated C string, which is allocated by MeshLink.
        void *priv;       ///< Private pointer which may be set freely by the application, and is never used or modified by MeshLink.
 };
 
@@ -110,9 +114,7 @@ struct meshlink_edge {
                                         //   owned by meshlink and should not be
                                         //   deallocated. Node contents may be
                                         //   changed by meshlink.
-#ifdef HAVE_STRUCT_SOCKADDR_STORAGE
        struct sockaddr_storage address;///< The address information associated
-#endif
                                        //   with this edge.
        uint32_t options;               ///< Edge options. @TODO what are edge options?
        int weight;                     ///< Weight assigned to this edge.
@@ -151,15 +153,15 @@ extern const char *meshlink_strerror(meshlink_errno_t err);
  *                  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 dclass   The device class which will be used in the mesh.
+ *  @param devclass The device class which will be used in the mesh.
  *
  *  @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 *meshlink_open(const char *confbase, const char *name, const char* appname, dclass_t dclass);
+extern meshlink_handle_t *meshlink_open(const char *confbase, const char *name, const char* appname, dev_class_t devclass);
 
 /// is used by the C++ wrapper to allocate more memory behind the handle
-extern meshlink_handle_t *meshlink_open_with_size(const char *confbase, const char *name, const char* appname, dclass_t dclass, size_t size);
+extern meshlink_handle_t *meshlink_open_with_size(const char *confbase, const char *name, const char* appname, dev_class_t devclass, size_t size);
 
 /// Start MeshLink.
 /** This function causes MeshLink to open network sockets, make outgoing connections, and
@@ -637,16 +639,31 @@ extern void meshlink_hint_address(meshlink_handle_t *mesh, meshlink_node_t *node
  *  to meshlink_get_all_nodes().
  *
  *  @param mesh         A handle which represents an instance of MeshLink.
- *  @param nmemb        A pointer to a variable that will be filled with the number
- *                     of edges in the returned array.
- *
+ *  @param edges        A pointer to a previously allocated array of pointers to
+ *                     meshlink_edge_t, or NULL in which case MeshLink will
+ *                     allocate a new array. The application CANNOT supply an
+ *                     array it allocated itself with malloc, but CAN use
+ *                     the return value from the previous call to this function
+ *                     (which is the preferred way).
+ *                      The pointers in the array are valid until meshlink_close() is called.
+ *  @param nmemb        A pointer to a variable holding the number of nodes that
+ *                     are stored in the array. In case the @a nodes @a
+ *                     argument is not NULL, MeshLink might call realloc()
+ *                     on the array to change its size.
+ *                      The contents of this variable will be changed to reflect
+ *                      the new size of the array.
+ *  
  *  @return             A pointer to an array containing pointers to all known 
  *                     edges, or NULL in case of an error.
- *                     The caller must call free() on each element of this
+ *                     If the @a edges @a argument was not NULL, then the
+ *                     retun 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.
+ *                     The caller must call free() on each element of this
  *                     array (but not the contents of said elements),
  *                     as well as the array itself when it is finished.
  */
-extern meshlink_edge_t **meshlink_get_all_edges_state(meshlink_handle_t *mesh, size_t *nmemb);
+extern meshlink_edge_t **meshlink_get_all_edges_state(meshlink_handle_t *mesh, meshlink_edge_t **edges, size_t *nmemb);
 
 #ifdef __cplusplus
 }