author | Michael Krelin <hacker@klever.net> | 2008-02-08 21:24:46 (UTC) |
---|---|---|
committer | Michael Krelin <hacker@klever.net> | 2008-02-08 21:24:46 (UTC) |
commit | 2e93c9940944edab87c29a2a13d60090f15fea86 (patch) (side-by-side diff) | |
tree | 06cfab5d2c67f0937039dfe52f252f168441b300 /include/opkele/extension.h | |
parent | 6c82575a47283fcd7fdd0cf42b96e90a0888c58c (diff) | |
download | libopkele-2e93c9940944edab87c29a2a13d60090f15fea86.zip libopkele-2e93c9940944edab87c29a2a13d60090f15fea86.tar.gz libopkele-2e93c9940944edab87c29a2a13d60090f15fea86.tar.bz2 |
further doxygenation of basic_OP, extension_t and verify_OP
Signed-off-by: Michael Krelin <hacker@klever.net>
-rw-r--r-- | include/opkele/extension.h | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/include/opkele/extension.h b/include/opkele/extension.h index 37bcb90..38f61e3 100644 --- a/include/opkele/extension.h +++ b/include/opkele/extension.h @@ -1,61 +1,69 @@ #ifndef __OPKELE_EXTENSION_H #define __OPKELE_EXTENSION_H /** * @file * @brief extensions framework basics */ #include <opkele/opkele-config.h> #include <opkele/types.h> namespace opkele { /** * OpenID extension hooks base class */ class extension_t { public: virtual ~extension_t() { } /** * hook called by RP before submitting the message to OP. * @param om openid message to be submit */ virtual void rp_checkid_hook(basic_openid_message& om); /** * hook called by RP after verifying information received from OP. * @param om openid message received * @param sp signed part of the message */ virtual void rp_id_res_hook(const basic_openid_message& om, const basic_openid_message& sp); /** * hook called by OP after parsing incoming message * @param inm message received from RP */ virtual void op_checkid_hook(const basic_openid_message& inm); /** * hook called by OP before signing the reply to RP * @param oum message to be sent to RP */ virtual void op_id_res_hook(basic_openid_message& oum); + /** + * @name deprecated hooks, used by the deprecated consumer_t and + * server_t implementations + * @{ + */ virtual void checkid_hook(basic_openid_message& om) OPKELE_DEPRECATE; virtual void id_res_hook(const basic_openid_message& om, const basic_openid_message& sp) OPKELE_DEPRECATE; virtual void checkid_hook(const basic_openid_message& inm,basic_openid_message& oum); + /** + * @} + */ /** * Casts the object to pointer to itself. For convenient passing * of pointer. */ operator extension_t*(void) { return this; } }; } #endif /* __OPKELE_EXTENSION_H */ |