director

Documentation

Overview

Package director provides proxy call routing facility

Index

• type LocalAddressProvider
  • func NewLocalAddressProvider(st state.State) (LocalAddressProvider, error)
• type RemoteBackendFactory
• type Router
  • func NewRouter(backendFactory RemoteBackendFactory, localBackend proxy.Backend, ...) *Router
  • func (r *Router) Director(ctx context.Context, fullMethodName string) (proxy.Mode, []proxy.Backend, error)
  • func (r *Router) Register(srv *grpc.Server)
  • func (r *Router) RegisterStreamedRegex(regex string)
  • func (r *Router) StreamedDetector(fullMethodName string) bool

Types

type LocalAddressProvider

type LocalAddressProvider interface {
	IsLocalTarget(string) bool
}

LocalAddressProvider provides local address information.

func NewLocalAddressProvider

func NewLocalAddressProvider(st state.State) (LocalAddressProvider, error)

NewLocalAddressProvider initializes and returns a new LocalAddressProvider.

type RemoteBackendFactory

type RemoteBackendFactory func(target string) (proxy.Backend, error)

RemoteBackendFactory provides backend generation by address (target).

type Router

type Router struct {
	// contains filtered or unexported fields
}

Router wraps grpc-proxy StreamDirector.

func NewRouter

func NewRouter(backendFactory RemoteBackendFactory, localBackend proxy.Backend, localAddressProvider LocalAddressProvider) *Router

NewRouter builds new Router.

func (*Router) Director

func (r *Router) Director(ctx context.Context, fullMethodName string) (proxy.Mode, []proxy.Backend, error)

Director implements proxy.StreamDirector function.

func (*Router) Register

func (r *Router) Register(srv *grpc.Server)

Register is no-op to implement factory.Registrator interface.

Actual proxy handler is installed via grpc.UnknownServiceHandler option.

func (*Router) RegisterStreamedRegex

func (r *Router) RegisterStreamedRegex(regex string)

RegisterStreamedRegex register regex for streamed method.

This could be exact literal match: /^\/serviceName\/methodName$/ or any suffix/prefix match.

func (*Router) StreamedDetector

func (r *Router) StreamedDetector(fullMethodName string) bool

StreamedDetector implements proxy.StreamedDetector.