2 utcp.h -- Userspace TCP
3 Copyright (C) 2014 Guus Sliepen <guus@tinc-vpn.org>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
34 struct utcp_connection {
36 struct utcp *const utcp;
41 struct utcp_connection;
44 #define UTCP_SHUT_RD 0
45 #define UTCP_SHUT_WR 1
46 #define UTCP_SHUT_RDWR 2
48 #define UTCP_ORDERED 1
49 #define UTCP_RELIABLE 2
51 #define UTCP_DROP_LATE 8
52 #define UTCP_NO_PARTIAL 16
57 typedef bool (*utcp_pre_accept_t)(struct utcp *utcp, uint16_t port);
58 typedef void (*utcp_accept_t)(struct utcp_connection *utcp_connection, uint16_t port);
59 typedef void (*utcp_retransmit_t)(struct utcp_connection *connection);
61 typedef ssize_t (*utcp_send_t)(struct utcp *utcp, const void *data, size_t len);
62 typedef ssize_t (*utcp_recv_t)(struct utcp_connection *connection, const void *data, size_t len);
64 typedef void (*utcp_poll_t)(struct utcp_connection *connection, size_t len);
66 struct utcp *utcp_init(utcp_accept_t accept, utcp_pre_accept_t pre_accept, utcp_send_t send, void *priv);
67 void utcp_exit(struct utcp *utcp);
69 struct utcp_connection *utcp_connect_ex(struct utcp *utcp, uint16_t port, utcp_recv_t recv, void *priv, uint32_t flags);
70 struct utcp_connection *utcp_connect(struct utcp *utcp, uint16_t port, utcp_recv_t recv, void *priv);
71 void utcp_accept(struct utcp_connection *utcp, utcp_recv_t recv, void *priv);
72 ssize_t utcp_send(struct utcp_connection *connection, const void *data, size_t len);
73 ssize_t utcp_recv(struct utcp *utcp, const void *data, size_t len);
74 int utcp_close(struct utcp_connection *connection);
75 int utcp_abort(struct utcp_connection *connection);
76 int utcp_shutdown(struct utcp_connection *connection, int how);
77 struct timespec utcp_timeout(struct utcp *utcp);
78 void utcp_set_recv_cb(struct utcp_connection *connection, utcp_recv_t recv);
79 void utcp_set_poll_cb(struct utcp_connection *connection, utcp_poll_t poll);
80 void utcp_set_accept_cb(struct utcp *utcp, utcp_accept_t accept, utcp_pre_accept_t pre_accept);
81 bool utcp_is_active(struct utcp *utcp);
82 void utcp_abort_all_connections(struct utcp *utcp);
84 // Global socket options
86 int utcp_get_user_timeout(struct utcp *utcp);
87 void utcp_set_user_timeout(struct utcp *utcp, int seconds);
89 int utcp_get_flush_timeout(struct utcp *utcp);
90 void utcp_set_flush_timeout(struct utcp *utcp, int milliseconds);
92 uint16_t utcp_get_mtu(struct utcp *utcp);
93 uint16_t utcp_get_mss(struct utcp *utcp);
94 void utcp_set_mtu(struct utcp *utcp, uint16_t mtu);
96 void utcp_reset_timers(struct utcp *utcp);
98 void utcp_offline(struct utcp *utcp, bool offline);
99 void utcp_set_retransmit_cb(struct utcp *utcp, utcp_retransmit_t retransmit);
101 // Per-socket options
103 size_t utcp_get_sndbuf(struct utcp_connection *connection);
104 void utcp_set_sndbuf(struct utcp_connection *connection, size_t size);
105 size_t utcp_get_sndbuf_free(struct utcp_connection *connection);
107 size_t utcp_get_rcvbuf(struct utcp_connection *connection);
108 void utcp_set_rcvbuf(struct utcp_connection *connection, size_t size);
109 size_t utcp_get_rcvbuf_free(struct utcp_connection *connection);
111 size_t utcp_get_sendq(struct utcp_connection *connection);
112 size_t utcp_get_recvq(struct utcp_connection *connection);
114 bool utcp_get_nodelay(struct utcp_connection *connection);
115 void utcp_set_nodelay(struct utcp_connection *connection, bool nodelay);
117 bool utcp_get_keepalive(struct utcp_connection *connection);
118 void utcp_set_keepalive(struct utcp_connection *connection, bool keepalive);
120 size_t utcp_get_outq(struct utcp_connection *connection);
122 void utcp_expect_data(struct utcp_connection *connection, bool expect);
124 // Completely global options
126 void utcp_set_clock_granularity(long granularity);