Move UTCP into the MeshLink repository.

[meshlink] / src / utcp.h

diff --git a/src/utcp.h b/src/utcp.h
new file mode 100644 (file)
index 0000000..ff509ac
--- /dev/null
+++ b/src/utcp.h
@@ -0,0 +1,125 @@
+/*
+    utcp.h -- Userspace TCP
+    Copyright (C) 2014 Guus Sliepen <guus@tinc-vpn.org>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+*/
+
+#ifndef UTCP_H
+#define UTCP_H
+
+#include <unistd.h>
+#include <stdint.h>
+#include <stdbool.h>
+// TODO: Windows
+#include <sys/time.h>
+
+#ifndef UTCP_INTERNAL
+struct utcp {
+       void *priv;
+};
+
+struct utcp_connection {
+       void *priv;
+       struct utcp *const utcp;
+       const uint32_t flags;
+};
+#else
+struct utcp;
+struct utcp_connection;
+#endif
+
+#define UTCP_SHUT_RD 0
+#define UTCP_SHUT_WR 1
+#define UTCP_SHUT_RDWR 2
+
+#define UTCP_ORDERED 1
+#define UTCP_RELIABLE 2
+#define UTCP_FRAMED 4
+#define UTCP_DROP_LATE 8
+#define UTCP_NO_PARTIAL 16
+
+#define UTCP_TCP 3
+#define UTCP_UDP 0
+
+typedef bool (*utcp_pre_accept_t)(struct utcp *utcp, uint16_t port);
+typedef void (*utcp_accept_t)(struct utcp_connection *utcp_connection, uint16_t port);
+typedef void (*utcp_retransmit_t)(struct utcp_connection *connection);
+
+typedef ssize_t (*utcp_send_t)(struct utcp *utcp, const void *data, size_t len);
+typedef ssize_t (*utcp_recv_t)(struct utcp_connection *connection, const void *data, size_t len);
+
+typedef void (*utcp_poll_t)(struct utcp_connection *connection, size_t len);
+
+extern struct utcp *utcp_init(utcp_accept_t accept, utcp_pre_accept_t pre_accept, utcp_send_t send, void *priv);
+extern void utcp_exit(struct utcp *utcp);
+
+extern struct utcp_connection *utcp_connect_ex(struct utcp *utcp, uint16_t port, utcp_recv_t recv, void *priv, uint32_t flags);
+extern struct utcp_connection *utcp_connect(struct utcp *utcp, uint16_t port, utcp_recv_t recv, void *priv);
+extern void utcp_accept(struct utcp_connection *utcp, utcp_recv_t recv, void *priv);
+extern ssize_t utcp_send(struct utcp_connection *connection, const void *data, size_t len);
+extern ssize_t utcp_recv(struct utcp *utcp, const void *data, size_t len);
+extern int utcp_close(struct utcp_connection *connection);
+extern int utcp_abort(struct utcp_connection *connection);
+extern int utcp_shutdown(struct utcp_connection *connection, int how);
+extern struct timespec utcp_timeout(struct utcp *utcp);
+extern void utcp_set_recv_cb(struct utcp_connection *connection, utcp_recv_t recv);
+extern void utcp_set_poll_cb(struct utcp_connection *connection, utcp_poll_t poll);
+extern void utcp_set_accept_cb(struct utcp *utcp, utcp_accept_t accept, utcp_pre_accept_t pre_accept);
+extern bool utcp_is_active(struct utcp *utcp);
+extern void utcp_abort_all_connections(struct utcp *utcp);
+
+// Global socket options
+
+extern int utcp_get_user_timeout(struct utcp *utcp);
+extern void utcp_set_user_timeout(struct utcp *utcp, int seconds);
+
+extern uint16_t utcp_get_mtu(struct utcp *utcp);
+extern uint16_t utcp_get_mss(struct utcp *utcp);
+extern void utcp_set_mtu(struct utcp *utcp, uint16_t mtu);
+
+extern void utcp_reset_timers(struct utcp *utcp);
+
+extern void utcp_offline(struct utcp *utcp, bool offline);
+extern void utcp_set_retransmit_cb(struct utcp *utcp, utcp_retransmit_t retransmit);
+
+// Per-socket options
+
+extern size_t utcp_get_sndbuf(struct utcp_connection *connection);
+extern void utcp_set_sndbuf(struct utcp_connection *connection, size_t size);
+extern size_t utcp_get_sndbuf_free(struct utcp_connection *connection);
+
+extern size_t utcp_get_rcvbuf(struct utcp_connection *connection);
+extern void utcp_set_rcvbuf(struct utcp_connection *connection, size_t size);
+extern size_t utcp_get_rcvbuf_free(struct utcp_connection *connection);
+
+extern size_t utcp_get_sendq(struct utcp_connection *connection);
+extern size_t utcp_get_recvq(struct utcp_connection *connection);
+
+extern bool utcp_get_nodelay(struct utcp_connection *connection);
+extern void utcp_set_nodelay(struct utcp_connection *connection, bool nodelay);
+
+extern bool utcp_get_keepalive(struct utcp_connection *connection);
+extern void utcp_set_keepalive(struct utcp_connection *connection, bool keepalive);
+
+extern size_t utcp_get_outq(struct utcp_connection *connection);
+
+extern void utcp_expect_data(struct utcp_connection *connection, bool expect);
+
+// Completely global options
+
+extern void utcp_set_clock_granularity(long granularity);
+
+#endif