router

Documentation

Index

• type BaseRouterRule
• type Chain
• type FilePriorityRouterFactory
• type HealthChecker
• type NotifyRouter
• type PriorityRouter
• type PriorityRouterFactory

Types

type BaseRouterRule

type BaseRouterRule struct {
	RawRule  string
	Runtime  bool
	Force    bool
	Valid    bool
	Enabled  bool
	Priority int
	Dynamic  bool
	Scope    string
	Key      string
}

BaseRouterRule

type Chain

type Chain interface {

	// AddRouters Add routers
	AddRouters([]PriorityRouter)

	// SetInvokers notify router chain of the initial addresses from registry at the first time. Notify whenever addresses in registry change.
	SetInvokers(invokers []protocol.Invoker)
	// contains filtered or unexported methods
}

Chain

type FilePriorityRouterFactory

type FilePriorityRouterFactory interface {
	// NewFileRouters Create file router with config file
	NewFileRouter([]byte) (PriorityRouter, error)
}

FilePriorityRouterFactory creates priority router with parse config file

type HealthChecker

type HealthChecker interface {
	// IsHealthy evaluates the healthy state on the given Invoker
	IsHealthy(invoker protocol.Invoker) bool
}

HealthChecker is used to determine whether the invoker is healthy or not

type NotifyRouter

type NotifyRouter interface {
	PriorityRouter
	// Notify notify whenever addresses in registry change
	Notify([]protocol.Invoker)
}

NotifyRouter notify router use the invoker list. Invoker list may change from time to time. This method gives the router a chance to prepare before {@link Router#route(List, URL, Invocation)} gets called.

type PriorityRouter

type PriorityRouter interface {

	// Priority Return Priority in router
	// 0 to ^int(0) is better
	Priority() int64
	// contains filtered or unexported methods
}

Router

type PriorityRouterFactory

type PriorityRouterFactory interface {
	// NewPriorityRouter creates router instance with URL
	NewPriorityRouter(*common.URL) (PriorityRouter, error)
}

Extension - Router PriorityRouterFactory creates creates priority router with url