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/control/interfaces | |
parent | 5fc278edf3795ce7eb2ff11195797f481ede0d77 (diff) | |
download | strongswan-0ccb275a93488b46434572e0192d0d7bee2b5db3.tar.bz2 strongswan-0ccb275a93488b46434572e0192d0d7bee2b5db3.tar.xz |
added more API documentation to backends/interfaces
Diffstat (limited to 'src/charon/control/interfaces')
-rw-r--r-- | src/charon/control/interfaces/interface.h | 4 | ||||
-rw-r--r-- | src/charon/control/interfaces/stroke_interface.h | 9 |
2 files changed, 7 insertions, 6 deletions
diff --git a/src/charon/control/interfaces/interface.h b/src/charon/control/interfaces/interface.h index 1949556cc..955f4a4eb 100644 --- a/src/charon/control/interfaces/interface.h +++ b/src/charon/control/interfaces/interface.h @@ -27,6 +27,10 @@ typedef struct interface_t interface_t; /** * @brief Interface for a controller. + * + * An interface controls the daemon by calling functions on the + * interface_manager. All interfaces are manager by the interface_manager + * in a generic way, so they need their own class. * * @b Constructors: * - interface_create() of one of the modules diff --git a/src/charon/control/interfaces/stroke_interface.h b/src/charon/control/interfaces/stroke_interface.h index f189048bd..5eaa32412 100644 --- a/src/charon/control/interfaces/stroke_interface.h +++ b/src/charon/control/interfaces/stroke_interface.h @@ -28,13 +28,10 @@ typedef struct stroke_interface_t stroke_interface_t; #include <control/interfaces/interface.h> /** - * @brief Stroke is a configuration and control interface which - * allows other processes to modify charons behavior. + * @brief Simple configuration interface using unix-sockets. * - * stroke_t allows config manipulation (as whack in pluto). Configurations - * are stored in a special backend, the in-memory local_backend_t. - * Messages of type stroke_msg_t's are sent over a unix socket - * (/var/run/charon.ctl). + * Stroke is a home-brewed communication interface inspired by whack. It + * uses a unix socket (/var/run/charon.ctl). * * @b Constructors: * - stroke_create() |