server

package

v0.0.0-...-fc4206c Latest Latest Go to latest Published: Dec 19, 2023 License: Apache-2.0 Imports: 12 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/htdvisser/exp

Links

Open Source Insights

Documentation ¶

Index ¶

type Config
- func DefaultConfig() *Config
- func (c *Config) Flags(prefix string, defaults *Config) *pflag.FlagSet
type Option
type Server
- func New(config Config, opts ...Option) *Server

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cookie Package cookie provides middleware for working with device, session and user session cookies.	Package cookie provides middleware for working with device, session and user session cookies.
grpc Package grpc provides the backbone for a gRPC server with some opinionated defaults.	Package grpc provides the backbone for a gRPC server with some opinionated defaults.
http Package http provides the backbone for an HTTP server with some opinionated defaults.	Package http provides the backbone for an HTTP server with some opinionated defaults.
internal
channelz Package channelz can be used to expose the channelz service on the gRPC server.	Package channelz can be used to expose the channelz service on the gRPC server.
packet Package packet provides the backbone for a UDP packet server with some opinionated defaults.	Package packet provides the backbone for a UDP packet server with some opinionated defaults.
recovery Package recovery can be used to add panic recovery middleware to the server.	Package recovery can be used to add panic recovery middleware to the server.
reflection Package reflection can be used to support gRPC server reflection on the server.	Package reflection can be used to support gRPC server reflection on the server.
stream Package stream provides the backbone for a TCP stream server with some opinionated defaults.	Package stream provides the backbone for a TCP stream server with some opinionated defaults.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL