TODO list for MeshLink
----------------------
-Refactoring: getting rid of global variables. Ultimately, no global variables
-should be used by the library (if possible). Tinc uses quite a lot of global
-variables. Refactoring this should go into steps:
-
-* Temporarily create a global meshlink_handle_t *mesh (done)
-* Move global variables to meshlink_handle_t (partially done)
- - This means moving the declaration from the old .h file to meshlink_internal.h inside meshlink_handle_t
- - Then doing sed 's/variable/mesh->&/g' *.c -i, and running make to check for any errors
-
-After that is completed:
-
-* Add meshlink_handle_t *mesh as the first argument to functions that need it
-
-Then:
-
-* Write code for all the functions in meshlink.c (some can be moved from libmeshlink.c)
-
-Other tasks:
-
-* Use snprintf() instead of xasprintf() when generating filenames
- - Use char filename[PATH_MAX] on the stack. No more need to free().
+* meshlink_join():
+ - add checks that we only join another mesh if we did not connect to any other node before.
+ - only allow meshlink_join() when the library thread is not running.
+ - remove old host config file if the invitation gave the node a different name.
+ - how to handle nodes that are part of one mesh and want to join another?
+
+* meshlink_leave()?
+ - leaving a mesh is basically starting all over again, with new private keys?
+
+* Allow meshlink_open() to be called with a NULL name, in anticipation of meshlink_join().
+ - Do not allow meshlink_start() if no Name is set.
+
+* Add autoconf/automake stuff to call Doxygen.
+
+* Write a manual
+ - Add introduction and walkthrough how to use MeshLink in an application to
+ the doxygen manual.
+ - Explain what MeshLink does and how it should be used in the application
+ - Import examples into the manual?
+ - List possible ways of synchronisation between application and library threads
+ - simple polling
+ - pthread_cond?
+ - pipe() to signal an event loop of the application's choice
+ - whatever equivalent(s) there are on Windows
+
+Not finished but being worked on:
+---------------------------------
+
+* Provide thread-safety to functions that return pointers to meshlink_node_t.
+ - The mesh->nodes tree can be updated by the library thread at any time,
+ so it must be protected by a mutex or rwlock.
+ - Individial node_t's must never be freed or moved except in meshlink_close().
+ - Check all public API functions.
+
+* Write a test suite for the library.
+
+* Add a "channel" library to MeshLink.
+ - Support multiple TCP- and UDP-like streams between two nodes.
projects / meshlink / blobdiff