X-Git-Url: http://git.meshlink.io/?p=meshlink;a=blobdiff_plain;f=TODO;h=6a51375cd83353cbfae3ed66762318b7b32fb23e;hp=7d3669d366c0a294c01d7190775e8b678b1ac520;hb=ed210eb557e7fb5edbac89ff43a573ae84a941f9;hpb=d6b77e18b58ad8f9bcd9b60864b95cd2a74482c5

diff --git a/TODO b/TODO
index 7d3669d3..6a51375c 100644
--- a/TODO
+++ b/TODO
@@ -1,23 +1,41 @@
-TODO LIST
+TODO list for MeshLink
+----------------------
 
-Goals for 1.0 release:
+* 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?
 
-* Check Solaris port
-* Check different linux architectures (x86, alpha done)
-* Store private key in a separate file (done, 1 dec 2000)
-* Sanity checks on configuration directory
-* Use efficient tree algorithms instead of linked lists (largely done)
-* Reenable queues for delayed packets
-* Merge documentation files (SECURITY, INSTALL, PROTOCOL) into tinc.texi
+* 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.
 
-Goals for future releases:
+* Add autoconf/automake stuff to call Doxygen.
 
-* Compression
-* Routing by MAC (allows for more than only IPv4)
-* Broadcast/multicast
-* Windowing, chaffing, scattering, background noise
-* ABC protocol (superscalabilty)
-* Proxy ARP
-* Eazy setup scripts (graphical?)
-* Threading
+* 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.