summaryrefslogtreecommitdiffabout
path: root/include
authorMichael Krelin <hacker@klever.net>2007-08-09 11:23:36 (UTC)
committer Michael Krelin <hacker@klever.net>2007-08-09 11:23:36 (UTC)
commit65bab7c9f984d6fe45ce72e7db014c40eba4d240 (patch) (unidiff)
tree28c4791aea6b7dc404ad0d27050c34f447a84314 /include
parent1f347795ef5eba50892fd777c173a2a6db1755f2 (diff)
downloadlibopkele-65bab7c9f984d6fe45ce72e7db014c40eba4d240.zip
libopkele-65bab7c9f984d6fe45ce72e7db014c40eba4d240.tar.gz
libopkele-65bab7c9f984d6fe45ce72e7db014c40eba4d240.tar.bz2
associations robustness improvements and documentation updates
Diffstat (limited to 'include') (more/less context) (show whitespace changes)
-rw-r--r--include/opkele/association.h2
-rw-r--r--include/opkele/consumer.h19
2 files changed, 20 insertions, 1 deletions
diff --git a/include/opkele/association.h b/include/opkele/association.h
index a8f3915..72eff5b 100644
--- a/include/opkele/association.h
+++ b/include/opkele/association.h
@@ -61,6 +61,8 @@ namespace opkele {
61 virtual secret_t secret() const { return _secret; } 61 virtual secret_t secret() const { return _secret; }
62 virtual int expires_in() const { return _expires-time(0); } 62 virtual int expires_in() const { return _expires-time(0); }
63 virtual bool stateless() const { return _stateless; } 63 virtual bool stateless() const { return _stateless; }
64
65 virtual bool is_expired() const { return _expires<time(0); }
64 }; 66 };
65 67
66} 68}
diff --git a/include/opkele/consumer.h b/include/opkele/consumer.h
index 042e2d1..b9d1e54 100644
--- a/include/opkele/consumer.h
+++ b/include/opkele/consumer.h
@@ -13,6 +13,11 @@ namespace opkele {
13 13
14 /** 14 /**
15 * implementation of basic consumer functionality 15 * implementation of basic consumer functionality
16 *
17 * @note
18 * The consumer uses libcurl internally, which means that if you're using
19 * libopkele in multithreaded environment you should call curl_global_init
20 * yourself before spawning any threads.
16 */ 21 */
17 class consumer_t { 22 class consumer_t {
18 public: 23 public:
@@ -31,10 +36,16 @@ namespace opkele {
31 * retrieve stored association. The function should be overridden 36 * retrieve stored association. The function should be overridden
32 * in the real implementation to provide persistent assocations 37 * in the real implementation to provide persistent assocations
33 * store. 38 * store.
39 *
40 * @note
41 * The user is responsible for handling associations expiry and
42 * this function should never return an expired or invalidated
43 * association.
44 *
34 * @param server the OpenID server 45 * @param server the OpenID server
35 * @param handle association handle 46 * @param handle association handle
36 * @return the autho_ptr<> for the newly allocated association_t object 47 * @return the autho_ptr<> for the newly allocated association_t object
37 * @throw failed_lookup in case of error 48 * @throw failed_lookup if no unexpired association found
38 */ 49 */
39 virtual assoc_t retrieve_assoc(const string& server,const string& handle) = 0; 50 virtual assoc_t retrieve_assoc(const string& server,const string& handle) = 0;
40 /** 51 /**
@@ -48,6 +59,12 @@ namespace opkele {
48 * retrieve any unexpired association for the server. If the 59 * retrieve any unexpired association for the server. If the
49 * function is not overridden in the real implementation, the new 60 * function is not overridden in the real implementation, the new
50 * association will be established for each request. 61 * association will be established for each request.
62 *
63 * @note
64 * The user is responsible for handling associations and this
65 * function should never return an expired or invalidated
66 * association.
67 *
51 * @param server the OpenID server 68 * @param server the OpenID server
52 * @return the auto_ptr<> for the newly allocated association_t object 69 * @return the auto_ptr<> for the newly allocated association_t object
53 * @throw failed_lookup in case of absence of the handle 70 * @throw failed_lookup in case of absence of the handle