unistack-org/micro
4
0
Fork 3
Code Issues 20 Pull Requests 1 Actions Packages Projects Releases 281 Wiki Activity

Add tunnel comments

Browse Source
This commit is contained in:
Asim Aslam 2019-07-10 17:41:17 +01:00
parent 4e3a230356
commit 717ba4b3c0
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
network/tunnel/tunnel.go
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