Return to fast_session.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / strongswan / src / libfast

Annotation of embedaddon/strongswan/src/libfast/fast_session.h, revision 1.1.1.1

1.1       misho       1: /*
                      2:  * Copyright (C) 2007 Martin Willi
                      3:  * HSR Hochschule fuer Technik Rapperswil
                      4:  *
                      5:  * This program is free software; you can redistribute it and/or modify it
                      6:  * under the terms of the GNU General Public License as published by the
                      7:  * Free Software Foundation; either version 2 of the License, or (at your
                      8:  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
                      9:  *
                     10:  * This program is distributed in the hope that it will be useful, but
                     11:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
                     12:  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
                     13:  * for more details.
                     14:  */
                     15: 
                     16: /**
                     17:  * @defgroup fast_session fast_session
                     18:  * @{ @ingroup libfast
                     19:  */
                     20: 
                     21: #ifndef FAST_SESSION_H_
                     22: #define FAST_SESSION_H_
                     23: 
                     24: #include "fast_request.h"
                     25: #include "fast_controller.h"
                     26: #include "fast_filter.h"
                     27: 
                     28: typedef struct fast_session_t fast_session_t;
                     29: 
                     30: /**
                     31:  * Session handling class, instantiated for each user session.
                     32:  */
                     33: struct fast_session_t {
                     34: 
                     35:        /**
                     36:         * Get the session ID of the session.
                     37:         *
                     38:         * @return                              session ID
                     39:         */
                     40:        char* (*get_sid)(fast_session_t *this);
                     41: 
                     42:        /**
                     43:         * Add a controller instance to the session.
                     44:         *
                     45:         * @param controller    controller to add
                     46:         */
                     47:        void (*add_controller)(fast_session_t *this, fast_controller_t *controller);
                     48: 
                     49:        /**
                     50:         * Add a filter instance to the session.
                     51:         *
                     52:         * @param filter                filter to add
                     53:         */
                     54:        void (*add_filter)(fast_session_t *this, fast_filter_t *filter);
                     55: 
                     56:        /**
                     57:         * Process a request in this session.
                     58:         *
                     59:         * @param request               request to process
                     60:         */
                     61:        void (*process)(fast_session_t *this, fast_request_t *request);
                     62: 
                     63:        /**
                     64:         * Destroy the fast_session_t.
                     65:         */
                     66:        void (*destroy) (fast_session_t *this);
                     67: };
                     68: 
                     69: /**
                     70:  * Create a session new session.
                     71:  *
                     72:  * @param context              user defined session context instance
                     73:  * @return                             client session, NULL on error
                     74:  */
                     75: fast_session_t *fast_session_create(fast_context_t *context);
                     76: 
                     77: #endif /** SESSION_H_ @}*/