diff options
| author | Linus Nordberg <linus@nordberg.se> | 2013-01-23 12:21:06 +0100 |
|---|---|---|
| committer | Linus Nordberg <linus@nordberg.se> | 2013-01-23 12:21:06 +0100 |
| commit | 0e0b4ad17c5f41392f943a845933ccb51a9126c9 (patch) | |
| tree | ed414ed8e0e7cb15f65ff35ce314ebf2056cb2ef /lib/HACKING | |
| parent | cb5f2c040965f3a48498c002cd0bdb1a016a807f (diff) | |
Add some info on usage modes.
Diffstat (limited to 'lib/HACKING')
| -rw-r--r-- | lib/HACKING | 34 |
1 files changed, 26 insertions, 8 deletions
diff --git a/lib/HACKING b/lib/HACKING index 4fc14ae..fad366a 100644 --- a/lib/HACKING +++ b/lib/HACKING @@ -10,15 +10,32 @@ make examples/client -r examples/client.conf blocking-tls; echo $? * Design of the API -- There are three usage modes - - Application use the send and receive calls (blocking mode) - - Application registers callbacks and runs the libevent dispatch - loop (a.k.a. user dispatch mode) +- There are three usage modes: + + - Application uses blocking send and receive calls (blocking + mode). This is typically fine for a simple client. + + - Application registers callbacks with libradsec and runs the + libevent dispatch loop (a.k.a. user dispatch mode). This would + probably how to implement a server or a proxy. + - Application runs its own event loop, using fd's for select and - performs I/O using the libradsec send/receive calls - (a.k.a. on-your-own mode) -- Fully reentrant -- User chooses allocation regime + performs I/O using libradsec send/receive functions + (a.k.a. on-your-own mode). Might be useful for an application + which already has an event loop that wants to add RadSec + functionality. + +- Apart from configuration and error handling, an application + shouldn't need to handle TCP and UDP connections + differently. Similarly, the use of TLS/DTLS or not shouldn't + influence the libradsec calls made by the application. + +- Configuration is done either by using the API or by pointing at a + configuration file which is parsed by libradsec. + +- Fully reentrant. + +- Application chooses allocation regime. Note that as of 0.0.2.dev libradsec suffers from way too much focus on the behaviour of a blocking client and is totally useless as a server. @@ -56,6 +73,7 @@ Details (within parentheses) apply to Debian Wheezy. - [client] server failover - [DTLS] support - [server] support +- dispatch mode and on-your-own mode * Found a bug? Please report it. That is how we improve the quality of the code. |