Documentation ¶
Overview ¶
Package tunnel provides gre network tunnelling
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // DiscoverTime sets the time at which we fire discover messages DiscoverTime = 60 * time.Second // KeepAliveTime defines time interval we send keepalive messages to outbound links KeepAliveTime = 30 * time.Second // ReconnectTime defines time interval we periodically attempt to reconnect dead links ReconnectTime = 5 * time.Second )
var ( // DefaultAddress is default tunnel bind address DefaultAddress = ":0" // The shared default token DefaultToken = "go.micro.tunnel" )
var ( // DefaultDialTimeout is the dial timeout if none is specified DefaultDialTimeout = time.Second * 5 // ErrDialTimeout is returned by a call to Dial where the timeout occurs ErrDialTimeout = errors.New("dial timeout") // ErrDiscoverChan is returned when we failed to receive the "announce" back from a discovery ErrDiscoverChan = errors.New("failed to discover channel") // ErrLinkNotFound is returned when a link is specified at dial time and does not exist ErrLinkNotFound = errors.New("link not found") // ErrReadTimeout is a timeout on session.Recv ErrReadTimeout = errors.New("read timeout") )
var (
ErrLinkConnectTimeout = errors.New("link connect timeout")
)
Functions ¶
Types ¶
type DialOption ¶ added in v1.10.0
type DialOption func(*DialOptions)
func DialLink ¶ added in v1.11.0
func DialLink(id string) DialOption
DialLink specifies the link to pin this connection to. This is not applicable if the multicast option is set.
func DialMode ¶ added in v1.12.0
func DialMode(m Mode) DialOption
Dial multicast sets the multicast option to send only to those mapped
func DialTimeout ¶ added in v1.10.0
func DialTimeout(t time.Duration) DialOption
DialTimeout sets the dial timeout of the connection
type DialOptions ¶ added in v1.10.0
type Link ¶ added in v1.10.0
type Link interface { // Id returns the link unique Id Id() string // Delay is the current load on the link (lower is better) Delay() int64 // Length returns the roundtrip time as nanoseconds (lower is better) Length() int64 // Current transfer rate as bits per second (lower is better) Rate() float64 // Is this a loopback link Loopback() bool // State of the link: connected/closed/error State() string // honours transport socket transport.Socket }
Link represents internal links to the tunnel
type ListenOption ¶ added in v1.12.0
type ListenOption func(*ListenOptions)
func ListenTimeout ¶ added in v1.18.0
func ListenTimeout(t time.Duration) ListenOption
Timeout for reads and writes on the listener session
type ListenOptions ¶ added in v1.12.0
type Options ¶
type Options struct { // Id is tunnel id Id string // Address is tunnel address Address string // Nodes are remote nodes Nodes []string // The shared auth token Token string // Transport listens to incoming connections Transport transport.Transport }
Options provides network configuration options
type Session ¶ added in v1.10.0
type Session interface { // The unique session id Id() string // The channel name Channel() string // The link the session is on Link() string // a transport socket transport.Socket }
Session is a unique session created when dialling or accepting connections on the tunnel
type Tunnel ¶
type Tunnel interface { // Init initializes tunnel with options Init(opts ...Option) error // Address returns the address the tunnel is listening on Address() string // Connect connects the tunnel Connect() error // Close closes the tunnel Close() error // Links returns all the links the tunnel is connected to Links() []Link // Dial allows a client to connect to a channel Dial(channel string, opts ...DialOption) (Session, error) // Listen allows to accept connections on a channel Listen(channel string, opts ...ListenOption) (Listener, error) // String returns the name of the tunnel implementation String() string }
Tunnel creates a gre tunnel on top of the go-micro/transport. It establishes multiple streams using the Micro-Tunnel-Channel header and Micro-Tunnel-Session header. The tunnel id is a hash of the address being requested.