+#ifndef MESHLINK_H
+#define MESHLINK_H
+
/*
meshlink.h -- MeshLink API
- Copyright (C) 2014 Guus Sliepen <guus@meshlink.io>
+ Copyright (C) 2014, 2017 Guus Sliepen <guus@meshlink.io>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
-#ifndef MESHLINK_H
-#define MESHLINK_H
-
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#endif
/// The length in bytes of a signature made with meshlink_sign()
-#define MESHLINK_SIGLEN (64)
+#define MESHLINK_SIGLEN (64ul)
// The maximum length of fingerprints
-#define MESHLINK_FINGERPRINTLEN (64)
+#define MESHLINK_FINGERPRINTLEN (64ul)
/// A handle for an instance of MeshLink.
typedef struct meshlink_handle meshlink_handle_t;
/// A handle for a MeshLink node.
typedef struct meshlink_node meshlink_node_t;
-/// A handle for a MeshLink edge.
-typedef struct meshlink_edge meshlink_edge_t;
-
/// A handle for a MeshLink channel.
typedef struct meshlink_channel meshlink_channel_t;
#ifndef MESHLINK_INTERNAL_H
struct meshlink_handle {
- char *name; ///< Textual name of ourself. 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.
+ const char *const name; ///< Textual name of ourself. 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.
};
struct meshlink_node {
- 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.
+ const char *const 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.
};
struct meshlink_channel {
- struct meshlink_node *node; ///< Pointer to the peer of this channel.
- void *priv; ///< Private pointer which may be set freely by the application, and is never used or modified by MeshLink.
+ struct meshlink_node *const node; ///< Pointer to the peer of this channel.
+ void *priv; ///< Private pointer which may be set freely by the application, and is never used or modified by MeshLink.
};
#endif // MESHLINK_INTERNAL_H
-/// An edge in the meshlink network.
-struct meshlink_edge {
- struct meshlink_node *from; ///< Pointer to a node. Node memory is
- // owned by meshlink and should not be
- // deallocated. Node contents may be
- // changed by meshlink.
- struct meshlink_node *to; ///< Pointer to a node. Node memory is
- // owned by meshlink and should not be
- // deallocated. Node contents may be
- // 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.
-};
-
/// Get the text for the given MeshLink error code.
/** This function returns a pointer to the string containing the description of the given error code.
*
* @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, dev_class_t devclass);
+extern meshlink_handle_t *meshlink_open(const char *confbase, const char *name, const char *appname, dev_class_t devclass);
/// Start MeshLink.
/** This function causes MeshLink to open network sockets, make outgoing connections, and
*/
extern void meshlink_hint_address(meshlink_handle_t *mesh, meshlink_node_t *node, const struct sockaddr *addr);
-/// Get a list of edges.
-/** This function returns an array with copies of all known bidirectional edges.
- * The edges are copied to capture the mesh state at call time, since edges
- * mutate frequently. The nodes pointed to within the meshlink_edge_t type
- * are not copies; these are the same pointers that one would get from a call
- * to meshlink_get_all_nodes().
+/// Enable or disable zeroconf discovery of local peers
+
+/** This controls whether zeroconf discovery using the Catta library will be
+ * enabled to search for peers on the local network. By default, it is enabled.
*
- * @param mesh A handle which represents an instance of MeshLink.
- * @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.
- * ATTENTION: The pointers and values should never be modified
- * by the application!!!
- * @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.
- * 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.
- * ATTENTION: The pointers and values should never be modified
- * by the application!!!
- */
-extern meshlink_edge_t **meshlink_get_all_edges_state(meshlink_handle_t *mesh, meshlink_edge_t **edges, size_t *nmemb);
+ * @param mesh A handle which represents an instance of MeshLink.
+ * @param enable Set to true to enable discovery, false to disable.
+ */
+extern void meshlink_enable_discovery(meshlink_handle_t *mesh, bool enable);
#ifdef __cplusplus
}
#endif
-#endif // MESHLINK_H
+#endif