Only keep at most 5 Address hints.

[meshlink] / src / meshlink.h

diff --git a/src/meshlink.h b/src/meshlink.h
index 5ac1e84df7f38ff26e5e8a78bd71d77b5b80f694..be929c29e23680657e14a095064ac652b22ff66e 100644 (file)
--- a/src/meshlink.h
+++ b/src/meshlink.h
@@ -1,6 +1,9 @@
+#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
@@ -17,9 +20,6 @@
     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>
@@ -115,15 +115,15 @@ struct meshlink_channel {
 /// 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.
+       //   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.
+       //   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.
+       //   with this edge.
        uint32_t options;               ///< Edge options. @TODO what are edge options?
        int weight;                     ///< Weight assigned to this edge.
 };
@@ -166,7 +166,7 @@ extern const char *meshlink_strerror(meshlink_errno_t err);
  *  @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
@@ -702,7 +702,7 @@ extern void meshlink_set_channel_poll_cb(meshlink_handle_t *mesh, meshlink_chann
  *  @param data         A pointer to a buffer containing data to already queue for sending, or NULL if there is no data to send.
  *                      After meshlink_send() returns, the application is free to overwrite or free this buffer.
  *  @param len          The length of the data, or 0 if there is no data to send.
- *  @param flags       A bitwise-or'd combination of flags that set the semantics for this channel.
+ *  @param flags        A bitwise-or'd combination of flags that set the semantics for this channel.
  *
  *  @return             A handle for the channel, or NULL in case of an error.
  *                      The handle is valid until meshlink_channel_close() is called.
@@ -818,7 +818,7 @@ extern void meshlink_hint_address(meshlink_handle_t *mesh, meshlink_node_t *node
  *                      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 
+ *  @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
@@ -832,8 +832,18 @@ extern void meshlink_hint_address(meshlink_handle_t *mesh, meshlink_node_t *node
  */
 extern meshlink_edge_t **meshlink_get_all_edges_state(meshlink_handle_t *mesh, meshlink_edge_t **edges, size_t *nmemb);
 
+/// 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 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