author | Michael Krelin <hacker@klever.net> | 2007-01-12 15:23:09 (UTC) |
---|---|---|
committer | Michael Krelin <hacker@klever.net> | 2007-01-12 15:23:09 (UTC) |
commit | ae41407817c5e360e57e06eba656a38b32093977 (patch) (side-by-side diff) | |
tree | ce24f86960a745f6e65eaca44a555ad2da7fcfd3 /include/opkele/server.h | |
parent | 9caa31b962c42cf64ce03893ba616b135de12bbd (diff) | |
download | libopkele-ae41407817c5e360e57e06eba656a38b32093977.zip libopkele-ae41407817c5e360e57e06eba656a38b32093977.tar.gz libopkele-ae41407817c5e360e57e06eba656a38b32093977.tar.bz2 |
doxygen improvements
-rw-r--r-- | include/opkele/server.h | 3 |
1 files changed, 0 insertions, 3 deletions
diff --git a/include/opkele/server.h b/include/opkele/server.h index 598eb47..e7e5bb3 100644 --- a/include/opkele/server.h +++ b/include/opkele/server.h @@ -1,78 +1,75 @@ #ifndef __OPKELE_SERVER_H #define __OPKELE_SERVER_H /** * @file * @brief OpenID server-side functionality */ #include <opkele/types.h> #include <opkele/extension.h> -/** - * @brief the main opkele namespace - */ namespace opkele { /** * implementation of basic server functionality */ class server_t { public: /** * allocate the new association. The function should be overridden * in the real implementation to provide persistent assocations * store. * @param mode the mode of request being processed to base the * statelessness of the association upon * @return the auto_ptr<> for the newly allocated association_t object */ virtual assoc_t alloc_assoc(mode_t mode) = 0; /** * retrieve the association. The function should be overridden in * the reqal implementation to provide persistent assocations * store. * @param h association handle * @return the auto_ptr<> for the newly allocated association_t object * @throw failed_lookup in case of failure */ virtual assoc_t retrieve_assoc(const string& h) = 0; /** * validate the identity. * @param assoc association object * @param pin incoming request parameters * @param identity being verified * @param trust_root presented in the request * @throw exception if identity can not be confirmed */ virtual void validate(const association_t& assoc,const params_t& pin,const string& identity,const string& trust_root) = 0; /** * process the associate request. * @param pin the incoming request parameters * @param pout the store for the response parameters */ void associate(const params_t& pin,params_t& pout); /** * process the checkid_immediate request. * @param pin the incoming request parameters * @param return_to reference to the object to store return_to url to * @param pout the response parameters * @param ext pointer to the extension hooks object * @throw exception in case of errors or negative reply */ virtual void checkid_immediate(const params_t& pin,string& return_to,params_t& pout,extension_t *ext=0); /** * process the checkid_setup request. * @param pin the incoming request parameters * @param return_to reference to the object to store return_to url to * @param pout the response parameters * @param ext pointer to the extension hooks object * @throw exception in case of errors or negative reply */ virtual void checkid_setup(const params_t& pin,string& return_to,params_t& pout,extension_t *ext=0); /** * the actual functionality behind checkid_immediate() and |