network

package
v0.17.136 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 20, 2022 License: Apache-2.0 Imports: 39 Imported by: 7

Documentation

Index

Constants

View Source 
const (
	DefaultNetworkOptionsCycleSeconds            = 60
	DefaultNetworkOptionsRouteTimeout            = 10 * time.Second
	DefaultNetworkOptionsCreateCircuitRetries    = 2
	DefaultNetworkOptionsCtrlChanLatencyInterval = 10 * time.Second
	DefaultNetworkOptionsPendingLinkTimeout      = 10 * time.Second
	DefaultNetworkOptionsMinRouterCost           = 10
	DefaultNetworkOptionsRouterConnectChurnLimit = time.Minute
	DefaultNetworkOptionsSmartRerouteFraction    = 0.02
	DefaultNetworkOptionsSmartRerouteCap         = 4
	DefaultNetworkOptionsInitialLinkLatency      = 65 * time.Second
)
View Source 
const SmartRerouteAttempt = 99969996

Variables

View Source 
var CircuitEventHandlerRegistry = cowslice.NewCowSlice(make([]CircuitEventHandler, 0))
View Source 
var CircuitTypes = []CircuitEventType{CircuitCreated, CircuitUpdated, CircuitDeleted}
View Source 
var DbSnapshotTooFrequentError = dbSnapshotTooFrequentError{}

Functions

This section is empty.

Types

type Cache 

type Cache interface {
	RemoveFromCache(id string)
}

type Circuit 

type Circuit struct {
	Id         string
	ClientId   string
	Service    *Service
	Terminator xt.Terminator
	Path       *Path
	Rerouting  concurrenz.AtomicBoolean
	PeerData   xt.PeerData
}

func (*Circuit) HasRouter added in v0.17.24 

func (self *Circuit) HasRouter(r *Router) bool

type CircuitEvent added in v0.17.45 

type CircuitEvent struct {
	Type             CircuitEventType
	CircuitId        string
	ClientId         string
	ServiceId        string
	CreationTimespan *time.Duration
	Path             *Path
	Cost             *uint32
}

func (*CircuitEvent) Handle added in v0.17.45 

func (event *CircuitEvent) Handle()

type CircuitEventHandler added in v0.16.92 

type CircuitEventHandler interface {
	AcceptCircuitEvent(event *CircuitEvent)
}

type CircuitEventType added in v0.17.45 

type CircuitEventType int
const (
	CircuitCreated CircuitEventType = 1
	CircuitUpdated CircuitEventType = 2
	CircuitDeleted CircuitEventType = 3
)

func (CircuitEventType) String added in v0.17.45 

func (self CircuitEventType) String() string

type Controller 

type Controller interface {
	models.EntityRetriever
	// contains filtered or unexported methods
}

type Controllers 

type Controllers struct {
	Terminators *TerminatorController
	Routers     *RouterController
	Services    *ServiceController
	Inspections *InspectionsController
	// contains filtered or unexported fields
}

func NewControllers 

func NewControllers(db boltz.Db, stores *db.Stores) *Controllers

type ForwardingFaultReport added in v0.15.24 

type ForwardingFaultReport struct {
	R          *Router
	CircuitIds []string
}

type InspectResult added in v0.17.9 

type InspectResult struct {
	Success bool
	Errors  []string
	Results []*InspectResultValue
}

type InspectResultValue added in v0.17.9 

type InspectResultValue struct {
	AppId string
	Name  string
	Value string
}

type InspectionsController added in v0.17.9 

type InspectionsController struct {
	// contains filtered or unexported fields
}

func (*InspectionsController) Inspect added in v0.17.9 

func (self *InspectionsController) Inspect(appRegex string, values []string) *InspectResult

type InvalidCircuitError added in v0.16.92 

type InvalidCircuitError struct {
	// contains filtered or unexported fields
}

func (InvalidCircuitError) Error added in v0.16.92 

func (err InvalidCircuitError) Error() string
type Link struct {
	Id       string
	Src      *Router
	Dst      *Router
	Protocol string

	StaticCost int32
	SrcLatency int64
	DstLatency int64
	Cost       int64
	// contains filtered or unexported fields
}

func (*Link) CurrentState 

func (link *Link) CurrentState() *LinkState

func (*Link) GetCost added in v0.13.0 

func (link *Link) GetCost() int64

func (*Link) GetDstLatency added in v0.13.0 

func (link *Link) GetDstLatency() int64

func (*Link) GetId added in v0.17.0 

func (link *Link) GetId() string

func (*Link) GetSrcLatency added in v0.13.0 

func (link *Link) GetSrcLatency() int64

func (*Link) GetStaticCost added in v0.13.0 

func (link *Link) GetStaticCost() int32

func (*Link) IsDown added in v0.16.134 

func (link *Link) IsDown() bool

func (*Link) IsUsable added in v0.16.134 

func (link *Link) IsUsable() bool

func (*Link) SetDown added in v0.16.134 

func (link *Link) SetDown(down bool)

func (*Link) SetDstLatency added in v0.13.0 

func (link *Link) SetDstLatency(latency int64)

func (*Link) SetSrcLatency added in v0.13.0 

func (link *Link) SetSrcLatency(latency int64)

func (*Link) SetStaticCost added in v0.13.0 

func (link *Link) SetStaticCost(cost int32)

type LinkMode 

type LinkMode byte
const (
	Pending LinkMode = iota
	Connected
	Failed
)

func (LinkMode) String 

func (t LinkMode) String() string

type LinkState 

type LinkState struct {
	Mode      LinkMode
	Timestamp int64
}

type Listener added in v0.17.60 

type Listener interface {
	AdvertiseAddress() string
	Protocol() string
}

type Network 

type Network struct {
	*Controllers

	VersionProvider common.VersionProvider
	// contains filtered or unexported fields
}

func NewNetwork 

func NewNetwork(nodeId string, options *Options, database boltz.Db, metricsCfg *metrics.Config, versionProvider common.VersionProvider, closeNotify <-chan struct{}) (*Network, error)

func (*Network) AcceptMetrics 

func (network *Network) AcceptMetrics(metrics *metrics_pb.MetricsMessage)

func (*Network) AddCapability 

func (network *Network) AddCapability(capability string)

func (*Network) AddRouterPresenceHandler 

func (network *Network) AddRouterPresenceHandler(h RouterPresenceHandler)

func (*Network) AllConnectedRouters 

func (network *Network) AllConnectedRouters() []*Router

func (*Network) CircuitEvent added in v0.17.45 

func (network *Network) CircuitEvent(eventType CircuitEventType, circuit *Circuit, creationTimespan *time.Duration, cost *uint32)

func (*Network) ConnectRouter 

func (network *Network) ConnectRouter(r *Router)

func (*Network) ConnectedRouter 

func (network *Network) ConnectedRouter(id string) bool

func (*Network) CreateCircuit 

func (network *Network) CreateCircuit(srcR *Router, clientId *identity.TokenId, service string, ctx logcontext.Context, deadline time.Time) (*Circuit, error)

func (*Network) CreatePath added in v0.16.92 

func (network *Network) CreatePath(srcR, dstR *Router) (*Path, error)

func (*Network) CreatePathWithNodes added in v0.16.92 

func (network *Network) CreatePathWithNodes(nodes []*Router) (*Path, error)

func (*Network) CreateRouter 

func (network *Network) CreateRouter(router *Router) error

func (*Network) DisconnectRouter 

func (network *Network) DisconnectRouter(r *Router)

func (*Network) GetAllCircuits added in v0.16.92 

func (network *Network) GetAllCircuits() []*Circuit
func (network *Network) GetAllLinks() []*Link

func (*Network) GetAllLinksForRouter 

func (network *Network) GetAllLinksForRouter(routerId string) []*Link

func (*Network) GetAppId 

func (network *Network) GetAppId() string

func (*Network) GetCapabilities 

func (network *Network) GetCapabilities() []string

func (*Network) GetCircuit added in v0.16.92 

func (network *Network) GetCircuit(circuitId string) (*Circuit, bool)

func (*Network) GetConnectedRouter 

func (network *Network) GetConnectedRouter(routerId string) *Router

func (*Network) GetControllers 

func (network *Network) GetControllers() *Controllers

func (*Network) GetDb 

func (network *Network) GetDb() boltz.Db

func (*Network) GetEventDispatcher added in v0.12.1 

func (network *Network) GetEventDispatcher() event.Dispatcher
func (network *Network) GetLink(linkId string) (*Link, bool)

func (*Network) GetMetricsRegistry added in v0.12.3 

func (network *Network) GetMetricsRegistry() metrics.Registry

func (*Network) GetOptions added in v0.15.18 

func (network *Network) GetOptions() *Options

func (*Network) GetRouter 

func (network *Network) GetRouter(routerId string) (*Router, error)

func (*Network) GetServiceEventsMetricsRegistry added in v0.16.41 

func (network *Network) GetServiceEventsMetricsRegistry() metrics.UsageRegistry

func (*Network) GetStores 

func (network *Network) GetStores() *db.Stores

func (*Network) GetTraceController 

func (network *Network) GetTraceController() trace.Controller

func (*Network) InitServiceCounterDispatch added in v0.16.23 

func (network *Network) InitServiceCounterDispatch(handler metrics.Handler)

func (*Network) Inspect added in v0.17.9 

func (network *Network) Inspect(name string) *string

func (*Network) LinkChanged 

func (network *Network) LinkChanged(l *Link)

func (*Network) LinkConnected 

func (network *Network) LinkConnected(id string, connected bool) error
func (network *Network) NotifyExistingLink(id, linkProtocol string, srcRouter *Router, dstRouterId string) (bool, error)

func (*Network) RemoveCircuit added in v0.16.92 

func (network *Network) RemoveCircuit(circuitId string, now bool) error
func (network *Network) RemoveLink(linkId string)

func (*Network) ReportForwardingFaults added in v0.15.24 

func (network *Network) ReportForwardingFaults(ffr *ForwardingFaultReport)

func (*Network) RouteResult added in v0.16.0 

func (network *Network) RouteResult(rs *RouteStatus) bool

func (*Network) RouterChanged 

func (network *Network) RouterChanged(r *Router)

func (*Network) Run 

func (network *Network) Run()

func (*Network) ServiceDialFail added in v0.16.23 

func (network *Network) ServiceDialFail(serviceId, terminatorId string)

func (*Network) ServiceDialOtherError added in v0.16.23 

func (network *Network) ServiceDialOtherError(serviceId string)

func (*Network) ServiceDialSuccess added in v0.16.23 

func (network *Network) ServiceDialSuccess(serviceId, terminatorId string)

func (*Network) ServiceDialTimeout added in v0.16.23 

func (network *Network) ServiceDialTimeout(serviceId, terminatorId string)

func (*Network) ServiceInvalidTerminator added in v0.17.76 

func (network *Network) ServiceInvalidTerminator(serviceId, terminatorId string)

func (*Network) ServiceMisconfiguredTerminator added in v0.17.76 

func (network *Network) ServiceMisconfiguredTerminator(serviceId, terminatorId string)

func (*Network) ServiceTerminatorConnectionRefused added in v0.17.76 

func (network *Network) ServiceTerminatorConnectionRefused(serviceId, terminatorId string)

func (*Network) ServiceTerminatorTimeout added in v0.17.76 

func (network *Network) ServiceTerminatorTimeout(serviceId, terminatorId string)

func (*Network) SnapshotDatabase added in v0.11.40 

func (network *Network) SnapshotDatabase() error

func (*Network) UpdatePath added in v0.16.92 

func (network *Network) UpdatePath(path *Path) (*Path, error)

func (*Network) ValidateTerminators 

func (network *Network) ValidateTerminators(r *Router)

func (*Network) VerifyLinkSource added in v0.16.128 

func (network *Network) VerifyLinkSource(targetRouter *Router, linkId string, fingerprints []string) error

func (*Network) VerifyRouter added in v0.17.123 

func (network *Network) VerifyRouter(routerId string, fingerprints []string) error

type Options 

type Options struct {
	CycleSeconds uint32
	Smart        struct {
		RerouteFraction float32
		RerouteCap      uint32
	}
	RouteTimeout            time.Duration
	CreateCircuitRetries    uint32
	CtrlChanLatencyInterval time.Duration
	PendingLinkTimeout      time.Duration
	MinRouterCost           uint16
	RouterConnectChurnLimit time.Duration
	InitialLinkLatency      time.Duration
}

func DefaultOptions 

func DefaultOptions() *Options

func LoadOptions 

func LoadOptions(src map[interface{}]interface{}) (*Options, error)

type Path added in v0.16.92 

type Path struct {
	Nodes               []*Router
	Links               []*Link
	IngressId           string
	EgressId            string
	TerminatorLocalAddr string
}

func (*Path) CreateRouteMessages added in v0.16.92 

func (self *Path) CreateRouteMessages(attempt uint32, circuitId string, terminator xt.Terminator, deadline time.Time) []*ctrl_pb.Route

func (*Path) EgressRouter added in v0.16.92 

func (self *Path) EgressRouter() *Router

func (*Path) EqualPath added in v0.16.92 

func (self *Path) EqualPath(other *Path) bool

func (*Path) String added in v0.16.92 

func (self *Path) String() string

type PathAndCost 

type PathAndCost struct {
	// contains filtered or unexported fields
}

type RouteStatus added in v0.17.76 

type RouteStatus struct {
	Router    *Router
	CircuitId string
	Attempt   uint32
	Success   bool
	Err       string
	PeerData  xt.PeerData
	ErrorCode *byte
}

type Router 

type Router struct {
	models.BaseEntity
	Name        string
	Fingerprint *string
	Listeners   []Listener
	Control     channel.Channel
	Connected   concurrenz.AtomicBoolean
	ConnectTime time.Time
	VersionInfo *common.VersionInfo

	Cost        uint16
	NoTraversal bool
	// contains filtered or unexported fields
}

func NewRouter 

func NewRouter(id, name, fingerprint string, cost uint16, noTraversal bool) *Router

func (*Router) AddLinkListener added in v0.17.60 

func (entity *Router) AddLinkListener(addr, linkProtocol string, linkCostTags []string)

type RouterController 

type RouterController struct {
	// contains filtered or unexported fields
}

func (*RouterController) BaseList 

func (ctrl *RouterController) BaseList(query string) (*models.EntityListResult, error)

func (*RouterController) BaseLoad 

func (ctrl *RouterController) BaseLoad(id string) (models.Entity, error)

func (*RouterController) BaseLoadInTx 

func (ctrl *RouterController) BaseLoadInTx(tx *bbolt.Tx, id string) (models.Entity, error)

func (*RouterController) BasePreparedList 

func (ctrl *RouterController) BasePreparedList(query ast.Query) (*models.EntityListResult, error)

func (*RouterController) BasePreparedListAssociated 

func (ctrl *RouterController) BasePreparedListAssociated(id string, typeLoader models.EntityRetriever, query ast.Query) (*models.EntityListResult, error)

func (*RouterController) Create 

func (ctrl *RouterController) Create(router *Router) error

func (*RouterController) Delete 

func (ctrl *RouterController) Delete(id string) error

func (*RouterController) HandleRouterDelete added in v0.17.42 

func (ctrl *RouterController) HandleRouterDelete(id string)

func (*RouterController) IsConnected 

func (ctrl *RouterController) IsConnected(id string) bool

func (*RouterController) Patch added in v0.17.0 

func (ctrl *RouterController) Patch(r *Router, checker boltz.FieldChecker) error

func (*RouterController) Read 

func (ctrl *RouterController) Read(id string) (entity *Router, err error)

func (*RouterController) RemoveFromCache added in v0.17.112 

func (ctrl *RouterController) RemoveFromCache(id string)

func (*RouterController) Update added in v0.17.0 

func (ctrl *RouterController) Update(r *Router) error

func (*RouterController) UpdateCachedRouter added in v0.17.42 

func (ctrl *RouterController) UpdateCachedRouter(id string)
type RouterLinks struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func (*RouterLinks) Add added in v0.16.133 

func (self *RouterLinks) Add(link *Link, other *Router)

func (*RouterLinks) Clear added in v0.16.133 

func (self *RouterLinks) Clear()
func (self *RouterLinks) GetLinks() []*Link

func (*RouterLinks) GetLinksByRouter added in v0.16.134 

func (self *RouterLinks) GetLinksByRouter() map[string][]*Link

func (*RouterLinks) Remove added in v0.16.133 

func (self *RouterLinks) Remove(link *Link, other *Router)

type RouterPresenceHandler 

type RouterPresenceHandler interface {
	RouterConnected(r *Router)
	RouterDisconnected(r *Router)
}

type RoutingTerminator 

type RoutingTerminator struct {
	RouteCost uint32
	*Terminator
}

func (*RoutingTerminator) GetRouteCost 

func (r *RoutingTerminator) GetRouteCost() uint32

type Service 

type Service struct {
	models.BaseEntity
	Name               string
	TerminatorStrategy string
	Terminators        []*Terminator
}

type ServiceController 

type ServiceController struct {
	// contains filtered or unexported fields
}

func (*ServiceController) BaseList 

func (ctrl *ServiceController) BaseList(query string) (*models.EntityListResult, error)

func (*ServiceController) BaseLoad 

func (ctrl *ServiceController) BaseLoad(id string) (models.Entity, error)

func (*ServiceController) BaseLoadInTx 

func (ctrl *ServiceController) BaseLoadInTx(tx *bbolt.Tx, id string) (models.Entity, error)

func (*ServiceController) BasePreparedList 

func (ctrl *ServiceController) BasePreparedList(query ast.Query) (*models.EntityListResult, error)

func (*ServiceController) BasePreparedListAssociated 

func (ctrl *ServiceController) BasePreparedListAssociated(id string, typeLoader models.EntityRetriever, query ast.Query) (*models.EntityListResult, error)

func (*ServiceController) Create 

func (ctrl *ServiceController) Create(s *Service) error

func (*ServiceController) Delete 

func (ctrl *ServiceController) Delete(id string) error

func (*ServiceController) GetIdForName added in v0.17.51 

func (ctrl *ServiceController) GetIdForName(id string) (string, error)

func (*ServiceController) NotifyTerminatorChanged added in v0.15.6 

func (ctrl *ServiceController) NotifyTerminatorChanged(terminator *db.Terminator) *db.Terminator

func (*ServiceController) Patch added in v0.17.0 

func (ctrl *ServiceController) Patch(s *Service, checker boltz.FieldChecker) error

func (*ServiceController) Read 

func (ctrl *ServiceController) Read(id string) (entity *Service, err error)

func (*ServiceController) RemoveFromCache 

func (ctrl *ServiceController) RemoveFromCache(id string)

func (*ServiceController) Update 

func (ctrl *ServiceController) Update(s *Service) error

type ServiceCounters added in v0.16.23 

type ServiceCounters interface {
	ServiceDialSuccess(serviceId, terminatorId string)
	ServiceDialFail(serviceId, terminatorId string)
	ServiceDialTimeout(serviceId, terminatorId string)
	ServiceDialOtherError(serviceId string)

	ServiceTerminatorTimeout(serviceId, terminatorId string)
	ServiceTerminatorConnectionRefused(serviceId, terminatorId string)
	ServiceInvalidTerminator(serviceId, terminatorId string)
	ServiceMisconfiguredTerminator(serviceId, terminatorId string)
}

type Terminator 

type Terminator struct {
	models.BaseEntity
	Service        string
	Router         string
	Binding        string
	Address        string
	Identity       string
	IdentitySecret []byte
	Cost           uint16
	Precedence     xt.Precedence
	PeerData       map[uint32][]byte
}

func (*Terminator) GetAddress 

func (entity *Terminator) GetAddress() string

func (*Terminator) GetBinding 

func (entity *Terminator) GetBinding() string

func (*Terminator) GetCost 

func (entity *Terminator) GetCost() uint16

func (*Terminator) GetIdentity added in v0.14.0 

func (entity *Terminator) GetIdentity() string

func (*Terminator) GetIdentitySecret added in v0.14.0 

func (entity *Terminator) GetIdentitySecret() []byte

func (*Terminator) GetPeerData 

func (entity *Terminator) GetPeerData() xt.PeerData

func (*Terminator) GetPrecedence added in v0.13.0 

func (entity *Terminator) GetPrecedence() xt.Precedence

func (*Terminator) GetRouterId 

func (entity *Terminator) GetRouterId() string

func (*Terminator) GetServiceId 

func (entity *Terminator) GetServiceId() string

type TerminatorController 

type TerminatorController struct {
	// contains filtered or unexported fields
}

func (*TerminatorController) BaseList 

func (ctrl *TerminatorController) BaseList(query string) (*models.EntityListResult, error)

func (*TerminatorController) BaseLoad 

func (ctrl *TerminatorController) BaseLoad(id string) (models.Entity, error)

func (*TerminatorController) BaseLoadInTx 

func (ctrl *TerminatorController) BaseLoadInTx(tx *bbolt.Tx, id string) (models.Entity, error)

func (*TerminatorController) BasePreparedList 

func (ctrl *TerminatorController) BasePreparedList(query ast.Query) (*models.EntityListResult, error)

func (*TerminatorController) BasePreparedListAssociated 

func (ctrl *TerminatorController) BasePreparedListAssociated(id string, typeLoader models.EntityRetriever, query ast.Query) (*models.EntityListResult, error)

func (*TerminatorController) Create 

func (ctrl *TerminatorController) Create(s *Terminator) (string, error)

func (*TerminatorController) CreateInTx added in v0.16.58 

func (ctrl *TerminatorController) CreateInTx(ctx boltz.MutateContext, terminator *Terminator) (string, error)

func (*TerminatorController) Delete 

func (ctrl *TerminatorController) Delete(id string) error

func (*TerminatorController) Patch 

func (ctrl *TerminatorController) Patch(terminator *Terminator, checker boltz.FieldChecker) error

func (*TerminatorController) Query 

func (ctrl *TerminatorController) Query(query string) (*TerminatorListResult, error)

func (*TerminatorController) Read 

func (ctrl *TerminatorController) Read(id string) (entity *Terminator, err error)

func (*TerminatorController) Update 

func (ctrl *TerminatorController) Update(terminator *Terminator) error

type TerminatorListResult 

type TerminatorListResult struct {
	Entities []*Terminator
	models.QueryMetaData
	// contains filtered or unexported fields
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.