syncthing/lib/nat/interface.go

// Copyright (C) 2015 The Syncthing Authors.
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
// You can obtain one at https://mozilla.org/MPL/2.0/.

package nat

import (
	"context"
	"net"
	"time"
)

type Protocol string

const (
	TCP Protocol = "TCP"
	UDP Protocol = "UDP"
)

type IPVersion int8

const (
	IPvAny = iota
	IPv4Only
	IPv6Only
)

type Device interface {
	ID() string
	GetLocalIPv4Address() net.IP
	AddPortMapping(ctx context.Context, protocol Protocol, internalPort, externalPort int, description string, duration time.Duration) (int, error)
	AddPinhole(ctx context.Context, protocol Protocol, addr Address, duration time.Duration) ([]net.IP, error)
	GetExternalIPv4Address(ctx context.Context) (net.IP, error)
	SupportsIPVersion(version IPVersion) bool
}