git.meshlink.io Git - meshlink/blob - TODO

   1 TODO list for MeshLink
   2 ----------------------
   3
   4 * meshlink_join():
   5   - add checks that we only join another mesh if we did not connect to any other node before.
   6   - only allow meshlink_join() when the library thread is not running.
   7
   8 * Allow meshlink_open() to be called with a NULL name, in anticipation of meshlink_join().
   9   - Do not allow meshlink_start() if no Name is set.
  10
  11 * Add a logging callback.
  12   - One in a meshlink_handle_t for everything that happens after meshlink_open().
  13   - Add a global one for library calls that don't involve a valid meshlink_handle_t *.
  14   - Get rid of "priority".
  15
  16 * Fill in mesh->errno whenever an error happens (= when a function returns false or NULL).
  17
  18 * Add autoconf/automake stuff to call Doxygen.
  19
  20 * Write a test suite for the library.
  21
  22 * Write a manual
  23   - Document API
  24   - Explain what MeshLink does and how it should be used in the application
  25   - Write simple examples for common operations
  26   - List possible ways of synchronisation between application and library threads
  27     - simple polling
  28     - pthread_cond?
  29     - pipe() to signal an event loop of the application's choice
  30     - whatever equivalent(s) there are on Windows
  31
  32 * Add a "channel" library to MeshLink.
  33   - Support multiple TCP- and UDP-like streams between two nodes.
  34
  35 Mostly done:
  36 ------------
  37
  38 * Check for remaining global variables and get rid of them.
  39
  40 * Write code for all the functions in meshlink.c (some can be moved from libmeshlink.c)
  41   Current stubs that need implementation:
  42   - meshlink_export()
  43   - meshlink_import()
  44   - meshlink_blacklist()
  45
  46 * Implement a simple single producer, single consumer queue for communication
  47   between the application and library threads. It is possible to do this without locks.
  48
  49 * Provide thread-safety to functions that return pointers to meshlink_node_t.
  50   - The mesh->nodes tree can be updated by the library thread at any time,
  51     so it must be protected by a mutex or rwlock.
  52   - Individial node_t's must never be freed or moved except in meshlink_close().
  53
  54 * Make the headers work correctly in a C++ environment.
  55
  56 * Add a header-only C++ wrapper API.
  57