apid

Documentation

Index

• func NewSubrouter(r *mux.Route, ms ...middlewares.HTTPMiddleware) *mux.Router
• type APId
  • func New(c Config, opts ...Option) (*APId, error)
  • func (a *APId) Err() <-chan error
  • func (a *APId) Name() string
  • func (a *APId) Start() error
  • func (a *APId) Stop() error
• type Config
• type Option
• type WrappedRouter
  • func (r *WrappedRouter) Match(req *http.Request, match *mux.RouteMatch) bool

Functions

func NewSubrouter

func NewSubrouter(r *mux.Route, ms ...middlewares.HTTPMiddleware) *mux.Router

NewSubrouter returns new router given route and set of middleware. Useful when you would like a subset of routes that are wrapped in a specific set of middleware. Eg. you would some routes to require authetication while others you would not.

Types

type APId

type APId struct {
	Authenticator    *authentication.Authenticator
	HTTPServer       *http.Server
	CoreSubrouter    *mux.Router
	GraphQLSubrouter *mux.Router
	// contains filtered or unexported fields
}

APId is the backend HTTP API.

func New

func New(c Config, opts ...Option) (*APId, error)

New creates a new APId.

func (*APId) Err

func (a *APId) Err() <-chan error

Err returns a channel to listen for terminal errors on.

func (*APId) Name

func (a *APId) Name() string

Name returns the daemon name

func (*APId) Start

func (a *APId) Start() error

Start APId.

func (*APId) Stop

func (a *APId) Stop() error

Stop httpApi.

type Config

type Config struct {
	ListenAddress       string
	URL                 string
	Bus                 messaging.MessageBus
	Store               store.Store
	EventStore          store.EventStore
	QueueGetter         types.QueueGetter
	TLS                 *types.TLSOptions
	Cluster             clientv3.Cluster
	EtcdClientTLSConfig *tls.Config
	Authenticator       *authentication.Authenticator
	ClusterVersion      string
}

Config configures APId.

type Option

type Option func(*APId) error

Option is a functional option.

type WrappedRouter

type WrappedRouter struct {
	*mux.Router
	// contains filtered or unexported fields
}

WrappedRouter is equivelant to mux.Router with the addition that any time it handles a request the given middleware stack is applied first.

func (*WrappedRouter) Match

func (r *WrappedRouter) Match(req *http.Request, match *mux.RouteMatch) bool

Match matches registered routes against the request.