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

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