riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #16743 from benpicco/net/sock/tcp-doc_fix

Browse Source 
sock: tcp: fix sock_tcp_read() example
This commit is contained in:
benpicco 2021-09-22 20:58:49 +02:00 committed by GitHub
commit b1af25d4c6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -55,7 +55,7 @@
* while (read_res >= 0) { * while (read_res >= 0) {
* read_res = sock_tcp_read(sock, &buf, sizeof(buf), * read_res = sock_tcp_read(sock, &buf, sizeof(buf),
* SOCK_NO_TIMEOUT); * SOCK_NO_TIMEOUT);
* if (read_res < 0) { * if (read_res <= 0) {
* puts("Disconnected"); * puts("Disconnected");
* break; * break;
* } * }
@ -153,7 +153,7 @@
* while (read_res >= 0) { * while (read_res >= 0) {
* read_res = sock_tcp_read(sock, &buf, sizeof(buf), * read_res = sock_tcp_read(sock, &buf, sizeof(buf),
* SOCK_NO_TIMEOUT); * SOCK_NO_TIMEOUT);
* if (read_res < 0) { * if (read_res <= 0) {
* puts("Disconnected"); * puts("Disconnected");
* break; * break;
* } * }
@ -216,7 +216,7 @@
* } * }
* else { * else {
* if ((res = sock_tcp_read(&sock, &buf, sizeof(buf), * if ((res = sock_tcp_read(&sock, &buf, sizeof(buf),
* SOCK_NO_TIMEOUT)) < 0) { * SOCK_NO_TIMEOUT)) <= 0) {
* puts("Disconnected"); * puts("Disconnected");
* } * }
* printf("Read: \""); * printf("Read: \"");
@ -271,7 +271,7 @@
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.c} * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.c}
* else { * else {
* if ((res = sock_tcp_read(&sock, &buf, sizeof(buf), * if ((res = sock_tcp_read(&sock, &buf, sizeof(buf),
* SOCK_NO_TIMEOUT)) < 0) { * SOCK_NO_TIMEOUT)) <= 0) {
* puts("Disconnected"); * puts("Disconnected");
* } * }
* printf("Read: \""); * printf("Read: \"");
@ -505,7 +505,8 @@ int sock_tcp_accept(sock_tcp_queue_t *queue, sock_tcp_t **sock,
* @note Function may block. * @note Function may block.
* *
* @return The number of bytes read on success. * @return The number of bytes read on success.
* @return 0, if no read data is available, but everything is in order. * @return 0, if no read data is available or the connection was orderly closed
* by the remote host.
* @return -EAGAIN, if @p timeout is `0` and no data is available. * @return -EAGAIN, if @p timeout is `0` and no data is available.
* @return -ECONNABORTED, if the connection is aborted while waiting for the * @return -ECONNABORTED, if the connection is aborted while waiting for the
* next data. * next data.