98d7ee3ce920401cd19014fe884684affc707064
[strongswan.git] / src / libfast / session.h
1 /*
2 * Copyright (C) 2007 Martin Willi
3 * 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 * $Id$
16 */
17
18 /**
19 * @defgroup session session
20 * @{ @ingroup libfast
21 */
22
23 #ifndef SESSION_H_
24 #define SESSION_H_
25
26 #include "request.h"
27 #include "controller.h"
28 #include "filter.h"
29
30 typedef struct session_t session_t;
31
32 /**
33 * Session handling class, instanciated for each user session.
34 */
35 struct session_t {
36
37 /**
38 * Get the session ID of the session.
39 *
40 * @return session ID
41 */
42 char* (*get_sid)(session_t *this);
43
44 /**
45 * Add a controller instance to the session.
46 *
47 * @param controller controller to add
48 */
49 void (*add_controller)(session_t *this, controller_t *controller);
50
51 /**
52 * @brief Add a filter instance to the session.
53 *
54 * @param filter filter to add
55 */
56 void (*add_filter)(session_t *this, filter_t *filter);
57
58 /**
59 * Process a request in this session.
60 *
61 * @param request request to process
62 */
63 void (*process)(session_t *this, request_t *request);
64
65 /**
66 * Destroy the session_t.
67 *
68 * @param this calling object
69 */
70 void (*destroy) (session_t *this);
71 };
72
73 /**
74 * Create a session new session.
75 *
76 * @param context user defined session context instance
77 */
78 session_t *session_create(context_t *context);
79
80 #endif /* SESSION_H_ @} */