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

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