server

Documentation

Overview

Package server is a generated protocol buffer package.

It is generated from these files:

fake_server.proto

It has these top-level messages:

FailWithHTTPErrorRequest

Index

• func RegisterFakeServerServer(s *grpc.Server, srv FakeServerServer)
• func RegisterInstrumentation(router *mux.Router)
• type Config
  • func (cfg *Config) RegisterFlags(f *flag.FlagSet)
• type FailWithHTTPErrorRequest
  • func (*FailWithHTTPErrorRequest) Descriptor() ([]byte, []int)
  • func (m *FailWithHTTPErrorRequest) GetCode() int32
  • func (*FailWithHTTPErrorRequest) ProtoMessage()
  • func (m *FailWithHTTPErrorRequest) Reset()
  • func (m *FailWithHTTPErrorRequest) String() string
• type FakeServerClient
  • func NewFakeServerClient(cc *grpc.ClientConn) FakeServerClient
• type FakeServerServer
• type Server
  • func New(cfg Config) (*Server, error)
  • func (s *Server) Run()
  • func (s *Server) Shutdown()
  • func (s *Server) Stop()

Functions

func RegisterFakeServerServer

func RegisterFakeServerServer(s *grpc.Server, srv FakeServerServer)

func RegisterInstrumentation

func RegisterInstrumentation(router *mux.Router)

RegisterInstrumentation on the given router.

Types

type Config

type Config struct {
	MetricsNamespace string
	HTTPListenPort   int
	GRPCListenPort   int

	RegisterInstrumentation bool
	ExcludeRequestInLog     bool

	ServerGracefulShutdownTimeout time.Duration
	HTTPServerReadTimeout         time.Duration
	HTTPServerWriteTimeout        time.Duration
	HTTPServerIdleTimeout         time.Duration

	GRPCOptions    []grpc.ServerOption
	GRPCMiddleware []grpc.UnaryServerInterceptor
	HTTPMiddleware []middleware.Interface
}

Config for a Server

func (*Config) RegisterFlags

func (cfg *Config) RegisterFlags(f *flag.FlagSet)

RegisterFlags adds the flags required to config this to the given FlagSet

type FailWithHTTPErrorRequest

type FailWithHTTPErrorRequest struct {
	Code int32 `protobuf:"varint,1,opt,name=Code" json:"Code,omitempty"`
}

func (*FailWithHTTPErrorRequest) Descriptor

func (*FailWithHTTPErrorRequest) Descriptor() ([]byte, []int)

func (*FailWithHTTPErrorRequest) GetCode

func (m *FailWithHTTPErrorRequest) GetCode() int32

func (*FailWithHTTPErrorRequest) ProtoMessage

func (*FailWithHTTPErrorRequest) ProtoMessage()

func (*FailWithHTTPErrorRequest) Reset

func (m *FailWithHTTPErrorRequest) Reset()

func (*FailWithHTTPErrorRequest) String

func (m *FailWithHTTPErrorRequest) String() string

type FakeServerClient

type FakeServerClient interface {
	Succeed(ctx context.Context, in *google_protobuf.Empty, opts ...grpc.CallOption) (*google_protobuf.Empty, error)
	FailWithError(ctx context.Context, in *google_protobuf.Empty, opts ...grpc.CallOption) (*google_protobuf.Empty, error)
	FailWithHTTPError(ctx context.Context, in *FailWithHTTPErrorRequest, opts ...grpc.CallOption) (*google_protobuf.Empty, error)
}

func NewFakeServerClient

func NewFakeServerClient(cc *grpc.ClientConn) FakeServerClient

type FakeServerServer

type FakeServerServer interface {
	Succeed(context.Context, *google_protobuf.Empty) (*google_protobuf.Empty, error)
	FailWithError(context.Context, *google_protobuf.Empty) (*google_protobuf.Empty, error)
	FailWithHTTPError(context.Context, *FailWithHTTPErrorRequest) (*google_protobuf.Empty, error)
}

type Server

type Server struct {
	HTTP *mux.Router
	GRPC *grpc.Server
	// contains filtered or unexported fields
}

Server wraps a HTTP and gRPC server, and some common initialization.

Servers will be automatically instrumented for Prometheus metrics and Loki tracing. HTTP over gRPC

func New

func New(cfg Config) (*Server, error)

New makes a new Server

func (*Server) Run

func (s *Server) Run()

Run the server; blocks until SIGTERM is received.

func (*Server) Shutdown

func (s *Server) Shutdown()

Shutdown the server, gracefully. Should be defered after New().

func (*Server) Stop

func (s *Server) Stop()

Stop unblocks Run().