summaryrefslogtreecommitdiffabout
path: root/include/opkele
authorMichael Krelin <hacker@klever.net>2008-02-08 21:31:53 (UTC)
committer Michael Krelin <hacker@klever.net>2008-02-08 21:31:53 (UTC)
commitf2ba7be73a62d115f293f5d690efabcafd5fcf4f (patch) (unidiff)
treee48236090105e96d0649a95d2222a2b23ab73658 /include/opkele
parent1a4d8acd92d17ec1363886383bd171eabef2e25e (diff)
downloadlibopkele-f2ba7be73a62d115f293f5d690efabcafd5fcf4f.zip
libopkele-f2ba7be73a62d115f293f5d690efabcafd5fcf4f.tar.gz
libopkele-f2ba7be73a62d115f293f5d690efabcafd5fcf4f.tar.bz2
a bit of doxygenation for prequeue_RP
Signed-off-by: Michael Krelin <hacker@klever.net>
Diffstat (limited to 'include/opkele') (more/less context) (ignore whitespace changes)
-rw-r--r--include/opkele/prequeue_rp.h9
1 files changed, 8 insertions, 1 deletions
diff --git a/include/opkele/prequeue_rp.h b/include/opkele/prequeue_rp.h
index b98dd5a..68fe03d 100644
--- a/include/opkele/prequeue_rp.h
+++ b/include/opkele/prequeue_rp.h
@@ -3,24 +3,27 @@
3 3
4#include <string> 4#include <string>
5#include <set> 5#include <set>
6#include <iterator> 6#include <iterator>
7#include <opkele/basic_rp.h> 7#include <opkele/basic_rp.h>
8 8
9namespace opkele { 9namespace opkele {
10 using std::string; 10 using std::string;
11 using std::set; 11 using std::set;
12 using std::iterator; 12 using std::iterator;
13 using std::output_iterator_tag; 13 using std::output_iterator_tag;
14 14
15 /**
16 * discovery-enabled RP implementation, prequeueing discovered endpoints
17 */
15 class prequeue_RP : public basic_RP { 18 class prequeue_RP : public basic_RP {
16 public: 19 public:
17 /** 20 /**
18 * @name Session persistent store API 21 * @name Session persistent store API
19 * @{ 22 * @{
20 */ 23 */
21 /** 24 /**
22 * Called before queueing discovered endpoints. Typically happens 25 * Called before queueing discovered endpoints. Typically happens
23 * while initiating authentication session. 26 * while initiating authentication session.
24 * @see queue_endpoint() 27 * @see queue_endpoint()
25 * @see end_queueing() 28 * @see end_queueing()
26 */ 29 */
@@ -57,25 +60,29 @@ namespace opkele {
57 * implementation doesn't use it. 60 * implementation doesn't use it.
58 * @return the normalized identity 61 * @return the normalized identity
59 */ 62 */
60 virtual const string get_normalized_id() const; 63 virtual const string get_normalized_id() const;
61 /** 64 /**
62 * @} 65 * @}
63 */ 66 */
64 67
65 /** 68 /**
66 * @name Actions 69 * @name Actions
67 * @{ 70 * @{
68 */ 71 */
72 /**
73 * In addition to base class implementation it does endpoints
74 * discovery and queueing
75 * @param usi User-suppled identifier
76 */
69 void initiate(const string& usi); 77 void initiate(const string& usi);
70
71 /** 78 /**
72 * @} 79 * @}
73 */ 80 */
74 81
75 void verify_OP(const string& OP, 82 void verify_OP(const string& OP,
76 const string& claimed_id,const string& identity) const; 83 const string& claimed_id,const string& identity) const;
77 }; 84 };
78 85
79} 86}
80 87
81#endif /* __OPKELE_RP_H */ 88#endif /* __OPKELE_RP_H */