unistack-org/micro
3
0
Fork 3
Code Issues 14 Pull Requests 2 Actions Packages Projects Releases 242 Wiki Activity

update link comments

Browse Source
This commit is contained in:
Asim Aslam 2019-07-10 19:09:22 +01:00
parent 1f218f7b48
commit 8c157c1d5f
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
network/link/link.go
View File

@ -1,4 +1,4 @@
// Package link provides a measured transport.Socket link
// Package link provides a measured link on top of a transport.Socket
package link
import (
@ -8,9 +8,10 @@ import (
"github.com/micro/go-micro/transport"
)
// Link is a layer ontop of a transport socket with the
// Link is a layer on top of a transport socket with the
// buffering send and recv queue's with the ability to
// measure the actual transport link and reconnect.
// measure the actual transport link and reconnect if
// an address is specified.
type Link interface {
// provides the transport.Socket interface
transport.Socket
@ -36,13 +37,13 @@ func NewLink(opts ...options.Option) Link {
return newLink(options.NewOptions(opts...))
}
// Sets the link id
// Sets the link id which otherwise defaults to "local"
func Id(id string) options.Option {
return options.WithValue("link.id", id)
}
// The address to use for the link. Connect must be
// called for this to be used.
// called for this to be used, its otherwise unused.
func Address(a string) options.Option {
return options.WithValue("link.address", a)
}
@ -53,8 +54,7 @@ func Transport(t transport.Transport) options.Option {
return options.WithValue("link.transport", t)
}
// Socket sets the socket where it was accepted
// from a remote end.
// Socket sets the socket to use instead of dialing.
func Socket(s transport.Socket) options.Option {
return options.WithValue("link.socket", s)
}