]> git.meshlink.io Git - meshlink/blobdiff - TODO
Check whether IP_MTU is defined.
[meshlink] / TODO
diff --git a/TODO b/TODO
index 68746e1b6ac54a36317f8f81ff71ef972690d3d4..6a51375cd83353cbfae3ed66762318b7b32fb23e 100644 (file)
--- a/TODO
+++ b/TODO
@@ -4,54 +4,38 @@ TODO list for MeshLink
 * 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 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
+  - 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
-  - Write simple examples for common operations
+  - 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
 
-* 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.
+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.
 
-* Make the headers work correctly in a C++ environment.
-
-* Add a header-only C++ wrapper API.
+* Write a test suite for the library.
 
+* Add a "channel" library to MeshLink.
+  - Support multiple TCP- and UDP-like streams between two nodes.