source: mainline/uspace/lib/c/include/inet/tcp.h@ c124c985

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since c124c985 was b7fd2a0, checked in by Jiří Zárevúcky <zarevucky.jiri@…>, 7 years ago

Use errno_t in all uspace and kernel code.

Change type of every variable, parameter and return value that holds an
<errno.h> constant to either errno_t (the usual case), or sys_errno_t
(some places in kernel). This is for the purpose of self-documentation,
as well as for type-checking with a bit of type definition hackery.

Although this is a massive commit, it is a simple text replacement, and thus
is very easy to verify. Simply do the following:

`
git checkout <this commit's hash>
git reset HEAD
git add .
tools/srepl '\berrno_t\b' int
git add .
tools/srepl '\bsys_errno_t\b' sysarg_t
git reset
git diff
`

While this doesn't ensure that the replacements are correct, it does ensure
that the commit doesn't do anything except those replacements. Since errno_t
is typedef'd to int in the usual case (and sys_errno_t to sysarg_t), even if
incorrect, this commit cannot change behavior.
  • Property mode set to 100644
File size: 3.8 KB
RevLine 
[058edb6]1/*
[fab2746]2 * Copyright (c) 2015 Jiri Svoboda
[058edb6]3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
[bcafa70]29/** @addtogroup libc
[fab2746]30 * @{
[058edb6]31 */
32/** @file
33 */
34
[fab2746]35#ifndef LIBC_INET_TCP_H_
36#define LIBC_INET_TCP_H_
37
[779541b]38#include <fibril_synch.h>
[fab2746]39#include <inet/addr.h>
40#include <inet/endpoint.h>
41#include <inet/inet.h>
42
[779541b]43/** TCP connection */
[fab2746]44typedef struct {
[779541b]45 fibril_mutex_t lock;
46 fibril_condvar_t cv;
47 struct tcp *tcp;
48 link_t ltcp;
49 sysarg_t id;
50 struct tcp_cb *cb;
51 void *cb_arg;
52 /** Some received data available in TCP server */
53 bool data_avail;
[1d4b815]54 bool connected;
55 bool conn_failed;
56 bool conn_reset;
[fab2746]57} tcp_conn_t;
58
[779541b]59/** TCP connection listener */
[fab2746]60typedef struct {
[779541b]61 struct tcp *tcp;
62 link_t ltcp;
63 sysarg_t id;
64 struct tcp_listen_cb *lcb;
65 void *lcb_arg;
66 struct tcp_cb *cb;
67 void *cb_arg;
[fab2746]68} tcp_listener_t;
69
[779541b]70/** TCP connection callbacks */
71typedef struct tcp_cb {
[fab2746]72 void (*connected)(tcp_conn_t *);
73 void (*conn_failed)(tcp_conn_t *);
74 void (*conn_reset)(tcp_conn_t *);
75 void (*data_avail)(tcp_conn_t *);
76 void (*urg_data)(tcp_conn_t *);
77} tcp_cb_t;
78
[779541b]79/** TCP listener callbacks */
80typedef struct tcp_listen_cb {
[fab2746]81 void (*new_conn)(tcp_listener_t *, tcp_conn_t *);
82} tcp_listen_cb_t;
83
[779541b]84/** TCP service */
85typedef struct tcp {
86 /** TCP session */
87 async_sess_t *sess;
88 /** List of connections */
89 list_t conn; /* of tcp_conn_t */
90 /** List of listeners */
91 list_t listener; /* of tcp_listener_t */
[1f2b07a]92 /** TCP service lock */
93 fibril_mutex_t lock;
94 /** For waiting on cb_done */
95 fibril_condvar_t cv;
96 /** Set to @a true when callback connection handler has terminated */
97 bool cb_done;
[fab2746]98} tcp_t;
99
[b7fd2a0]100extern errno_t tcp_create(tcp_t **);
[fab2746]101extern void tcp_destroy(tcp_t *);
[b7fd2a0]102extern errno_t tcp_conn_create(tcp_t *, inet_ep2_t *, tcp_cb_t *, void *,
[fab2746]103 tcp_conn_t **);
104extern void tcp_conn_destroy(tcp_conn_t *);
105extern void *tcp_conn_userptr(tcp_conn_t *);
[b7fd2a0]106extern errno_t tcp_listener_create(tcp_t *, inet_ep_t *, tcp_listen_cb_t *, void *,
[fab2746]107 tcp_cb_t *, void *, tcp_listener_t **);
108extern void tcp_listener_destroy(tcp_listener_t *);
109extern void *tcp_listener_userptr(tcp_listener_t *);
110
[b7fd2a0]111extern errno_t tcp_conn_wait_connected(tcp_conn_t *);
112extern errno_t tcp_conn_send(tcp_conn_t *, const void *, size_t);
113extern errno_t tcp_conn_send_fin(tcp_conn_t *);
114extern errno_t tcp_conn_push(tcp_conn_t *);
115extern errno_t tcp_conn_reset(tcp_conn_t *);
[fab2746]116
[b7fd2a0]117extern errno_t tcp_conn_recv(tcp_conn_t *, void *, size_t, size_t *);
118extern errno_t tcp_conn_recv_wait(tcp_conn_t *, void *, size_t, size_t *);
[695b6ff]119
120
[058edb6]121#endif
122
123/** @}
124 */
Note: See TracBrowser for help on using the repository browser.