diff options
Diffstat (limited to 'Source/charon/encoding/payloads/sa_payload.h')
| -rw-r--r-- | Source/charon/encoding/payloads/sa_payload.h | 38 |
1 files changed, 16 insertions, 22 deletions
diff --git a/Source/charon/encoding/payloads/sa_payload.h b/Source/charon/encoding/payloads/sa_payload.h index 7eada847c..5e5d94550 100644 --- a/Source/charon/encoding/payloads/sa_payload.h +++ b/Source/charon/encoding/payloads/sa_payload.h @@ -1,10 +1,7 @@ /** * @file sa_payload.h * - * @brief Declaration of the class sa_payload_t. - * - * An object of this type represents an IKEv2 SA-Payload and contains proposal - * substructures. + * @brief Interface of sa_payload_t. * */ @@ -32,26 +29,31 @@ #include <utils/linked_list.h> /** - * Critical flag must not be set + * Critical flag must not be set. + * + * @ingroup payloads */ #define SA_PAYLOAD_CRITICAL_FLAG FALSE; /** - * SA_PAYLOAD length in bytes without any proposal substructure + * SA_PAYLOAD length in bytes without any proposal substructure. + * + * @ingroup payloads */ #define SA_PAYLOAD_HEADER_LENGTH 4 typedef struct sa_payload_t sa_payload_t; /** - * Object representing an IKEv2-SA Payload + * Class representing an IKEv2-SA Payload. * * The SA Payload format is described in RFC section 3.3. * + * @ingroup payloads */ struct sa_payload_t { /** - * implements payload_t interface + * The payload_t interface. */ payload_t payload_interface; @@ -67,11 +69,8 @@ struct sa_payload_t { * @param this calling sa_payload_t object * @param iterator the created iterator is stored at the pointed pointer * @param[in] forward iterator direction (TRUE: front to end) - * @return - * - SUCCESS or - * - OUT_OF_RES if iterator could not be created */ - status_t (*create_proposal_substructure_iterator) (sa_payload_t *this,iterator_t **iterator, bool forward); + void (*create_proposal_substructure_iterator) (sa_payload_t *this,iterator_t **iterator, bool forward); /** * @brief Adds a proposal_substructure_t object to this object. @@ -81,29 +80,24 @@ struct sa_payload_t { * * @param this calling sa_payload_t object * @param proposal proposal_substructure_t object to add - * @return - SUCCESS if succeeded - * - FAILED otherwise */ - status_t (*add_proposal_substructure) (sa_payload_t *this,proposal_substructure_t *proposal); + void (*add_proposal_substructure) (sa_payload_t *this,proposal_substructure_t *proposal); /** * @brief Destroys an sa_payload_t object. * * @param this sa_payload_t object to destroy - * @return - * SUCCESS in any case */ - status_t (*destroy) (sa_payload_t *this); + void (*destroy) (sa_payload_t *this); }; /** * @brief Creates an empty sa_payload_t object * - * @return - * - created sa_payload_t object, or - * - NULL if failed + * @return created sa_payload_t object + * + * @ingroup payloads */ - sa_payload_t *sa_payload_create(); |