gxfilter

Documentation

Overview

Package gxfilter provides a interface for service filter

Package gxfilter provides a interface for service filter

Package gxfilter provides a interface for service filter

Index

• Variables
• type Filter
• type Option
  • func WithContext(ctx *gxcontext.ValuesContext) Option
  • func WithRegistry(r gxregistry.Registry) Option
• type Options
• type ServiceArray
  • func NewServiceArray(Arr []*gxregistry.Service) *ServiceArray
  • func (s *ServiceArray) Add(service *gxregistry.Service, ttl time.Duration)
  • func (s *ServiceArray) Del(service *gxregistry.Service, ttl time.Duration)
  • func (s *ServiceArray) Select(ctx context.Context, hash ServiceHash) (*gxregistry.Service, error)
  • func (s ServiceArray) String() string
• type ServiceHash

Variables

var (
	ErrNotFound              = jerrors.Errorf("not found")
	ErrNoneAvailable         = jerrors.Errorf("none available")
	ErrRunOutAllServiceNodes = jerrors.Errorf("has used out all provider nodes")
)

var (
	ErrServiceArrayEmpty = jerrors.New("ServiceArray empty")
)

Types

type Filter

type Filter interface {
	Options() Options
	GetService(gxregistry.ServiceAttr) ([]*gxregistry.Service, error)
	Filter(gxregistry.ServiceAttr) (*ServiceArray, error)
	CheckServiceAlive(gxregistry.ServiceAttr, *ServiceArray) bool
	Close() error
}

Filter used to get service nodes from registry.

type Option

type Option func(*Options)

Option used to initialise the filter

func WithContext

func WithContext(ctx *gxcontext.ValuesContext) Option

func WithRegistry

func WithRegistry(r gxregistry.Registry) Option

WithRegistry sets the registry used by the filter

type Options

type Options struct {
	Registry gxregistry.Registry
	Context  *gxcontext.ValuesContext
}

type ServiceArray

type ServiceArray struct {
	Arr    []*gxregistry.Service
	Active time.Time
	// contains filtered or unexported fields
}

func NewServiceArray

func NewServiceArray(Arr []*gxregistry.Service) *ServiceArray

func (*ServiceArray) Add

func (s *ServiceArray) Add(service *gxregistry.Service, ttl time.Duration)

func (*ServiceArray) Del

func (s *ServiceArray) Del(service *gxregistry.Service, ttl time.Duration)

func (*ServiceArray) Select

func (s *ServiceArray) Select(ctx context.Context, hash ServiceHash) (*gxregistry.Service, error)

func (ServiceArray) String

func (s ServiceArray) String() string

type ServiceHash

type ServiceHash func(context.Context, *ServiceArray) (*gxregistry.Service, error)

ServiceHash is a user service hash interface to select a service provider. @context is transfered from ServiceArray::Select