1
0
mirror of https://github.com/go-micro/go-micro.git synced 2024-11-24 08:02:32 +02:00

Add tunnel comments

This commit is contained in:
Asim Aslam 2019-07-10 17:41:17 +01:00
parent 4e3a230356
commit 717ba4b3c0

View File

@ -1,4 +1,4 @@
// Package tunnel provides a network tunnel
// Package tunnel provides a network tunnel ontop of a link
package tunnel
import (
@ -6,7 +6,9 @@ import (
"github.com/micro/go-micro/transport"
)
// Tunnel creates a network tunnel
// Tunnel creates a network tunnel on top of a link.
// It establishes multiple streams using the Micro-Tunnel header
// created as a hash of the address.
type Tunnel interface {
// Connect connects the tunnel
Connect() error