micro/tunnel/tunnel.go

49 lines
1.2 KiB
Go
Raw Normal View History

2019-08-07 20:44:33 +03:00
// Package tunnel provides gre network tunnelling
package tunnel
import (
"github.com/micro/go-micro/transport"
)
2019-08-07 20:44:33 +03:00
// 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.
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-08-07 20:44:33 +03:00
// Dial an endpoint
Dial(addr string) (Conn, error)
// Accept connections
Listen(addr string) (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
}
// The listener provides similar constructs to the transport.Listener
type Listener interface {
Addr() string
Close() error
Accept() (Conn, error)
}
// Conn is a connection dialed or accepted which includes the tunnel id and session
type Conn interface {
// Specifies the tunnel id
Id() string
// The session
Session() string
// 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...)
}