summaryrefslogtreecommitdiffabout
path: root/include/opkele/consumer.h
authorMichael Krelin <hacker@klever.net>2007-01-12 15:23:09 (UTC)
committer Michael Krelin <hacker@klever.net>2007-01-12 15:23:09 (UTC)
commitae41407817c5e360e57e06eba656a38b32093977 (patch) (unidiff)
treece24f86960a745f6e65eaca44a555ad2da7fcfd3 /include/opkele/consumer.h
parent9caa31b962c42cf64ce03893ba616b135de12bbd (diff)
downloadlibopkele-ae41407817c5e360e57e06eba656a38b32093977.zip
libopkele-ae41407817c5e360e57e06eba656a38b32093977.tar.gz
libopkele-ae41407817c5e360e57e06eba656a38b32093977.tar.bz2
doxygen improvements
Diffstat (limited to 'include/opkele/consumer.h') (more/less context) (ignore whitespace changes)
-rw-r--r--include/opkele/consumer.h3
1 files changed, 0 insertions, 3 deletions
diff --git a/include/opkele/consumer.h b/include/opkele/consumer.h
index f32509e..fdb6119 100644
--- a/include/opkele/consumer.h
+++ b/include/opkele/consumer.h
@@ -1,78 +1,75 @@
1#ifndef __OPKELE_CONSUMER_H 1#ifndef __OPKELE_CONSUMER_H
2#define __OPKELE_CONSUMER_H 2#define __OPKELE_CONSUMER_H
3 3
4#include <opkele/types.h> 4#include <opkele/types.h>
5#include <opkele/extension.h> 5#include <opkele/extension.h>
6 6
7/** 7/**
8 * @file 8 * @file
9 * @brief OpenID consumer-side functionality 9 * @brief OpenID consumer-side functionality
10 */ 10 */
11 11
12/**
13 * @brief the main opkele namespace
14 */
15namespace opkele { 12namespace opkele {
16 13
17 /** 14 /**
18 * implementation of basic consumer functionality 15 * implementation of basic consumer functionality
19 */ 16 */
20 class consumer_t { 17 class consumer_t {
21 public: 18 public:
22 19
23 /** 20 /**
24 * store association. The function should be overridden in the real 21 * store association. The function should be overridden in the real
25 * implementation to provide persistent associations store. 22 * implementation to provide persistent associations store.
26 * @param server the OpenID server 23 * @param server the OpenID server
27 * @param handle association handle 24 * @param handle association handle
28 * @param secret the secret associated with the server and handle 25 * @param secret the secret associated with the server and handle
29 * @param expires_in the number of seconds until the handle is expired 26 * @param expires_in the number of seconds until the handle is expired
30 * @return the auto_ptr<> for the newly allocated association_t object 27 * @return the auto_ptr<> for the newly allocated association_t object
31 */ 28 */
32 virtual assoc_t store_assoc(const string& server,const string& handle,const secret_t& secret,int expires_in) = 0; 29 virtual assoc_t store_assoc(const string& server,const string& handle,const secret_t& secret,int expires_in) = 0;
33 /** 30 /**
34 * retrieve stored association. The function should be overridden 31 * retrieve stored association. The function should be overridden
35 * in the real implementation to provide persistent assocations 32 * in the real implementation to provide persistent assocations
36 * store. 33 * store.
37 * @param server the OpenID server 34 * @param server the OpenID server
38 * @param handle association handle 35 * @param handle association handle
39 * @return the autho_ptr<> for the newly allocated association_t object 36 * @return the autho_ptr<> for the newly allocated association_t object
40 * @throw failed_lookup in case of error 37 * @throw failed_lookup in case of error
41 */ 38 */
42 virtual assoc_t retrieve_assoc(const string& server,const string& handle) = 0; 39 virtual assoc_t retrieve_assoc(const string& server,const string& handle) = 0;
43 /** 40 /**
44 * invalidate stored association. The function should be overridden 41 * invalidate stored association. The function should be overridden
45 * in the real implementation of the consumer. 42 * in the real implementation of the consumer.
46 * @param server the OpenID server 43 * @param server the OpenID server
47 * @param handle association handle 44 * @param handle association handle
48 */ 45 */
49 virtual void invalidate_assoc(const string& server,const string& handle) = 0; 46 virtual void invalidate_assoc(const string& server,const string& handle) = 0;
50 /** 47 /**
51 * retrieve any unexpired association for the server. If the 48 * retrieve any unexpired association for the server. If the
52 * function is not overridden in the real implementation, the new 49 * function is not overridden in the real implementation, the new
53 * association will be established for each request. 50 * association will be established for each request.
54 * @param server the OpenID server 51 * @param server the OpenID server
55 * @return the auto_ptr<> for the newly allocated association_t object 52 * @return the auto_ptr<> for the newly allocated association_t object
56 * @throw failed_lookup in case of absence of the handle 53 * @throw failed_lookup in case of absence of the handle
57 */ 54 */
58 virtual assoc_t find_assoc(const string& server); 55 virtual assoc_t find_assoc(const string& server);
59 56
60 /** 57 /**
61 * retrieve the metainformation contained in link tags from the 58 * retrieve the metainformation contained in link tags from the
62 * page pointed by url. the function may implement caching of the 59 * page pointed by url. the function may implement caching of the
63 * information. 60 * information.
64 * @param url url to harvest for link tags 61 * @param url url to harvest for link tags
65 * @param server reference to the string object where to put 62 * @param server reference to the string object where to put
66 * openid.server value 63 * openid.server value
67 * @param delegate reference to the string object where to put the 64 * @param delegate reference to the string object where to put the
68 * openid.delegate value (if any) 65 * openid.delegate value (if any)
69 */ 66 */
70 virtual void retrieve_links(const string& url,string& server,string& delegate); 67 virtual void retrieve_links(const string& url,string& server,string& delegate);
71 68
72 /** 69 /**
73 * perform the associate request to OpenID server. 70 * perform the associate request to OpenID server.
74 * @param server the OpenID server 71 * @param server the OpenID server
75 * @return the auto_ptr<> for the newly allocated association_t 72 * @return the auto_ptr<> for the newly allocated association_t
76 * object, representing established association 73 * object, representing established association
77 * @throw exception in case of error 74 * @throw exception in case of error
78 */ 75 */