aboutsummaryrefslogtreecommitdiffstats
path: root/src/charon/encoding/payloads/traffic_selector_substructure.h
diff options
context:
space:
mode:
authorMartin Willi <martin@strongswan.org>2008-03-13 14:14:44 +0000
committerMartin Willi <martin@strongswan.org>2008-03-13 14:14:44 +0000
commit552cc11b1f017ce4962fca741f567d098f768574 (patch)
tree2835ae64c435191e04b5a265b1509c40a2e6766a /src/charon/encoding/payloads/traffic_selector_substructure.h
parent2df655134ca29f7a0b7d90ef4783f85eff1ddfd3 (diff)
downloadstrongswan-552cc11b1f017ce4962fca741f567d098f768574.tar.bz2
strongswan-552cc11b1f017ce4962fca741f567d098f768574.tar.xz
merged the modularization branch (credentials) back to trunk
Diffstat (limited to 'src/charon/encoding/payloads/traffic_selector_substructure.h')
-rw-r--r--src/charon/encoding/payloads/traffic_selector_substructure.h83
1 files changed, 32 insertions, 51 deletions
diff --git a/src/charon/encoding/payloads/traffic_selector_substructure.h b/src/charon/encoding/payloads/traffic_selector_substructure.h
index 14efccc89..1355b6599 100644
--- a/src/charon/encoding/payloads/traffic_selector_substructure.h
+++ b/src/charon/encoding/payloads/traffic_selector_substructure.h
@@ -1,10 +1,3 @@
-/**
- * @file traffic_selector_substructure.h
- *
- * @brief Interface of traffic_selector_substructure_t.
- *
- */
-
/*
* Copyright (C) 2005-2006 Martin Willi
* Copyright (C) 2005 Jan Hutter
@@ -19,8 +12,14 @@
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
+ *
+ * $Id$
*/
+/**
+ * @defgroup traffic_selector_substructure traffic_selector_substructure
+ * @{ @ingroup payloads
+ */
#ifndef TRAFFIC_SELECTOR_SUBSTRUCTURE_H_
#define TRAFFIC_SELECTOR_SUBSTRUCTURE_H_
@@ -34,21 +33,13 @@ typedef struct traffic_selector_substructure_t traffic_selector_substructure_t;
/**
* Length of a TRAFFIC SELECTOR SUBSTRUCTURE without start and end address.
- *
- * @ingroup payloads
*/
#define TRAFFIC_SELECTOR_HEADER_LENGTH 8
/**
- * @brief Class representing an IKEv2 TRAFFIC SELECTOR.
+ * Class representing an IKEv2 TRAFFIC SELECTOR.
*
* The TRAFFIC SELECTOR format is described in RFC section 3.13.1.
- *
- * @b Constructors:
- * - traffic_selector_substructure_create()
- * - traffic_selector_substructure_create_from_traffic_selector()
- *
- * @ingroup payloads
*/
struct traffic_selector_substructure_t {
/**
@@ -57,116 +48,106 @@ struct traffic_selector_substructure_t {
payload_t payload_interface;
/**
- * @brief Get the type of Traffic selector.
+ * Get the type of Traffic selector.
*
- * @param this calling traffic_selector_substructure_t object
* @return type of traffic selector
*
*/
ts_type_t (*get_ts_type) (traffic_selector_substructure_t *this);
/**
- * @brief Set the type of Traffic selector.
+ * Set the type of Traffic selector.
*
- * @param this calling traffic_selector_substructure_t object
* @param ts_type type of traffic selector
*/
- void (*set_ts_type) (traffic_selector_substructure_t *this,ts_type_t ts_type);
+ void (*set_ts_type) (traffic_selector_substructure_t *this,
+ ts_type_t ts_type);
/**
- * @brief Get the IP protocol ID of Traffic selector.
+ * Get the IP protocol ID of Traffic selector.
*
- * @param this calling traffic_selector_substructure_t object
* @return type of traffic selector
*
*/
u_int8_t (*get_protocol_id) (traffic_selector_substructure_t *this);
/**
- * @brief Set the IP protocol ID of Traffic selector
+ * Set the IP protocol ID of Traffic selector
*
- * @param this calling traffic_selector_substructure_t object
* @param protocol_id protocol ID of traffic selector
*/
- void (*set_protocol_id) (traffic_selector_substructure_t *this,u_int8_t protocol_id);
+ void (*set_protocol_id) (traffic_selector_substructure_t *this,
+ u_int8_t protocol_id);
/**
- * @brief Get the start port and address as host_t object.
+ * Get the start port and address as host_t object.
*
* Returned host_t object has to get destroyed by the caller.
*
- * @param this calling traffic_selector_substructure_t object
* @return start host as host_t object
*
*/
host_t *(*get_start_host) (traffic_selector_substructure_t *this);
/**
- * @brief Set the start port and address as host_t object.
+ * Set the start port and address as host_t object.
*
- * @param this calling traffic_selector_substructure_t object
* @param start_host start host as host_t object
*/
- void (*set_start_host) (traffic_selector_substructure_t *this,host_t *start_host);
+ void (*set_start_host) (traffic_selector_substructure_t *this,
+ host_t *start_host);
/**
- * @brief Get the end port and address as host_t object.
+ * Get the end port and address as host_t object.
*
* Returned host_t object has to get destroyed by the caller.
*
- * @param this calling traffic_selector_substructure_t object
* @return end host as host_t object
*
*/
host_t *(*get_end_host) (traffic_selector_substructure_t *this);
/**
- * @brief Set the end port and address as host_t object.
+ * Set the end port and address as host_t object.
*
- * @param this calling traffic_selector_substructure_t object
* @param end_host end host as host_t object
*/
- void (*set_end_host) (traffic_selector_substructure_t *this,host_t *end_host);
+ void (*set_end_host) (traffic_selector_substructure_t *this,
+ host_t *end_host);
/**
- * @brief Get a traffic_selector_t from this substructure.
+ * Get a traffic_selector_t from this substructure.
*
* @warning traffic_selector_t must be destroyed after usage.
*
- * @param this calling traffic_selector_substructure_t object
* @return contained traffic_selector_t
*/
- traffic_selector_t *(*get_traffic_selector) (traffic_selector_substructure_t *this);
+ traffic_selector_t *(*get_traffic_selector) (
+ traffic_selector_substructure_t *this);
/**
- * @brief Destroys an traffic_selector_substructure_t object.
- *
- * @param this traffic_selector_substructure_t object to destroy
+ * Destroys an traffic_selector_substructure_t object.
*/
void (*destroy) (traffic_selector_substructure_t *this);
};
/**
- * @brief Creates an empty traffic_selector_substructure_t object.
+ * Creates an empty traffic_selector_substructure_t object.
*
* TS type is set to default TS_IPV4_ADDR_RANGE!
*
* @return traffic_selector_substructure_t object
- *
- * @ingroup payloads
*/
traffic_selector_substructure_t *traffic_selector_substructure_create(void);
/**
- * @brief Creates an initialized traffif selector substructure using
+ * Creates an initialized traffif selector substructure using
* the values from a traffic_selector_t.
*
* @param traffic_selector traffic_selector_t to use for initialization
* @return traffic_selector_substructure_t object
- *
- * @ingroup payloads
*/
-traffic_selector_substructure_t *traffic_selector_substructure_create_from_traffic_selector(traffic_selector_t *traffic_selector);
-
+traffic_selector_substructure_t *traffic_selector_substructure_create_from_traffic_selector(
+ traffic_selector_t *traffic_selector);
-#endif /* /TRAFFIC_SELECTOR_SUBSTRUCTURE_H_ */
+#endif /* /TRAFFIC_SELECTOR_SUBSTRUCTURE_H_ @} */