Documentation
¶
Overview ¶
Package network is for creating internetworks
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // NetworkChannel is the name of the tunnel channel for passing network messages NetworkChannel = "network" // ControlChannel is the name of the tunnel channel for passing control message ControlChannel = "control" // DefaultLink is default network link DefaultLink = "network" // MaxConnections is the max number of network client connections MaxConnections = 3 // MaxPeerErrors is the max number of peer errors before we remove it from network graph MaxPeerErrors = 3 )
View Source
var ( // ErrClientNotFound is returned when client for tunnel channel could not be found ErrClientNotFound = errors.New("client not found") // ErrPeerLinkNotFound is returned when peer link could not be found in tunnel Links ErrPeerLinkNotFound = errors.New("peer link not found") // ErrPeerMaxExceeded is returned when peer has reached its max error count limit ErrPeerMaxExceeded = errors.New("peer max errors exceeded") )
View Source
var ( // DefaultName is default network name DefaultName = "go.vine" // DefaultAddress is default network address DefaultAddress = ":0" // ResolveTime defines time interval to periodically resolve network nodes ResolveTime = 1 * time.Minute // AnnounceTime defines time interval to periodically announce node neighbours AnnounceTime = 1 * time.Second // KeepAliveTime is the time in which we want to have sent a message to a peer KeepAliveTime = 30 * time.Second // SyncTime is the time a network node requests full sync from the network SyncTime = 1 * time.Minute // PruneTime defines time interval to periodically check nodes that need to be pruned // due to their not announcing their presence within this time interval PruneTime = 90 * time.Second )
View Source
var ( // ErrPeerExists is returned when adding a peer which already exists ErrPeerExists = errors.New("peer already exists") // ErrPeerNotFound is returned when a peer could not be found in node topology ErrPeerNotFound = errors.New("peer not found") )
View Source
var ( // MaxDepth defines max depth of peer topology MaxDepth uint = 3 )
Functions ¶
func PeersToProto ¶
PeersToProto returns node peers graph encoded into protobuf
Types ¶
type Error ¶
type Error interface { // Count is current count of errors Count() int // Msg is last error message Msg() string }
Error is network node errors
type Network ¶
type Network interface { // Node is network node Node // Init initialise options Init(...Option) error // Options returns the network options Options() Options // Name of the network Name() string // Connect starts the resolver and tunnel server Connect() error // Close stops the tunnel and resolving Close() error // Client is vine client Client() client.Client // Server is vine server Server() server.Server }
Network is vine network
func NewNetwork ¶
NewNetwork returns a new network interface
type Node ¶
type Node interface { // Id is node id Id() string // Address is node bind address Address() string // Peers returns node peers Peers() []Node // Network is the network node is in Network() Network // Status returns node status Status() Status }
Node is network node
type Options ¶
type Options struct { // Id of the node Id string // Name of the network Name string // Address to bind to Address string // Advertise sets the address to advertise Advertise string // Nodes is a list of nodes to connect to Nodes []string // Tunnel is network tunnel Tunnel tunnel.Tunnel // Router is network router Router router.Router // Proxy is network proxy Proxy proxy.Proxy // Resolver is network resolver Resolver resolver.Resolver }
Options configure network
Directories
¶
Path | Synopsis |
---|---|
Package resolver resolves network names to addresses
|
Package resolver resolves network names to addresses |
dns
Package dns resolves names to dns records
|
Package dns resolves names to dns records |
dnssrv
Package dns svc resolves names to dns svc records
|
Package dns svc resolves names to dns svc records |
http
Package http resolves names to network addresses using a http request
|
Package http resolves names to network addresses using a http request |
registry
Package registry resolves names using the vine registry
|
Package registry resolves names using the vine registry |
static
Package static is a static resolver
|
Package static is a static resolver |
Package tunnel provides gre network tunnelling
|
Package tunnel provides gre network tunnelling |
broker
Package broker is a tunnel broker
|
Package broker is a tunnel broker |
transport
Package transport provides a tunnel transport
|
Package transport provides a tunnel transport |
Click to show internal directories.
Click to hide internal directories.