X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=TODO;h=a7d96da6b848bcec34fa26d0665f2bd2674c14a0;hb=refs%2Fheads%2Frchannel;hp=75a92b8fc5f2bcdd06e6ae9769e8eb4cf1955aac;hpb=1243156a5e03a666b36bc4400f1402243a85c9a7;p=meshlink

diff --git a/TODO b/TODO
index 75a92b8f..a7d96da6 100644
--- a/TODO
+++ b/TODO
@@ -1,18 +1,61 @@
-* 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
+* Write meshlink_sign() and meshlink_verify(). These should just call
+  ecdsa_sign() and _verify(), with mesh->self->connection->ecdsa as the key for
+  _sign(), and node->ecdsa for _verify()?
 
-* add a digital signature to each packet, using HMAC
+* 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.
 
-* 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 a logging callback.
+  - One in a meshlink_handle_t for everything that happens after meshlink_open().
+  - Add a global one for library calls that don't involve a valid meshlink_handle_t *.
+  - Get rid of "priority".
+
+* Fill in mesh->errno whenever an error happens (= when a function returns false or NULL).
+
+* Add autoconf/automake stuff to call Doxygen.
+
+* Write a test suite for the library.
+
+* Write a manual
+  - Document API
+  - Explain what MeshLink does and how it should be used in the application
+  - Write simple examples for common operations
+  - 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
+
+* Add a "channel" library to MeshLink.
+  - Support multiple TCP- and UDP-like streams between two nodes.
+
+Mostly done:
+------------
+
+* Check for remaining global variables and get rid of them.
+
+* Write code for all the functions in meshlink.c (some can be moved from libmeshlink.c)
+  Current stubs that need implementation:
+  - meshlink_export()
+  - meshlink_import()
+  - meshlink_blacklist()
+
+* Implement a simple single producer, single consumer queue for communication
+  between the application and library threads. It is possible to do this without locks.
+
+* 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().
+
+* Make the headers work correctly in a C++ environment.
+
+* Add a header-only C++ wrapper API.
 
-* support for multiple protocols; PPTP, IPSec, NIAS, L2TP,...