updated some inline docs
This commit is contained in:
+4
-2
@@ -159,9 +159,11 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup states states
|
||||
* @defgroup transactions transactions
|
||||
*
|
||||
* Varius states in which an IKE SA can be.
|
||||
* Transactions represent a request/response
|
||||
* message exchange to implement the IKEv2
|
||||
* protocol exchange scenarios.
|
||||
*
|
||||
* @ingroup sa
|
||||
*/
|
||||
|
||||
+33
-1
@@ -46,7 +46,39 @@ typedef enum ike_sa_state_t ike_sa_state_t;
|
||||
|
||||
/**
|
||||
* @brief State of an IKE_SA.
|
||||
*
|
||||
*
|
||||
* An IKE_SA passes various states in its lifetime. A newly created
|
||||
* SA is in the state CREATED.
|
||||
* @verbatim
|
||||
+----------------+
|
||||
¦ SA_CREATED ¦
|
||||
+----------------+
|
||||
¦
|
||||
on initiate()---> ¦ <----- on IKE_SA_INIT received
|
||||
¦
|
||||
+----------------+
|
||||
¦ SA_CONNECTING ¦
|
||||
+----------------+
|
||||
¦
|
||||
¦ <----- on IKE_AUTH successfully completed
|
||||
¦
|
||||
+----------------+
|
||||
¦ SA_ESTABLISHED ¦
|
||||
+----------------+
|
||||
¦
|
||||
on delete()---> ¦ <----- on IKE_SA delete request received
|
||||
¦
|
||||
+----------------+
|
||||
¦ SA_DELETING ¦
|
||||
+----------------+
|
||||
¦
|
||||
¦ <----- after delete() acknowledged
|
||||
¦
|
||||
\¦/
|
||||
X
|
||||
/ \
|
||||
@endverbatim
|
||||
*
|
||||
* @ingroup sa
|
||||
*/
|
||||
enum ike_sa_state_t {
|
||||
|
||||
@@ -100,6 +100,8 @@ transaction_t *transaction_create(ike_sa_t *ike_sa, message_t *request)
|
||||
/* we do not handle rekeying of CHILD_SAs in a special
|
||||
* transaction, as the procedure is nearly equal
|
||||
* to create a new CHILD_SA. */
|
||||
transaction = (transaction_t*)create_child_sa_create(ike_sa, message_id);
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
|
||||
@@ -47,7 +47,7 @@ typedef struct transaction_t transaction_t;
|
||||
*
|
||||
* The responder must not destroy the transaction, until the
|
||||
* initiator initiates another transaction (or a number of transactions
|
||||
* > window size). This allows us to redo a transaction in case of a
|
||||
* > window size). This allows us to redo a transaction in case of a
|
||||
* message loss. The initiator can destroy the the transaction once
|
||||
* the conclude() function is called.
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user