X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=TODO;h=1eb11239cc1deec53c47085a6b8d74154c72742f;hb=9e4d3c4a7b248c1e07b50108c0d99dd510178ee8;hp=3d0a7c8c637cce76437a8752f521b57bf1410fc0;hpb=ffc79bcd20b2b8085c906a446318817808bc36ae;p=meshlink

diff --git a/TODO b/TODO
index 3d0a7c8c..1eb11239 100644
--- a/TODO
+++ b/TODO
@@ -1,15 +1,53 @@
-Things left to do to make cabal superstable:
---------------------------------------------
- * Check for connection loops. Inter-daemon
-   connections should always satisfy the
-   tree property.
- * Check for duplicates. If there's a
-   timeout and a host reconnects before the
-   old connection is closed, duplicate
-   entries appear in every connection list.
- * Redundancy: multiple ConnectTo lines, if
-   one fails others might be tried.
- * Persistence: don't quit when no connection
-   can be made directly after start of the
-   daemon.
+TODO list for MeshLink
+----------------------
 
+* 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().
+
+* 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.
+
+* 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 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).
+
+* Make the headers work correctly in a C++ environment.
+
+* Add a header-only C++ wrapper API.
+
+* 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.