changeset 95:aed4363ff77e

Few cosmetics
author Sebastien Decugis <sdecugis@nict.go.jp>
date Wed, 16 Jul 2008 18:33:09 +0900
parents 9862eceddf8d
children 0077037f269f
files include/waaad/session-api.h
diffstat 1 files changed, 5 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/include/waaad/session-api.h	Wed Jul 16 15:59:53 2008 +0900
+++ b/include/waaad/session-api.h	Wed Jul 16 18:33:09 2008 +0900
@@ -47,7 +47,7 @@
  * In case this session object is not used (details bellow), the session disappears when the message containing the AVP
  * is freed.
  *
- * A new session can also be created a the result of an explicit request (function sess_new), when a client 
+ * A new session can also be created as the result of an explicit request (function sess_new), when a client 
  * application starts a new exchange.
  *
  * Sessions objects have a reference counter. When the last reference to the session is deleted, the session is freed.
@@ -66,17 +66,17 @@
  * QUICK TUTORIAL:
  *  For an extension that wants to implement a session state machine, here is a quick guide.
  *
- * First, the extension must define a structure to save the session state, for example state_t.
+ * First, the extension must define a structure to save the session state, for example appstate_t.
  *
  * Since the extension will use the session module, it creates a sess_reg_t by calling sess_regext.
  *
  * If the extension behaves as a client, it receives external events that trig the start of a new sessions.
  * When such event occurs, the extension calls sess_new with the appropriate parameters to create a new session.
- * It initializes a state_t structure with the data of this session and creates an association with sess_data_reg (%).
+ * It initializes an appstate_t structure with the data of this session and creates an association with sess_data_reg (%).
  * Then it creates a message (application-specific) to request authentication and/or authorization for the service
  * and the message is sent.
  *
- * Later, assuming that the extension has registered appropriate callbacks in the dispater module, when a message
+ * Later, assuming that the extension has registered appropriate callbacks in the dispatcher module, when a message
  * is received, the extension can retrieve the state of the session with the sess_data_get function.
  *
  * Finaly, when the extension decides to terminate the session (timer, or as result of a message exchange), it
@@ -84,6 +84,7 @@
  * the session data is freed.
  *
  * (%) A this time, the extension must call sess_unlink in order to counter the effects of the sess_new function.
+ * This allows to have the session destroyed when no more data is associated to it.
  * 
  */
  
"Welcome to our mercurial repository"