Avoid allocating packet buffers unnecessarily.

[meshlink] / TODO

diff --git a/TODO b/TODO
index 75a92b8fc5f2bcdd06e6ae9769e8eb4cf1955aac..6a51375cd83353cbfae3ed66762318b7b32fb23e 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,18 +1,41 @@
-* write better documentation
+TODO list for MeshLink
+----------------------
 
-* Adapt it to IPv6 - better yet, any protocol.
-  * this would require to base routing on MAC addresses instead of IP
-    addresses, as is done now. If this can be done, IPX is also
-    supported.
-  * let tinc assign a MAC address to the tap device, based on some
-    whacky number
+* 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?
 
-* add a digital signature to each packet, using HMAC
+* meshlink_leave()?
+  - leaving a mesh is basically starting all over again, with new private keys?
 
-* enable encryption using other ciphers (IDEA)
-  * the library is already included, but it cannot be used.
+* 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.
 
-* allow multiple outgoing links, or a list of them, so that if a host
-  is not available, that we can select another from the list.
+* Add autoconf/automake stuff to call Doxygen.
 
-* support for multiple protocols; PPTP, IPSec, NIAS, L2TP,...
+* 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.