selector

Documentation

Index

• Variables
• func Tests(t *testing.T, s Selector)
• type Filter
• type Option
• type Options
• type SelectOption
  • func WithFilter(f Filter) SelectOption
• type SelectOptions
  • func NewSelectOptions(opts ...SelectOption) SelectOptions
• type Selector
  • func NewSelector(opts ...Option) Selector

Variables

var (
	// DefaultSelector is the default selector
	DefaultSelector = NewSelector()

	// ErrNoneAvailable is returned by select when no routes were provided to select from
	ErrNoneAvailable = errors.New("none available")
)

Functions

func Tests

func Tests(t *testing.T, s Selector)

Tests runs all the tests against a selector to ensure the implementations are consistent

Types

type Filter

type Filter func([]router.Route) []router.Route

Filter the routes

type Option

type Option func(*Options)

Option updates the options

type Options

type Options struct{}

Options used to configure a selector

type SelectOption

type SelectOption func(*SelectOptions)

SelectOption updates the select options

func WithFilter

func WithFilter(f Filter) SelectOption

WithFilter adds a filter to the options

type SelectOptions

type SelectOptions struct {
	Filters []Filter
}

SelectOptions used to configure selection

func NewSelectOptions

func NewSelectOptions(opts ...SelectOption) SelectOptions

NewSelectOptions parses select options

type Selector

type Selector interface {
	// Init a selector with options
	Init(...Option) error
	// Options the selector is using
	Options() Options
	// Select a route from the pool using the strategy
	Select([]router.Route, ...SelectOption) (*router.Route, error)
	// Record the error returned from a route to inform future selection
	Record(router.Route, error) error
	// Close the selector
	Close() error
	// String returns the name of the selector
	String() string
}

Selector selects a route from a pool

func NewSelector

func NewSelector(opts ...Option) Selector

NewSelector creates new selector and returns it