summaryrefslogtreecommitdiffhomepage
path: root/tun/tun.go
diff options
context:
space:
mode:
Diffstat (limited to 'tun/tun.go')
-rw-r--r--tun/tun.go27
1 files changed, 27 insertions, 0 deletions
diff --git a/tun/tun.go b/tun/tun.go
new file mode 100644
index 0000000..a39ced5
--- /dev/null
+++ b/tun/tun.go
@@ -0,0 +1,27 @@
+/* SPDX-License-Identifier: GPL-2.0
+ *
+ * Copyright (C) 2017-2018 Jason A. Donenfeld <Jason@zx2c4.com>. All Rights Reserved.
+ * Copyright (C) 2017-2018 Mathias N. Hall-Andersen <mathias@hall-andersen.dk>.
+ */
+
+package tun
+
+import "os"
+
+type TUNEvent int
+
+const (
+ TUNEventUp = 1 << iota
+ TUNEventDown
+ TUNEventMTUUpdate
+)
+
+type TUNDevice interface {
+ File() *os.File // returns the file descriptor of the device
+ Read([]byte, int) (int, error) // read a packet from the device (without any additional headers)
+ Write([]byte, int) (int, error) // writes a packet to the device (without any additional headers)
+ MTU() (int, error) // returns the MTU of the device
+ Name() (string, error) // fetches and returns the current name
+ Events() chan TUNEvent // returns a constant channel of events related to the device
+ Close() error // stops the device and closes the event channel
+}