network

Documentation

Overview

Package network is for creating internetworks

Index

• Variables
• type Network
  • func NewNetwork(opts ...Option) Network
• type Option
  • func Address(a string) Option
  • func Id(id string) Option
  • func Name(n string) Option
  • func Nodes(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"
)

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
)

Types

type Network

type Network interface {
	// Name of the network
	Name() string
	// Address returns network bind address
	Address() 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 Option

type Option func(*Options)

func Address

func Address(a string) Option

Address sets the network address

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 Nodes

func Nodes(n ...string) Option

Nodes is a list of seed nodes used along with resolved node

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
	// Nodes is a list of seed nodes
	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

func DefaultOptions

func DefaultOptions() Options

DefaultOptions returns network default options