pnet

package

v0.3.0 Latest Latest Go to latest Published: Sep 24, 2023 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/contextualist/acp

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

func AddPortMapping(ctx context.Context, ports ...int) error
func DialContext(ctx context.Context, network, laddr, raddr string) (net.Conn, error)
func Listen(ctx context.Context, network, address string) (net.Listener, error)
func ListenPacket(ctx context.Context, network, address string) (net.PacketConn, error)
func RendezvousWithTimeout(ctx context.Context, laddr string, peerAddrs []AddrPair) (conn net.Conn, err error)
func SetLogger(l Logger)
type AddrPair
type HTTPClient
- func NewHTTPClient(useIpv6 bool, laddr string) *HTTPClient
- func (cl *HTTPClient) GetLAddr() <-chan net.Addr
type Logger
type PeerInfo
- func ExchangeConnInfo(ctx context.Context, bridgeURL string, info *SelfInfo, port int, useIPv6 bool) (*PeerInfo, error)
type SelfInfo

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AddPortMapping ¶ added in v0.3.0

func AddPortMapping(ctx context.Context, ports ...int) error

func DialContext ¶

func DialContext(ctx context.Context, network, laddr, raddr string) (net.Conn, error)

func Listen ¶

func Listen(ctx context.Context, network, address string) (net.Listener, error)

func ListenPacket ¶

func ListenPacket(ctx context.Context, network, address string) (net.PacketConn, error)

func RendezvousWithTimeout ¶ added in v0.3.0

func RendezvousWithTimeout(ctx context.Context, laddr string, peerAddrs []AddrPair) (conn net.Conn, err error)

RendezvousWithTimeout performs simultaneous connection opening for TCP hole punching, with `rendezvousTimeout`

func SetLogger ¶ added in v0.3.0

func SetLogger(l Logger)

SetLogger sets the internal logger for pnet

Types ¶

type AddrPair ¶ added in v0.3.0

type AddrPair struct {
	PriAddr string `json:"priAddr"`
	PubAddr string `json:"pubAddr"`
}

type HTTPClient ¶

type HTTPClient struct {
	*http.Client
	// contains filtered or unexported fields
}

func NewHTTPClient ¶

func NewHTTPClient(useIpv6 bool, laddr string) *HTTPClient

func (*HTTPClient) GetLAddr ¶

func (cl *HTTPClient) GetLAddr() <-chan net.Addr

type Logger ¶

type Logger interface {
	Infof(format string, a ...any)
	Debugf(format string, a ...any)
}

Logger interface accepted by pnet for internal logging

type PeerInfo ¶ added in v0.3.0

type PeerInfo struct {
	Laddr     string
	PeerAddrs []AddrPair `json:"peerAddrs"`
	Strategy  []string   `json:"strategy,omitempty"`
	PeerNPlan int        `json:"peerNPlan,omitempty"`
	TSAddr    string     `json:"tsAddr,omitempty"`
	TSCap     uint       `json:"tsCap,omitempty"`
}

func ExchangeConnInfo ¶ added in v0.3.0

func ExchangeConnInfo(ctx context.Context, bridgeURL string, info *SelfInfo, port int, useIPv6 bool) (*PeerInfo, error)

ExchangeConnInfo exchanges oneself's info for the peer's info, which can be used to establish a connection

type SelfInfo ¶ added in v0.3.0

type SelfInfo struct {
	PriAddr  string   `json:"priAddr"`
	ChanName string   `json:"chanName"`
	Strategy []string `json:"strategy,omitempty"`
	NPlan    int      `json:"nPlan,omitempty"`
	TSAddr   string   `json:"tsAddr,omitempty"`
	TSCap    uint     `json:"tsCap,omitempty"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL