| -rw-r--r-- | include/opkele/consumer.h | 19 |
1 files changed, 18 insertions, 1 deletions
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 @@ -15,2 +15,7 @@ namespace opkele { * implementation of basic consumer functionality + * + * @note + * The consumer uses libcurl internally, which means that if you're using + * libopkele in multithreaded environment you should call curl_global_init + * yourself before spawning any threads. */ @@ -33,2 +38,8 @@ namespace opkele { * store. + * + * @note + * The user is responsible for handling associations expiry and + * this function should never return an expired or invalidated + * association. + * * @param server the OpenID server @@ -36,3 +47,3 @@ namespace opkele { * @return the autho_ptr<> for the newly allocated association_t object - * @throw failed_lookup in case of error + * @throw failed_lookup if no unexpired association found */ @@ -50,2 +61,8 @@ namespace opkele { * association will be established for each request. + * + * @note + * The user is responsible for handling associations and this + * function should never return an expired or invalidated + * association. + * * @param server the OpenID server |