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   - how to handle nodes that are part of one mesh and want to join another?
  11
  12 * meshlink_leave()?
  13   - leaving a mesh is basically starting all over again, with new private keys?
  14
  15 * Allow meshlink_open() to be called with a NULL name, in anticipation of meshlink_join().
  16   - Do not allow meshlink_start() if no Name is set.
  17
  18 * Add a logging callback.
  19   - One in a meshlink_handle_t for everything that happens after meshlink_open().
  20   - Add a global one for library calls that don't involve a valid meshlink_handle_t *.
  21   - Get rid of "priority".
  22
  23 * Fill in mesh->errno whenever an error happens (= when a function returns false or NULL).
  24
  25 * Add autoconf/automake stuff to call Doxygen.
  26
  27 * Write a manual
  28   - Document API
  29   - Explain what MeshLink does and how it should be used in the application
  30   - Write simple examples for common operations
  31   - List possible ways of synchronisation between application and library threads
  32     - simple polling
  33     - pthread_cond?
  34     - pipe() to signal an event loop of the application's choice
  35     - whatever equivalent(s) there are on Windows
  36
  37 * Add a "channel" library to MeshLink.
  38   - Support multiple TCP- and UDP-like streams between two nodes.
  39
  40 * Move queue code to its own source file.
  41
  42 Not finished but being worked on:
  43 ---------------------------------
  44
  45 * Provide thread-safety to functions that return pointers to meshlink_node_t.
  46   - The mesh->nodes tree can be updated by the library thread at any time,
  47     so it must be protected by a mutex or rwlock.
  48   - Individial node_t's must never be freed or moved except in meshlink_close().
  49   - Check all public API functions.
  50
  51 * Write a test suite for the library.