server

Documentation

Index

• type Config
  • func DefaultConfig() *Config
  • func (c *Config) Flags(prefix string, defaults *Config) *pflag.FlagSet
• type Option
  • func WithGRPCOptions(opts ...grpc.Option) Option
  • func WithHTTPOptions(opts ...http.Option) Option
  • func WithInternalGRPCOptions(opts ...grpc.Option) Option
  • func WithInternalHTTPOptions(opts ...http.Option) Option
• type Server
  • func New(config Config, opts ...Option) *Server
  • func (s *Server) RegisterTCPServer(name, address string, server interface{ ... }) error
  • func (s *Server) RegisterUDPServer(name, address string, server interface{ ... }) error
  • func (s *Server) Run(ctx context.Context) (err error)

Types

type Config

type Config struct {
	ListenHTTP         string
	ListenGRPC         string
	ListenInternalHTTP string
	ListenInternalGRPC string
}

Config is the required configuration for the server.

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig returns the default config for the server.

func (*Config) Flags

func (c *Config) Flags(prefix string, defaults *Config) *pflag.FlagSet

Flags returns a flagset that can be added to the command line.

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option is an option for the server.

func WithGRPCOptions

func WithGRPCOptions(opts ...grpc.Option) Option

WithGRPCOptions returns an Option that adds the given GRPC options.

func WithHTTPOptions

func WithHTTPOptions(opts ...http.Option) Option

WithHTTPOptions returns an Option that adds the given HTTP options.

func WithInternalGRPCOptions

func WithInternalGRPCOptions(opts ...grpc.Option) Option

WithInternalGRPCOptions returns an Option that adds the given GRPC options for the internal server.

func WithInternalHTTPOptions

func WithInternalHTTPOptions(opts ...http.Option) Option

WithInternalHTTPOptions returns an Option that adds the given HTTP options for the internal server.

type Server

type Server struct {
	GRPC *grpc.Server
	HTTP *http.Server

	InternalGRPC *grpc.Server
	InternalHTTP *http.Server
	// contains filtered or unexported fields
}

Server wraps gRPC and HTTP servers.

func New

func New(config Config, opts ...Option) *Server

New instantiates a new server that uses the config and options.

func (*Server) RegisterTCPServer

func (s *Server) RegisterTCPServer(name, address string, server interface {
	Serve(lis net.Listener) error
	GracefulStop() error
}) error

RegisterTCPServer registers the named TCP server on address.

func (*Server) RegisterUDPServer

func (s *Server) RegisterUDPServer(name, address string, server interface {
	Serve(conn net.PacketConn) error
	GracefulStop() error
}) error

RegisterUDPServer registers the named UDP server on address.

func (*Server) Run

func (s *Server) Run(ctx context.Context) (err error)

Run runs the server until the Done channel of ctx is closed.