node

Documentation

Index

• func DefaultHost() string
• type Config
• type Event
• type EventKind
• type Node
  • func New(cfg Config) *Node
  • func (n *Node) API() *webrtc.API
  • func (n *Node) Advertise(capability string)
  • func (n *Node) Caps() []string
  • func (n *Node) Dialer() *policy.Dialer
  • func (n *Node) Dropped(s *link.Stream, count int)
  • func (n *Node) Handle(capability, kind string, h link.Handler)
  • func (n *Node) Hello() link.Hello
  • func (n *Node) Local() bool
  • func (n *Node) Logf(format string, args ...any)
  • func (n *Node) OnHello(f func(*link.Hello))
  • func (n *Node) Options() link.Options
  • func (n *Node) PeerOrigin(l *link.Link) string
  • func (n *Node) Policy() *policy.Policy
  • func (n *Node) Resolver() *policy.Resolver
  • func (n *Node) Serve(ctx context.Context, conn signal.Conn) error
  • func (n *Node) SetSSHHostKey(key string)
  • func (n *Node) Subscribe(f func(Event)) func()

Functions

func DefaultHost

func DefaultHost() string

Types

type Config

type Config struct {
	Name         string
	Host         string
	Version      string
	Mode         string
	Policy       *policy.Policy
	Hosts        *policy.Hosts
	Exit         bool
	Prefixes     []string
	Logf         func(format string, args ...any)
	Status       func(format string, args ...any)
	Certificates []webrtc.Certificate
}

type Event

type Event struct {
	Kind   EventKind
	Link   *link.Link
	Peer   link.Hello
	Stream string
	Reason string
	Count  int
	Err    error
}

type EventKind

type EventKind string

const (
	EventConnecting  EventKind = "connecting"
	EventLinked      EventKind = "linked"
	EventLinkDown    EventKind = "link-down"
	EventStreamOpen  EventKind = "stream-open"
	EventStreamClose EventKind = "stream-close"
	EventDropped     EventKind = "dropped"
)

type Node

type Node struct {
	// contains filtered or unexported fields
}

func New

func New(cfg Config) *Node

func (*Node) API

func (n *Node) API() *webrtc.API

func (*Node) Advertise

func (n *Node) Advertise(capability string)

func (*Node) Caps

func (n *Node) Caps() []string

func (*Node) Dialer

func (n *Node) Dialer() *policy.Dialer

func (*Node) Dropped

func (n *Node) Dropped(s *link.Stream, count int)

func (*Node) Handle

func (n *Node) Handle(capability, kind string, h link.Handler)

func (*Node) Hello

func (n *Node) Hello() link.Hello

func (*Node) Local

func (n *Node) Local() bool

func (*Node) Logf

func (n *Node) Logf(format string, args ...any)

func (*Node) OnHello

func (n *Node) OnHello(f func(*link.Hello))

func (*Node) Options

func (n *Node) Options() link.Options

func (*Node) PeerOrigin

func (n *Node) PeerOrigin(l *link.Link) string

func (*Node) Policy

func (n *Node) Policy() *policy.Policy

func (*Node) Resolver

func (n *Node) Resolver() *policy.Resolver

func (*Node) Serve

func (n *Node) Serve(ctx context.Context, conn signal.Conn) error

func (*Node) SetSSHHostKey

func (n *Node) SetSSHHostKey(key string)

func (*Node) Subscribe

func (n *Node) Subscribe(f func(Event)) func()