summaryrefslogtreecommitdiffabout
path: root/include/opkele/types.h
Unidiff
Diffstat (limited to 'include/opkele/types.h') (more/less context) (show whitespace changes)
-rw-r--r--include/opkele/types.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/include/opkele/types.h b/include/opkele/types.h
index 757c0af..8f4bf73 100644
--- a/include/opkele/types.h
+++ b/include/opkele/types.h
@@ -74,48 +74,53 @@ namespace opkele {
74 * retrieve the association handle. 74 * retrieve the association handle.
75 * @return handle 75 * @return handle
76 */ 76 */
77 virtual string handle() const = 0; 77 virtual string handle() const = 0;
78 /** 78 /**
79 * retrieve the association type. 79 * retrieve the association type.
80 * @return association type 80 * @return association type
81 */ 81 */
82 virtual string assoc_type() const = 0; 82 virtual string assoc_type() const = 0;
83 /** 83 /**
84 * retrieve the association secret. 84 * retrieve the association secret.
85 * @return association secret 85 * @return association secret
86 */ 86 */
87 virtual secret_t secret() const = 0; 87 virtual secret_t secret() const = 0;
88 /** 88 /**
89 * retrieve the number of seconds the association expires in. 89 * retrieve the number of seconds the association expires in.
90 * @return seconds till expiration 90 * @return seconds till expiration
91 */ 91 */
92 virtual int expires_in() const = 0; 92 virtual int expires_in() const = 0;
93 /** 93 /**
94 * check whether the association is stateless. 94 * check whether the association is stateless.
95 * @return true if stateless 95 * @return true if stateless
96 */ 96 */
97 virtual bool stateless() const = 0; 97 virtual bool stateless() const = 0;
98 /**
99 * check whether the association is expired.
100 * @return true if expired
101 */
102 virtual bool is_expired() const = 0;
98 }; 103 };
99 104
100 /** 105 /**
101 * the auto_ptr<> for association_t object type 106 * the auto_ptr<> for association_t object type
102 */ 107 */
103 typedef auto_ptr<association_t> assoc_t; 108 typedef auto_ptr<association_t> assoc_t;
104 109
105 /** 110 /**
106 * request/response parameters map 111 * request/response parameters map
107 */ 112 */
108 class params_t : public map<string,string> { 113 class params_t : public map<string,string> {
109 public: 114 public:
110 115
111 /** 116 /**
112 * check whether the parameter is present. 117 * check whether the parameter is present.
113 * @param n the parameter name 118 * @param n the parameter name
114 * @return true if yes 119 * @return true if yes
115 */ 120 */
116 bool has_param(const string& n) const; 121 bool has_param(const string& n) const;
117 /** 122 /**
118 * retrieve the parameter (const version) 123 * retrieve the parameter (const version)
119 * @param n the parameter name 124 * @param n the parameter name
120 * @return the parameter value 125 * @return the parameter value
121 * @throw failed_lookup if there is no such parameter 126 * @throw failed_lookup if there is no such parameter