Commit c4968e09 authored by Youness Alaoui's avatar Youness Alaoui

Fix confusing docs, addr_len is an IN and OUT variable...

parent 1a275592
...@@ -860,7 +860,8 @@ priv_add_new_candidate_discovery_stun (NiceAgent *agent, ...@@ -860,7 +860,8 @@ priv_add_new_candidate_discovery_stun (NiceAgent *agent,
stun_agent_init (&cdisco->stun_agent, STUN_ALL_KNOWN_ATTRIBUTES, stun_agent_init (&cdisco->stun_agent, STUN_ALL_KNOWN_ATTRIBUTES,
STUN_COMPATIBILITY_RFC3489, 0); STUN_COMPATIBILITY_RFC3489, 0);
nice_debug ("Agent %p : Adding new srv-rflx candidate discovery %p\n", agent, cdisco); nice_debug ("Agent %p : Adding new srv-rflx candidate discovery %p\n",
agent, cdisco);
agent->discovery_list = modified_list; agent->discovery_list = modified_list;
++agent->discovery_unsched_items; ++agent->discovery_unsched_items;
} }
......
...@@ -586,8 +586,9 @@ StunMessageReturn stun_message_find_string (const StunMessage *msg, ...@@ -586,8 +586,9 @@ StunMessageReturn stun_message_find_string (const StunMessage *msg,
* @msg: The #StunMessage * @msg: The #StunMessage
* @type: The #StunAttribute to find * @type: The #StunAttribute to find
* @addr: The #sockaddr to be filled * @addr: The #sockaddr to be filled
* @addrlen: The size of the @addr variable. Will be set to the size of the * @addrlen: The size of the @addr variable. Must be set to the size of the
* extracted socket address. * @addr socket address and will be set to the size of the extracted socket
* address.
* *
* Extracts a network address attribute from a STUN message. * Extracts a network address attribute from a STUN message.
* *
...@@ -604,7 +605,8 @@ StunMessageReturn stun_message_find_addr (const StunMessage *msg, ...@@ -604,7 +605,8 @@ StunMessageReturn stun_message_find_addr (const StunMessage *msg,
* @msg: The #StunMessage * @msg: The #StunMessage
* @type: The #StunAttribute to find * @type: The #StunAttribute to find
* @addr: The #sockaddr to be filled * @addr: The #sockaddr to be filled
* @addrlen: The size of the @addr variable. Will be set to the size of the * @addrlen: The size of the @addr variable. Must be set to the size of the
* @addr socket address and will be set to the size of the
* extracted socket address. * extracted socket address.
* *
* Extracts an obfuscated network address attribute from a STUN message. * Extracts an obfuscated network address attribute from a STUN message.
...@@ -622,7 +624,8 @@ StunMessageReturn stun_message_find_xor_addr (const StunMessage *msg, ...@@ -622,7 +624,8 @@ StunMessageReturn stun_message_find_xor_addr (const StunMessage *msg,
* @msg: The #StunMessage * @msg: The #StunMessage
* @type: The #StunAttribute to find * @type: The #StunAttribute to find
* @addr: The #sockaddr to be filled * @addr: The #sockaddr to be filled
* @addrlen: The size of the @addr variable. Will be set to the size of the * @addrlen: The size of the @addr variable. Must be set to the size of the
* @addr socket address and will be set to the size of the
* extracted socket address. * extracted socket address.
* @magic_cookie: The magic cookie to use to XOR the address. * @magic_cookie: The magic cookie to use to XOR the address.
* *
......
...@@ -101,13 +101,16 @@ size_t stun_usage_bind_create (StunAgent *agent, StunMessage *msg, ...@@ -101,13 +101,16 @@ size_t stun_usage_bind_create (StunAgent *agent, StunMessage *msg,
* @msg: The #StunMessage to process * @msg: The #StunMessage to process
* @addr: A pointer to a #sockaddr structure to fill with the mapped address * @addr: A pointer to a #sockaddr structure to fill with the mapped address
* that the STUN server gives us * that the STUN server gives us
* @addrlen: The length of @addr * @addrlen: The length of @add. rMust be set to the size of the @addr socket
* address and will be set to the actual length of the socket address.
* @alternate_server: A pointer to a #sockaddr structure to fill with the * @alternate_server: A pointer to a #sockaddr structure to fill with the
* address of an alternate server to which we should send our new STUN * address of an alternate server to which we should send our new STUN
* binding request, in case the currently used STUN server is requesting the use * binding request, in case the currently used STUN server is requesting the use
* of an alternate server. This argument will only be filled if the return value * of an alternate server. This argument will only be filled if the return value
* of the function is #STUN_USAGE_BIND_RETURN_ALTERNATE_SERVER * of the function is #STUN_USAGE_BIND_RETURN_ALTERNATE_SERVER
* @alternate_server_len: The length of @alternate_server * @alternate_server_len: The length of @alternate_server. Must be set to
* the size of the @alternate_server socket address and will be set to the
* actual length of the socket address.
* *
* Process a STUN binding response and extracts the mapped address from the STUN * Process a STUN binding response and extracts the mapped address from the STUN
* message. Also checks for the ALTERNATE-SERVER attribute. * message. Also checks for the ALTERNATE-SERVER attribute.
......
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