router

Documentation

Overview

Package router provides api service routing

Index

• type Option
  • func WithHandler(h string) Option
  • func WithRegistry(r registry.Registry) Option
  • func WithResolver(r resolver.Resolver) Option
• type Options
  • func NewOptions(opts ...Option) Options
• type Router

Types

type Option

type Option func(o *Options)

func WithHandler

func WithHandler(h string) Option

func WithRegistry

func WithRegistry(r registry.Registry) Option

func WithResolver

func WithResolver(r resolver.Resolver) Option

type Options

type Options struct {
	Handler  string
	Registry registry.Registry
	Resolver resolver.Resolver
}

func NewOptions

func NewOptions(opts ...Option) Options

type Router

type Router interface {
	// Options returns options
	Options() Options
	// Close stop the router
	Close() error
	// Endpoint returns an api.Service endpoint or an error if it does not exist
	Endpoint(r *http.Request) (*api.Service, error)
	// Register endpoint in router
	Register(ep *api.Endpoint) error
	// Deregister endpoint from router
	Deregister(ep *api.Endpoint) error
	// Route returns an api.Service route
	Route(r *http.Request) (*api.Service, error)
}

Router is used to determine an endpoint for a request