kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-26 06:53:52 +01:00
Code Releases Activity

fixup! sock: Introduction of new application layer API

Browse Source 
Reword confusing out-parameter doc in create functions
This commit is contained in:
Martine Lenders 2016-08-20 02:39:51 +02:00
parent 278f046d1d
commit a41bc13767
3 changed files with 5 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
sys/include/net/sock/ip.h
View File

@ -71,8 +71,7 @@ typedef struct sock_ip sock_ip_t;
*
* @pre `(sock != NULL)`
*
* @param[out] sock Preallocated sock object. Must fill the size of
* the stack-specific sock descriptor.
* @param[out] sock The resulting sock object.
* @param[in] local Local end point for the sock object.
* May be NULL to solicit implicit bind on
* @ref sock_ip_send().

10
sys/include/net/sock/tcp.h
View File

@ -62,8 +62,7 @@ typedef struct sock_tcp_queue sock_tcp_queue_t;
* @pre `remote != NULL`
* @pre `local_port != 0`
*
* @param[out] sock Preallocated sock object. Must fill the size of
* the stack-specific sock descriptor.
* @param[out] sock The resulting sock object.
* @param[in] remote Remote end point for the sock object.
* @param[in] flags Flags for the sock object. See also @ref net_sock_flags.
* May be 0.
@ -89,12 +88,9 @@ int sock_tcp_connect(sock_tcp_t *sock, const sock_tcp_ep_t *remote,
/**
* @brief Listen for an incoming connection request on @p local end point
*
* @param[in] queue Preallocated listening queue object. Must fill the
* size of the stack-specific queue descriptor.
* @param[in] queue The resulting listening queue.
* @param[in] remote Local end point to listen on.
* @param[in] queue_array Preallocated array of sock objects. Each sock object
* must fill the size of the stack-specific sock
* descriptor.
* @param[in] queue_array Array of sock objects.
* @param[in] queue_len Length of @p queue_array.
* @param[in] flags Flags for the listening queue. See also
* @ref net_sock_flags. May be 0.

3
sys/include/net/sock/udp.h
View File

@ -55,8 +55,7 @@ typedef struct sock_udp sock_udp_t;
* @pre `(local == NULL) || (local->port != 0)`
* @pre `(remote == NULL) || (remote->port != 0)`
*
* @param[out] sock Preallocated sock object. Must fill the size of the
* stack-specific sock descriptor.
* @param[out] sock The resulting sock object.
* @param[in] local Local end point for the sock object.
* May be `NULL` to solicit implicit bind on
* @ref sock_udp_send().