author | Michael Krelin <hacker@klever.net> | 2008-02-08 21:24:46 (UTC) |
---|---|---|
committer | Michael Krelin <hacker@klever.net> | 2008-02-08 21:24:46 (UTC) |
commit | 2e93c9940944edab87c29a2a13d60090f15fea86 (patch) (unidiff) | |
tree | 06cfab5d2c67f0937039dfe52f252f168441b300 /include/opkele/basic_op.h | |
parent | 6c82575a47283fcd7fdd0cf42b96e90a0888c58c (diff) | |
download | libopkele-2e93c9940944edab87c29a2a13d60090f15fea86.zip libopkele-2e93c9940944edab87c29a2a13d60090f15fea86.tar.gz libopkele-2e93c9940944edab87c29a2a13d60090f15fea86.tar.bz2 |
further doxygenation of basic_OP, extension_t and verify_OP
Signed-off-by: Michael Krelin <hacker@klever.net>
-rw-r--r-- | include/opkele/basic_op.h | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/include/opkele/basic_op.h b/include/opkele/basic_op.h index a0f0af0..0e3231d 100644 --- a/include/opkele/basic_op.h +++ b/include/opkele/basic_op.h | |||
@@ -1,58 +1,61 @@ | |||
1 | #ifndef __OPKELE_BASIC_OP_H | 1 | #ifndef __OPKELE_BASIC_OP_H |
2 | #define __OPKELE_BASIC_OP_H | 2 | #define __OPKELE_BASIC_OP_H |
3 | 3 | ||
4 | #include <string> | 4 | #include <string> |
5 | #include <opkele/types.h> | 5 | #include <opkele/types.h> |
6 | #include <opkele/extension.h> | 6 | #include <opkele/extension.h> |
7 | 7 | ||
8 | namespace opkele { | 8 | namespace opkele { |
9 | using std::string; | 9 | using std::string; |
10 | 10 | ||
11 | /** | ||
12 | * Implementation of basic OP functionality | ||
13 | */ | ||
11 | class basic_OP { | 14 | class basic_OP { |
12 | public: | 15 | public: |
13 | /** | 16 | /** |
14 | * The request mode for the request being processed | 17 | * The request mode for the request being processed |
15 | */ | 18 | */ |
16 | mode_t mode; | 19 | mode_t mode; |
17 | /** | 20 | /** |
18 | * association used in transaction. reset in case of dumb operation | 21 | * association used in transaction. reset in case of dumb operation |
19 | */ | 22 | */ |
20 | assoc_t assoc; | 23 | assoc_t assoc; |
21 | /** | 24 | /** |
22 | * true if the request is openid2 request | 25 | * true if the request is openid2 request |
23 | */ | 26 | */ |
24 | bool openid2; | 27 | bool openid2; |
25 | /** | 28 | /** |
26 | * The return_to RP endpoint | 29 | * The return_to RP endpoint |
27 | */ | 30 | */ |
28 | string return_to; | 31 | string return_to; |
29 | /** | 32 | /** |
30 | * The realm we authenticate for | 33 | * The realm we authenticate for |
31 | */ | 34 | */ |
32 | string realm; | 35 | string realm; |
33 | /** | 36 | /** |
34 | * Claimed identifier | 37 | * Claimed identifier |
35 | */ | 38 | */ |
36 | string claimed_id; | 39 | string claimed_id; |
37 | /** | 40 | /** |
38 | * The OP-Local identifier | 41 | * The OP-Local identifier |
39 | */ | 42 | */ |
40 | string identity; | 43 | string identity; |
41 | /** | 44 | /** |
42 | * The invalidate handle for the reply request | 45 | * The invalidate handle for the reply request |
43 | */ | 46 | */ |
44 | string invalidate_handle; | 47 | string invalidate_handle; |
45 | 48 | ||
46 | void reset_vars(); | 49 | void reset_vars(); |
47 | 50 | ||
48 | /** | 51 | /** |
49 | * @name Request information access | 52 | * @name Request information access |
50 | * Setting and retrieval of the information pertaining to the request being processed | 53 | * Setting and retrieval of the information pertaining to the request being processed |
51 | * @{ | 54 | * @{ |
52 | */ | 55 | */ |
53 | /** | 56 | /** |
54 | * Check if the RP expects us to get back to them. | 57 | * Check if the RP expects us to get back to them. |
55 | * @return true if RP supplied return_to URL | 58 | * @return true if RP supplied return_to URL |
56 | */ | 59 | */ |
57 | bool has_return_to() const; | 60 | bool has_return_to() const; |
58 | /** | 61 | /** |