-rw-r--r-- | include/opkele/consumer.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/include/opkele/consumer.h b/include/opkele/consumer.h index c463787..3c1d318 100644 --- a/include/opkele/consumer.h +++ b/include/opkele/consumer.h | |||
@@ -18,33 +18,33 @@ namespace opkele { | |||
18 | * The consumer uses libcurl internally, which means that if you're using | 18 | * The consumer uses libcurl internally, which means that if you're using |
19 | * libopkele in multithreaded environment you should call curl_global_init | 19 | * libopkele in multithreaded environment you should call curl_global_init |
20 | * yourself before spawning any threads. | 20 | * yourself before spawning any threads. |
21 | */ | 21 | */ |
22 | class consumer_t { | 22 | class consumer_t { |
23 | public: | 23 | public: |
24 | 24 | ||
25 | virtual ~consumer_t() { } | 25 | virtual ~consumer_t() { } |
26 | 26 | ||
27 | /** | 27 | /** |
28 | * store association. The function should be overridden in the real | 28 | * store association. The function should be overridden in the real |
29 | * implementation to provide persistent associations store. | 29 | * implementation to provide persistent associations store. |
30 | * @param server the OpenID server | 30 | * @param server the OpenID server |
31 | * @param handle association handle | 31 | * @param handle association handle |
32 | * @param secret the secret associated with the server and handle | 32 | * @param secret the secret associated with the server and handle |
33 | * @param expires_in the number of seconds until the handle is expired | 33 | * @param expires_in the number of seconds until the handle is expired |
34 | * @return the auto_ptr<> for the newly allocated association_t object | 34 | * @return the assoc_t for the newly allocated association_t object |
35 | */ | 35 | */ |
36 | virtual assoc_t store_assoc(const string& server,const string& handle,const secret_t& secret,int expires_in) = 0; | 36 | virtual assoc_t store_assoc(const string& server,const string& handle,const secret_t& secret,int expires_in) = 0; |
37 | /** | 37 | /** |
38 | * retrieve stored association. The function should be overridden | 38 | * retrieve stored association. The function should be overridden |
39 | * in the real implementation to provide persistent assocations | 39 | * in the real implementation to provide persistent assocations |
40 | * store. | 40 | * store. |
41 | * | 41 | * |
42 | * @note | 42 | * @note |
43 | * The user is responsible for handling associations expiry and | 43 | * The user is responsible for handling associations expiry and |
44 | * this function should never return an expired or invalidated | 44 | * this function should never return an expired or invalidated |
45 | * association. | 45 | * association. |
46 | * | 46 | * |
47 | * @param server the OpenID server | 47 | * @param server the OpenID server |
48 | * @param handle association handle | 48 | * @param handle association handle |
49 | * @return the autho_ptr<> for the newly allocated association_t object | 49 | * @return the autho_ptr<> for the newly allocated association_t object |
50 | * @throw failed_lookup if no unexpired association found | 50 | * @throw failed_lookup if no unexpired association found |
@@ -60,53 +60,53 @@ namespace opkele { | |||
60 | /** | 60 | /** |
61 | * retrieve any unexpired association for the server. If the | 61 | * retrieve any unexpired association for the server. If the |
62 | * function is not overridden in the real implementation, the new | 62 | * function is not overridden in the real implementation, the new |
63 | * association will be established for each request. | 63 | * association will be established for each request. |
64 | * | 64 | * |
65 | * @note | 65 | * @note |
66 | * The user is responsible for handling associations and this | 66 | * The user is responsible for handling associations and this |
67 | * function should never return an expired or invalidated | 67 | * function should never return an expired or invalidated |
68 | * association. | 68 | * association. |
69 | * | 69 | * |
70 | * @note | 70 | * @note |
71 | * It may be a good idea to pre-expire associations shortly before | 71 | * It may be a good idea to pre-expire associations shortly before |
72 | * their time is really up to avoid association expiry in the | 72 | * their time is really up to avoid association expiry in the |
73 | * middle of negotiations. | 73 | * middle of negotiations. |
74 | * | 74 | * |
75 | * @param server the OpenID server | 75 | * @param server the OpenID server |
76 | * @return the auto_ptr<> for the newly allocated association_t object | 76 | * @return the assoc_t for the newly allocated association_t object |
77 | * @throw failed_lookup in case of absence of the handle | 77 | * @throw failed_lookup in case of absence of the handle |
78 | */ | 78 | */ |
79 | virtual assoc_t find_assoc(const string& server); | 79 | virtual assoc_t find_assoc(const string& server); |
80 | 80 | ||
81 | /** | 81 | /** |
82 | * retrieve the metainformation contained in link tags from the | 82 | * retrieve the metainformation contained in link tags from the |
83 | * page pointed by url. the function may implement caching of the | 83 | * page pointed by url. the function may implement caching of the |
84 | * information. | 84 | * information. |
85 | * @param url url to harvest for link tags | 85 | * @param url url to harvest for link tags |
86 | * @param server reference to the string object where to put | 86 | * @param server reference to the string object where to put |
87 | * openid.server value | 87 | * openid.server value |
88 | * @param delegate reference to the string object where to put the | 88 | * @param delegate reference to the string object where to put the |
89 | * openid.delegate value (if any) | 89 | * openid.delegate value (if any) |
90 | */ | 90 | */ |
91 | virtual void retrieve_links(const string& url,string& server,string& delegate); | 91 | virtual void retrieve_links(const string& url,string& server,string& delegate); |
92 | 92 | ||
93 | /** | 93 | /** |
94 | * perform the associate request to OpenID server. | 94 | * perform the associate request to OpenID server. |
95 | * @param server the OpenID server | 95 | * @param server the OpenID server |
96 | * @return the auto_ptr<> for the newly allocated association_t | 96 | * @return the assoc_t for the newly allocated association_t |
97 | * object, representing established association | 97 | * object, representing established association |
98 | * @throw exception in case of error | 98 | * @throw exception in case of error |
99 | */ | 99 | */ |
100 | assoc_t associate(const string& server); | 100 | assoc_t associate(const string& server); |
101 | /** | 101 | /** |
102 | * prepare the parameters for the checkid_immediate | 102 | * prepare the parameters for the checkid_immediate |
103 | * request. | 103 | * request. |
104 | * @param identity the identity to verify | 104 | * @param identity the identity to verify |
105 | * @param return_to the return_to url to pass with the request | 105 | * @param return_to the return_to url to pass with the request |
106 | * @param trust_root the trust root to advertise with the request | 106 | * @param trust_root the trust root to advertise with the request |
107 | * @param ext pointer to an extension(s) hooks object | 107 | * @param ext pointer to an extension(s) hooks object |
108 | * @return the location string | 108 | * @return the location string |
109 | * @throw exception in case of error | 109 | * @throw exception in case of error |
110 | */ | 110 | */ |
111 | virtual string checkid_immediate(const string& identity,const string& return_to,const string& trust_root="",extension_t *ext=0); | 111 | virtual string checkid_immediate(const string& identity,const string& return_to,const string& trust_root="",extension_t *ext=0); |
112 | /** | 112 | /** |