snow/wireguard-go
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

conn: add comments saying what uses these interfaces

Browse source 
Signed-off-by: David Crawshaw <crawshaw@tailscale.com>
This commit is contained in:
David Crawshaw 2020-06-22 10:40:59 +10:00
parent f28a6d244b
commit 00bcd865e6
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
conn/conn.go
View file

@ -13,6 +13,9 @@ import (
) )
// A Bind listens on a port for both IPv6 and IPv4 UDP traffic. // A Bind listens on a port for both IPv6 and IPv4 UDP traffic.
//
// A Bind interface may also be a PeekLookAtSocketFd or BindSocketToInterface,
// depending on the platform-specific implementation.
type Bind interface { type Bind interface {
// LastMark reports the last mark set for this Bind. // LastMark reports the last mark set for this Bind.
LastMark() uint32 LastMark() uint32
@ -51,14 +54,14 @@ func CreateBind(port uint16) (b Bind, actualPort uint16, err error) {
} }
// BindSocketToInterface is implemented by Bind objects that support being // BindSocketToInterface is implemented by Bind objects that support being
// tied to a single network interface. // tied to a single network interface. Used by wireguard-windows.
type BindSocketToInterface interface { type BindSocketToInterface interface {
BindSocketToInterface4(interfaceIndex uint32, blackhole bool) error BindSocketToInterface4(interfaceIndex uint32, blackhole bool) error
BindSocketToInterface6(interfaceIndex uint32, blackhole bool) error BindSocketToInterface6(interfaceIndex uint32, blackhole bool) error
} }
// PeekLookAtSocketFd is implemented by Bind objects that support having their // PeekLookAtSocketFd is implemented by Bind objects that support having their
// file descriptor peeked at. // file descriptor peeked at. Used by wireguard-android.
type PeekLookAtSocketFd interface { type PeekLookAtSocketFd interface {
PeekLookAtSocketFd4() (fd int, err error) PeekLookAtSocketFd4() (fd int, err error)
PeekLookAtSocketFd6() (fd int, err error) PeekLookAtSocketFd6() (fd int, err error)