diff options
author | Martin Willi <martin@strongswan.org> | 2007-04-30 10:23:01 +0000 |
---|---|---|
committer | Martin Willi <martin@strongswan.org> | 2007-04-30 10:23:01 +0000 |
commit | 0ccb275a93488b46434572e0192d0d7bee2b5db3 (patch) | |
tree | 8fb614d530fb9954d72d61c3c33bb53593cb84a6 /src/charon/config/backend_manager.h | |
parent | 5fc278edf3795ce7eb2ff11195797f481ede0d77 (diff) | |
download | strongswan-0ccb275a93488b46434572e0192d0d7bee2b5db3.tar.bz2 strongswan-0ccb275a93488b46434572e0192d0d7bee2b5db3.tar.xz |
added more API documentation to backends/interfaces
Diffstat (limited to 'src/charon/config/backend_manager.h')
-rw-r--r-- | src/charon/config/backend_manager.h | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/src/charon/config/backend_manager.h b/src/charon/config/backend_manager.h index 07cd9c541..4c00e4b13 100644 --- a/src/charon/config/backend_manager.h +++ b/src/charon/config/backend_manager.h @@ -34,12 +34,16 @@ typedef struct backend_manager_t backend_manager_t; /** - * @brief A multiplexer to use multiple backends. + * @brief A loader and multiplexer to use multiple backends. * - * Charon allows the use of multiple backend_manager backends simultaneously. To + * Charon allows the use of multiple configuration backends simultaneously. To * access all this backends by a single call, this class wraps multiple - * backends behind a single object. - * Backends may be registered and unregister at runtime dynamically. + * backends behind a single object. It is also responsible for loading + * the backend modules and cleaning them up. + * A backend may be writeable or not. All backends implement the backend_t + * interface, those who are writeable additionally implement the + * writeable_backend_t interface. Adding configs to the backend_manager will + * be redirected to the first writeable backend. * @verbatim +---------+ +-----------+ +--------------+ | @@ -106,7 +110,7 @@ struct backend_manager_t { }; /** - * @brief Create a new instance of the manager and loads all backends. + * @brief Creates a new instance of the manager and loads all backends. * * @return backend_manager instance * |