micro/tunnel/tunnel.go

95 lines
2.5 KiB
Go
Raw Normal View History

2019-08-07 20:44:33 +03:00
// Package tunnel provides gre network tunnelling
package tunnel
import (
"errors"
"time"
"github.com/micro/go-micro/transport"
)
2019-10-15 17:40:04 +03:00
const (
// send over one link
2019-10-15 17:40:04 +03:00
Unicast Mode = iota
// send to all channel listeners
2019-10-15 17:40:04 +03:00
Multicast
2019-10-15 18:08:38 +03:00
// send to all links
2019-10-15 17:40:04 +03:00
Broadcast
)
2019-09-04 14:00:11 +03:00
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")
2019-09-11 21:57:41 +03:00
// ErrLinkNotFound is returned when a link is specified at dial time and does not exist
ErrLinkNotFound = errors.New("link not found")
2019-09-04 14:00:11 +03:00
)
// Mode of the session
2019-10-15 17:40:04 +03:00
type Mode uint8
2019-08-31 19:32:20 +03:00
// Tunnel creates a gre tunnel on top of the go-micro/transport.
// It establishes multiple streams using the Micro-Tunnel-Channel header
2019-08-07 20:44:33 +03:00
// and Micro-Tunnel-Session header. The tunnel id is a hash of
// the address being requested.
type Tunnel interface {
2019-08-07 23:58:25 +03:00
Init(opts ...Option) error
2019-08-21 14:55:10 +03:00
// Address the tunnel is listening on
Address() string
// Connect connects the tunnel
Connect() error
// Close closes the tunnel
Close() error
2019-09-11 22:49:27 +03:00
// All the links the tunnel is connected to
Links() []Link
2019-08-30 22:05:00 +03:00
// Connect to a channel
Dial(channel string, opts ...DialOption) (Session, error)
2019-08-30 22:05:00 +03:00
// Accept connections on a channel
2019-10-15 17:40:04 +03:00
Listen(channel string, opts ...ListenOption) (Listener, error)
2019-08-20 19:21:35 +03:00
// Name of the tunnel implementation
String() string
2019-08-07 20:44:33 +03:00
}
2019-09-04 17:41:57 +03:00
// Link represents internal links to the tunnel
type Link interface {
// The id of the link
Id() string
2019-10-22 18:53:47 +03:00
// Delay is the current load on the link (lower is better)
2019-10-22 18:50:00 +03:00
Delay() int64
// Length returns the roundtrip time as nanoseconds (lower is better)
Length() int64
2019-10-22 19:02:22 +03:00
// Current transfer rate as bits per second (lower is better)
Rate() float64
// Status of the link e.g connected/closed
Status() string
2019-09-04 17:41:57 +03:00
// honours transport socket
transport.Socket
}
2019-08-07 20:44:33 +03:00
// The listener provides similar constructs to the transport.Listener
type Listener interface {
2019-08-31 19:32:20 +03:00
Accept() (Session, error)
2019-08-30 22:05:00 +03:00
Channel() string
2019-08-07 20:44:33 +03:00
Close() error
}
2019-08-30 22:05:00 +03:00
// Session is a unique session created when dialling or accepting connections on the tunnel
type Session interface {
2019-08-31 19:32:20 +03:00
// The unique session id
2019-08-07 20:44:33 +03:00
Id() string
2019-08-31 19:32:20 +03:00
// The channel name
2019-08-30 22:05:00 +03:00
Channel() string
2019-09-11 22:07:43 +03:00
// The link the session is on
Link() string
2019-08-07 20:44:33 +03:00
// a transport socket
transport.Socket
2019-08-05 21:41:48 +03:00
}
2019-08-07 20:44:33 +03:00
// NewTunnel creates a new tunnel
2019-08-05 21:41:48 +03:00
func NewTunnel(opts ...Option) Tunnel {
return newTunnel(opts...)
}