tunnel

Documentation

Overview

Package tunnel provides gre network tunnelling

Index

• Variables
• type Conn
• type Listener
• type Option
  • func Address(a string) Option
  • func Id(id string) Option
  • func Nodes(n ...string) Option
  • func Transport(t transport.Transport) Option
• type Options
  • func DefaultOptions() Options
• type Tunnel
  • func NewTunnel(opts ...Option) Tunnel

Variables

var (
	// DefaultAddress is default tunnel bind address
	DefaultAddress = ":9096"
)

Types

type Conn

type Conn interface {
	// Specifies the tunnel id
	Id() string
	// The session
	Session() string
	// a transport socket
	transport.Socket
}

Conn is a connection dialed or accepted which includes the tunnel id and session

type Listener

type Listener interface {
	Addr() string
	Close() error
	Accept() (Conn, error)
}

The listener provides similar constructs to the transport.Listener

type Option

type Option func(*Options)

func Address

func Address(a string) Option

The tunnel address

func Id

func Id(id string) Option

The tunnel id

func Nodes

func Nodes(n ...string) Option

Nodes specify remote network nodes

func Transport

func Transport(t transport.Transport) Option

Transport listens for incoming connections

type Options

type Options struct {
	// Id is tunnel id
	Id string
	// Address is tunnel address
	Address string
	// Nodes are remote nodes
	Nodes []string
	// Transport listens to incoming connections
	Transport transport.Transport
}

Options provides network configuration options

func DefaultOptions

func DefaultOptions() Options

DefaultOptions returns router default options

type Tunnel

type Tunnel interface {
	Init(opts ...Option) error
	// Connect connects the tunnel
	Connect() error
	// Close closes the tunnel
	Close() error
	// Dial an endpoint
	Dial(addr string) (Conn, error)
	// Accept connections
	Listen(addr string) (Listener, error)
}

Tunnel creates a gre network tunnel on top of a link. It establishes multiple streams using the Micro-Tunnel-Id header and Micro-Tunnel-Session header. The tunnel id is a hash of the address being requested.

func NewTunnel

func NewTunnel(opts ...Option) Tunnel

NewTunnel creates a new tunnel