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   - remove old host config file if the invitation gave the node a different name.
   8   - how to handle nodes that are part of one mesh and want to join another?
   9
  10 * meshlink_leave()?
  11   - leaving a mesh is basically starting all over again, with new private keys?
  12
  13 * Allow meshlink_open() to be called with a NULL name, in anticipation of meshlink_join().
  14   - Do not allow meshlink_start() if no Name is set.
  15
  16 * Add autoconf/automake stuff to call Doxygen.
  17
  18 * Write a manual
  19   - Add introduction and walkthrough how to use MeshLink in an application to
  20     the doxygen manual.
  21   - Explain what MeshLink does and how it should be used in the application
  22   - Import examples into the manual?
  23   - List possible ways of synchronisation between application and library threads
  24     - simple polling
  25     - pthread_cond?
  26     - pipe() to signal an event loop of the application's choice
  27     - whatever equivalent(s) there are on Windows
  28
  29 Not finished but being worked on:
  30 ---------------------------------
  31
  32 * Provide thread-safety to functions that return pointers to meshlink_node_t.
  33   - The mesh->nodes tree can be updated by the library thread at any time,
  34     so it must be protected by a mutex or rwlock.
  35   - Individial node_t's must never be freed or moved except in meshlink_close().
  36   - Check all public API functions.
  37
  38 * Write a test suite for the library.
  39
  40 * Add a "channel" library to MeshLink.
  41   - Support multiple TCP- and UDP-like streams between two nodes.