diff options
| author | Youness Alaoui <youness.alaoui@collabora.co.uk> | 2009-03-31 16:14:59 -0400 |
|---|---|---|
| committer | Youness Alaoui <youness.alaoui@collabora.co.uk> | 2009-03-31 16:18:43 -0400 |
| commit | f40bf42a5bc2e180c48c48d6031826dcde902010 (patch) | |
| tree | 35dcdd0ff53469148be4afaab27f68b2079ff132 | |
| parent | b0e2f2562fe2eb802751bc06e4a7800419fa661e (diff) | |
| download | libnice-f40bf42a5bc2e180c48c48d6031826dcde902010.tar.gz | |
Fix documentation
| -rw-r--r-- | docs/reference/libnice/libnice-sections.txt | 1 | ||||
| -rw-r--r-- | stun/stunagent.h | 38 | ||||
| -rw-r--r-- | stun/stunmessage.h | 1 |
3 files changed, 22 insertions, 18 deletions
diff --git a/docs/reference/libnice/libnice-sections.txt b/docs/reference/libnice/libnice-sections.txt index 53e463f..967c16a 100644 --- a/docs/reference/libnice/libnice-sections.txt +++ b/docs/reference/libnice/libnice-sections.txt @@ -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> diff --git a/stun/stunagent.h b/stun/stunagent.h index 62ad24b..6aed2aa 100644 --- a/stun/stunagent.h +++ b/stun/stunagent.h @@ -331,24 +331,6 @@ StunValidationStatus stun_agent_validate (StunAgent *agent, StunMessage *msg, 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 * @msg: The #StunMessage to build @@ -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 */ diff --git a/stun/stunmessage.h b/stun/stunmessage.h index 948ad3f..28bbba8 100644 --- a/stun/stunmessage.h +++ b/stun/stunmessage.h @@ -445,6 +445,7 @@ typedef enum /** * STUN_MAX_MESSAGE_SIZE: + * * The Maximum size of a STUN message */ #define STUN_MAX_MESSAGE_SIZE 65552 |