wireguard-go/tun/tun.go

30 lines
903 B
Go
Raw Normal View History

2019-01-02 00:55:51 +00:00
/* SPDX-License-Identifier: MIT
2018-05-23 00:10:54 +00:00
*
* Copyright (C) 2017-2020 WireGuard LLC. All Rights Reserved.
2018-05-23 00:10:54 +00:00
*/
package tun
import (
"os"
)
2018-05-23 00:10:54 +00:00
type Event int
2018-05-23 00:10:54 +00:00
const (
EventUp = 1 << iota
EventDown
EventMTUUpdate
2018-05-23 00:10:54 +00:00
)
type Device interface {
2018-05-23 00:10:54 +00:00
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)
2019-03-21 20:43:04 +00:00
Flush() error // flush all previous writes to the device
2018-05-23 00:10:54 +00:00
MTU() (int, error) // returns the MTU of the device
Name() (string, error) // fetches and returns the current name
Events() chan Event // returns a constant channel of events related to the device
2018-05-23 00:10:54 +00:00
Close() error // stops the device and closes the event channel
}