node

Documentation

Overview

Package node provides functionalities for handling remote nodes and dispatching connections through them.

Index

• type Dispatcher
  • func NewDispatcher(n Noder) *Dispatcher
  • func (d *Dispatcher) DialContext(ctx context.Context, network, addr string) (net.Conn, error)
  • func (d *Dispatcher) GetNodeBalanced(exp ...string) (*Node, error)
• type FallbackDialer
• type GetNodesFunc
• type Node
  • func New(host, pport, bport string, isLocal bool) (*Node, error)
  • func (n *Node) AddTunnel(tunnel *Tunnel)
  • func (n *Node) Addr() net.Addr
  • func (n *Node) BPort() string
  • func (n *Node) Close() error
  • func (n *Node) CopyTunnels(into *Node)
  • func (n *Node) ID() string
  • func (n *Node) IsActive() bool
  • func (n *Node) IsLocal() bool
  • func (n *Node) PPort() string
  • func (n *Node) Ping(ctx context.Context) error
  • func (n *Node) ProxyAddr() net.Addr
  • func (n *Node) RemoveTunnel(target string, acknoledged bool) error
  • func (n *Node) SetIsActive(active bool)
  • func (n *Node) Tunnel(target string) (*Tunnel, error)
  • func (n *Node) Tunnels() map[string]*Tunnel
  • func (n *Node) Workload() int
• type Noder
• type Tunnel
  • func NewTunnel(target string) *Tunnel
  • func (t *Tunnel) Copies() int
  • func (t *Tunnel) Copy() *Tunnel
  • func (t *Tunnel) ID() string

Types

type Dispatcher

type Dispatcher struct {
	Noder
	Fallback FallbackDialer
}

Dispatcher implements the DialContext method.

func NewDispatcher

func NewDispatcher(n Noder) *Dispatcher

NewDialer returns a Dialer instance. f is used each time that the list of node is required.

func (*Dispatcher) DialContext

func (d *Dispatcher) DialContext(ctx context.Context, network, addr string) (net.Conn, error)

DialContext uses the underlying load balancer to retrieve a possible socks5 proxy address to chain the connection to. If none available, dials the connection using the default net.Dialer.

func (*Dispatcher) GetNodeBalanced

func (d *Dispatcher) GetNodeBalanced(exp ...string) (*Node, error)

GetNodeBalanced collects the workload of its registered nodes, and compares them to the workload of the root node.

Returns an error if no candidate is found, either because none was provided or because no entry's workload was under the treshold.

exp is a list of ids, which are considered as nodes that should not be taken into consideration.

type FallbackDialer

type FallbackDialer interface {
	socks5.Dialer
	proxy.Dialer
}

FallbackDialer combines DialContext and Dial methods.

type GetNodesFunc

type GetNodesFunc func() (*Node, []*Node)

GetNodesFunc describes a simple node getter function. The first node returned is considered as the local/root one.

type Node

type Node struct {
	BAddr net.Addr
	PAddr net.Addr

	ToBeTraced bool

	sync.Mutex
	// contains filtered or unexported fields
}

Node represents a remote booster node.

func New

func New(host, pport, bport string, isLocal bool) (*Node, error)

New creates a new node instance.

func (*Node) AddTunnel

func (n *Node) AddTunnel(tunnel *Tunnel)

AddTunnel sets the node's state to active and adds a new tunnel to it. If the node as already a tunnel with this target connected to it, it increments the copies of the tunnel.

func (*Node) Addr

func (n *Node) Addr() net.Addr

func (*Node) BPort

func (n *Node) BPort() string

BPort is a convenience method that returns the booster port as string.

func (*Node) Close

func (n *Node) Close() error

func (*Node) CopyTunnels

func (n *Node) CopyTunnels(into *Node)

CopyTunnels takes the tunnels of the receiver and copies them into "into".

func (*Node) ID

func (n *Node) ID() string

ID returns the node's sha1 identifier.

func (*Node) IsActive

func (n *Node) IsActive() bool

IsActive returns true if the node is updating it's status.

func (*Node) IsLocal

func (n *Node) IsLocal() bool

IsLocal returns true if the node is a local node.

func (*Node) PPort

func (n *Node) PPort() string

PPort is a convenience method that returns the proxy port as string.

func (*Node) Ping

func (n *Node) Ping(ctx context.Context) error

Ping dials with the node with little timeout. Returns an error if the endpoint is not reachable, nil otherwise. Required by tracer.Pinger.

func (*Node) ProxyAddr

func (n *Node) ProxyAddr() net.Addr

ProxyAddr returns the proxy address of the node.

func (*Node) RemoveTunnel

func (n *Node) RemoveTunnel(target string, acknoledged bool) error

func (*Node) SetIsActive

func (n *Node) SetIsActive(active bool)

SetIsActive sets the state of the node. Safe to be called by multiple goroutines.

func (*Node) Tunnel

func (n *Node) Tunnel(target string) (*Tunnel, error)

func (*Node) Tunnels

func (n *Node) Tunnels() map[string]*Tunnel

func (*Node) Workload

func (n *Node) Workload() int

Workload is the number of tunnels that the node is managing. Contains also unacknoledged ones.

type Noder

type Noder interface {
	Nodes() (*Node, []*Node)
}

type Tunnel

type Tunnel struct {
	Target string

	sync.Mutex
	// contains filtered or unexported fields
}

func NewTunnel

func NewTunnel(target string) *Tunnel

func (*Tunnel) Copies

func (t *Tunnel) Copies() int

func (*Tunnel) Copy

func (t *Tunnel) Copy() *Tunnel

func (*Tunnel) ID

func (t *Tunnel) ID() string