summaryrefslogtreecommitdiffabout
authorMichael Krelin <hacker@klever.net>2008-05-17 22:09:26 (UTC)
committer Michael Krelin <hacker@klever.net>2008-05-17 22:09:26 (UTC)
commit42a7c6597dab9147e47d25470b5218ae4c072eaf (patch) (unidiff)
tree8904f265fb2e84f6553696dea6371c532f57cd3e
parent7f314eb6b8cb6db5076ee785f59c5c52f224a897 (diff)
downloadlibopkele-42a7c6597dab9147e47d25470b5218ae4c072eaf.zip
libopkele-42a7c6597dab9147e47d25470b5218ae4c072eaf.tar.gz
libopkele-42a7c6597dab9147e47d25470b5218ae4c072eaf.tar.bz2
doxygen fixes
Signed-off-by: Michael Krelin <hacker@klever.net>
Diffstat (more/less context) (show whitespace changes)
-rw-r--r--include/opkele/basic_op.h1
-rw-r--r--include/opkele/basic_rp.h2
2 files changed, 1 insertions, 2 deletions
diff --git a/include/opkele/basic_op.h b/include/opkele/basic_op.h
index 12306dd..e4bbfa7 100644
--- a/include/opkele/basic_op.h
+++ b/include/opkele/basic_op.h
@@ -191,49 +191,48 @@ namespace opkele {
191 /** 191 /**
192 * @name Global persistent store API 192 * @name Global persistent store API
193 * These functions are related to the associations with RPs storage 193 * These functions are related to the associations with RPs storage
194 * and retrieval and nonce management. 194 * and retrieval and nonce management.
195 * @{ 195 * @{
196 */ 196 */
197 /** 197 /**
198 * Allocate association. 198 * Allocate association.
199 * @param type association type 199 * @param type association type
200 * @param kl association key length 200 * @param kl association key length
201 * @param sl true if the association is stateless 201 * @param sl true if the association is stateless
202 * @return association object 202 * @return association object
203 */ 203 */
204 virtual assoc_t alloc_assoc(const string& type,size_t kl,bool sl) = 0; 204 virtual assoc_t alloc_assoc(const string& type,size_t kl,bool sl) = 0;
205 /** 205 /**
206 * Retrieve valid unexpired association 206 * Retrieve valid unexpired association
207 * @param handle association handle 207 * @param handle association handle
208 * @return association object 208 * @return association object
209 */ 209 */
210 virtual assoc_t retrieve_assoc(const string& handle) = 0; 210 virtual assoc_t retrieve_assoc(const string& handle) = 0;
211 /** 211 /**
212 * Allocate nonce. 212 * Allocate nonce.
213 * @param nonce input-output parameter containing timestamp part of 213 * @param nonce input-output parameter containing timestamp part of
214 * the nonce on input 214 * the nonce on input
215 * @param sl true if the nonce is
216 * @return reference to nonce 215 * @return reference to nonce
217 * @throw failed_lookup if no such valid unexpired association 216 * @throw failed_lookup if no such valid unexpired association
218 * could be retrieved 217 * could be retrieved
219 */ 218 */
220 virtual string& alloc_nonce(string& nonce) = 0; 219 virtual string& alloc_nonce(string& nonce) = 0;
221 /** 220 /**
222 * Check nonce validity 221 * Check nonce validity
223 * @param nonce nonce to check 222 * @param nonce nonce to check
224 * @return true if nonce found and isn't yet invalidated 223 * @return true if nonce found and isn't yet invalidated
225 */ 224 */
226 virtual bool check_nonce(const string& nonce) = 0; 225 virtual bool check_nonce(const string& nonce) = 0;
227 /** 226 /**
228 * Invalidate nonce 227 * Invalidate nonce
229 * @param nonce nonce to check 228 * @param nonce nonce to check
230 */ 229 */
231 virtual void invalidate_nonce(const string& nonce) = 0; 230 virtual void invalidate_nonce(const string& nonce) = 0;
232 /** 231 /**
233 * @} 232 * @}
234 */ 233 */
235 234
236 /** 235 /**
237 * @name Site particulars API 236 * @name Site particulars API
238 * @{ 237 * @{
239 */ 238 */
diff --git a/include/opkele/basic_rp.h b/include/opkele/basic_rp.h
index d096e0a..ea00677 100644
--- a/include/opkele/basic_rp.h
+++ b/include/opkele/basic_rp.h
@@ -44,49 +44,49 @@ namespace opkele {
44 * @return identity 44 * @return identity
45 * @throw non_identity if request is not about identity 45 * @throw non_identity if request is not about identity
46 */ 46 */
47 const string& get_identity() const; 47 const string& get_identity() const;
48 /** 48 /**
49 * @} 49 * @}
50 */ 50 */
51 51
52 /** 52 /**
53 * @name Global persistent store API 53 * @name Global persistent store API
54 * These are functions related to the associations with OP storage 54 * These are functions related to the associations with OP storage
55 * and retrieval and nonce records. They provide an interface to 55 * and retrieval and nonce records. They provide an interface to
56 * the persistent storage which is shared by all sessions. If the 56 * the persistent storage which is shared by all sessions. If the
57 * implementor prefers the dumb mode instead, the function should 57 * implementor prefers the dumb mode instead, the function should
58 * throw dumb_RP exception instead. 58 * throw dumb_RP exception instead.
59 * @see opkele::dumb_RP 59 * @see opkele::dumb_RP
60 * @{ 60 * @{
61 */ 61 */
62 /** 62 /**
63 * Store association and return allocated association object. 63 * Store association and return allocated association object.
64 * @param OP OP endpoint 64 * @param OP OP endpoint
65 * @param handle association handle 65 * @param handle association handle
66 * @param type association type 66 * @param type association type
67 * @param secret association secret 67 * @param secret association secret
68 * @params expires_in the number of seconds association expires in 68 * @param expires_in the number of seconds association expires in
69 * @return the association object 69 * @return the association object
70 * @throw dumb_RP for dumb RP 70 * @throw dumb_RP for dumb RP
71 */ 71 */
72 virtual assoc_t store_assoc( 72 virtual assoc_t store_assoc(
73 const string& OP,const string& handle, 73 const string& OP,const string& handle,
74 const string& type,const secret_t& secret, 74 const string& type,const secret_t& secret,
75 int expires_in) = 0; 75 int expires_in) = 0;
76 /** 76 /**
77 * Find valid unexpired association with an OP. 77 * Find valid unexpired association with an OP.
78 * @param OP OP endpoint URL 78 * @param OP OP endpoint URL
79 * @return association found 79 * @return association found
80 * @throw failed_lookup if no association found 80 * @throw failed_lookup if no association found
81 * @throw dumb_RP for dumb RP 81 * @throw dumb_RP for dumb RP
82 */ 82 */
83 virtual assoc_t find_assoc( 83 virtual assoc_t find_assoc(
84 const string& OP) = 0; 84 const string& OP) = 0;
85 /** 85 /**
86 * Retrieve valid association handle for an OP by handle. 86 * Retrieve valid association handle for an OP by handle.
87 * @param OP OP endpoint URL 87 * @param OP OP endpoint URL
88 * @param handle association handle 88 * @param handle association handle
89 * @return association found 89 * @return association found
90 * @throw failed_lookup if no association found 90 * @throw failed_lookup if no association found
91 * @throw dumb_RP for dumb RP 91 * @throw dumb_RP for dumb RP
92 */ 92 */