Commit f40bf42a authored by Youness Alaoui's avatar Youness Alaoui
Browse files

Fix documentation

parent b0e2f256
......@@ -119,6 +119,7 @@ stun_agent_init_response
stun_agent_init_error
stun_agent_build_unknown_attributes_error
stun_agent_finish_message
stun_agent_forget_transaction
stun_debug_enable
stun_debug_disable
<SUBSECTION Private>
......
......@@ -330,24 +330,6 @@ StunValidationStatus stun_agent_validate (StunAgent *agent, StunMessage *msg,
const uint8_t *buffer, size_t buffer_len,
StunMessageIntegrityValidate validater, void * validater_data);
/**
* stun_agent_forget_transaction:
* @agent: The #StunAgent
* @id: The #StunTransactionId of the transaction to forget
*
* This function is used to make the #StunAgent forget about a previously
* created transaction. <br/>
* This function should be called when a STUN request was previously
* created with stun_agent_finish_message() and for which no response was ever
* received (timed out). The #StunAgent keeps a list of the sent transactions
* in order to validate the responses received. If the response is never received
* this will allow the #StunAgent to forget about the timed out transaction and
* free its slot for future transactions.
* Returns: %TRUE if the transaction was found, %FALSE otherwise
*/
bool stun_agent_forget_transaction (StunAgent *agent, StunTransactionId id);
/**
* stun_agent_init_request:
* @agent: The #StunAgent
......@@ -468,4 +450,24 @@ size_t stun_agent_build_unknown_attributes_error (StunAgent *agent,
size_t stun_agent_finish_message (StunAgent *agent, StunMessage *msg,
const uint8_t *key, size_t key_len);
/**
* stun_agent_forget_transaction:
* @agent: The #StunAgent
* @id: The #StunTransactionId of the transaction to forget
*
* This function is used to make the #StunAgent forget about a previously
* created transaction.
* <para>
* This function should be called when a STUN request was previously
* created with stun_agent_finish_message() and for which no response was ever
* received (timed out). The #StunAgent keeps a list of the sent transactions
* in order to validate the responses received. If the response is never received
* this will allow the #StunAgent to forget about the timed out transaction and
* free its slot for future transactions.
* </para>
* Returns: %TRUE if the transaction was found, %FALSE otherwise
*/
bool stun_agent_forget_transaction (StunAgent *agent, StunTransactionId id);
#endif /* _STUN_AGENT_H */
......@@ -445,6 +445,7 @@ typedef enum
/**
* STUN_MAX_MESSAGE_SIZE:
*
* The Maximum size of a STUN message
*/
#define STUN_MAX_MESSAGE_SIZE 65552
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment