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

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