- code cleaned up
[strongswan.git] / Source / charon / sa / child_sa.h
index da8883c..3e8a6fe 100644 (file)
 typedef struct child_sa_t child_sa_t;
 
 /**
- * @brief 
+ * @brief Represents a CHILD_SA between to hosts.
+ * 
+ * An IKE_SA must already be established.
+ * 
+ * @b Constructors:
+ *  - child_sa_create
+ * 
  * @ingroup sa
  */
 struct child_sa_t {
        
+       /**
+        * @brief Returns the SPI value of this CHILD_SA.
+        * 
+        * AH and ESP are using 4 byte SPI values.
+        * 
+        * @param this          calling object
+        * @return                      4 Byte SPI value
+        */
        u_int32_t (*get_spi) (child_sa_t *this);
 
        /**
         * @brief Destroys a child_sa.
         *
-        * @param this                          child_sa_t object
+        * @param this          calling object
         */
        void (*destroy) (child_sa_t *this);
 };
 
 /**
- * @brief 
+ * @brief Constructor to create a new CHILD_SA.
  * 
+ * @param protocol_id  protocol id (AH or ESP) of CHILD_SA
+ * @param prf_plus             prf_plus_t object use to derive shared secrets
+ * @return                             child_sa_t object
  * @ingroup sa
  */
 child_sa_t * child_sa_create(protocol_id_t protocol_id, prf_plus_t *prf_plus);