network

Documentation

Overview

Package network is for creating internetworks

Index

• Variables
• func PeersToProto(node Node, depth uint) *pb.Peer
• func UnpackPeerTopology(pbPeer *pb.Peer, lastSeen time.Time, depth uint) *node
• type Network
  • func NewNetwork(opts ...Option) Network
• type Node
• type Option
  • func Address(a string) Option
  • func Advertise(a string) Option
  • func Id(id string) Option
  • func Name(n string) Option
  • func Peers(n ...string) Option
  • func Proxy(p proxy.Proxy) Option
  • func Resolver(r resolver.Resolver) Option
  • func Router(r router.Router) Option
  • func Tunnel(t tunnel.Tunnel) Option
• type Options
  • func DefaultOptions() Options

Variables

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
)

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")
)

var (
	// DefaultName is default network name
	DefaultName = "go.micro"
	// 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 = 30 * time.Second
	// 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
)

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")
)

var (
	// MaxDepth defines max depth of peer topology
	MaxDepth uint = 3
)

Functions

func PeersToProto

func PeersToProto(node Node, depth uint) *pb.Peer

PeersToProto returns node peers graph encoded into protobuf

func UnpackPeerTopology

func UnpackPeerTopology(pbPeer *pb.Peer, lastSeen time.Time, depth uint) *node

UnpackPeerTopology unpacks pb.Peer into node topology of given depth

Types

type Network

type Network interface {
	// Node is network node
	Node
	// 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 micro client
	Client() client.Client
	// Server is micro server
	Server() server.Server
}

Network is micro network

func NewNetwork

func NewNetwork(opts ...Option) Network

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
}

Node is network node

type Option

type Option func(*Options)

func Address

func Address(a string) Option

Address sets the network address

func Advertise

func Advertise(a string) Option

Advertise sets the address to advertise

func Id

func Id(id string) Option

Id sets the id of the network node

func Name

func Name(n string) Option

Name sets the network name

func Peers

func Peers(n ...string) Option

Peers is a list of peers to connect to

func Proxy

func Proxy(p proxy.Proxy) Option

Proxy sets the network proxy

func Resolver

func Resolver(r resolver.Resolver) Option

Resolver is the network resolver

func Router

func Router(r router.Router) Option

Router sets the network router

func Tunnel

func Tunnel(t tunnel.Tunnel) Option

Tunnel sets the network tunnel

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
	// Peers is a list of peers to connect to
	Peers []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

func DefaultOptions

func DefaultOptions() Options

DefaultOptions returns network default options