Minor improvements

- almost irrelevant documentation updates
- introduced id_res_expired_on_delivery exception to be thrown if the
  association has expired right before it could've been used for signature
  verification.

Signed-off-by: Michael Krelin <hacker@klever.net>

2 files changed, 15 insertions, 0 deletions

diff --git a/include/opkele/consumer.h b/include/opkele/consumer.h
index 50ff692..c463787 100644
--- a/include/opkele/consumer.h
+++ b/include/opkele/consumer.h
@@ -62,16 +62,21 @@ namespace opkele {
 	     * function is not overridden in the real implementation, the new
 	     * 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.
 	     *
+	     * @note
+	     * It may be a good idea to pre-expire associations shortly before
+	     * their time is really up to avoid association expiry in the
+	     * middle of negotiations.
+	     *
 	     * @param server the OpenID server
 	     * @return the auto_ptr<> for the newly allocated association_t object
 	     * @throw failed_lookup in case of absence of the handle
 	     */
 	    virtual assoc_t find_assoc(const string& server);
 
 	    /**
 	     * retrieve the metainformation contained in link tags from the
@@ -132,16 +137,17 @@ namespace opkele {
 	     * @param pin the response parameters
 	     * @param identity the identity being checked (if not specified,
 	     * @param ext pointer to an extension(s) hooks object
 	     * extracted from the openid.identity parameter
 	     * @throw id_res_mismatch in case of signature mismatch
 	     * @throw id_res_setup in case of openid.user_setup_url failure
 	     * (supposedly checkid_immediate only)
 	     * @throw id_res_failed in case of failure
+	     * @throw id_res_expired_on_delivery if the association expired before it could've been verified
 	     * @throw exception in case of other failures
 	     */
 	    virtual void id_res(const params_t& pin,const string& identity="",extension_t *ext=0);
 	    /**
 	     * perform a check_authentication request.
 	     * @param server the OpenID server
 	     * @param p request parameters
 	     */
diff --git a/include/opkele/exception.h b/include/opkele/exception.h
index 753a818..2ff44b7 100644
--- a/include/opkele/exception.h
+++ b/include/opkele/exception.h
@@ -165,16 +165,25 @@ namespace opkele {
      */
     class id_res_mismatch : public id_res_failed {
 	public:
 	    id_res_mismatch(OPKELE_E_PARS)
 		: id_res_failed(OPKELE_E_CONS) { }
     };
 
     /**
+     * thrown if the association has expired before it could've been verified.
+     */
+    class id_res_expired_on_delivery : public id_res_failed {
+	public:
+	    id_res_expired_on_delivery(OPKELE_E_PARS)
+		: id_res_failed(OPKELE_E_CONS) { }
+    };
+
+    /**
      * openssl malfunction occured
      */
     class exception_openssl : public exception {
 	public:
 	    unsigned long _error;
 	    string _ssl_string;
 	    exception_openssl(OPKELE_E_PARS);
 	    ~exception_openssl() throw() { }