server

type GRPCOptions ¶ added in v0.1.6

type GRPCOptions struct {
	Addr       string
	MaxMsgSize int `mapstructure:"max-msg-size"`
}

GRPCOptions defines options for building a GRPCServer.

type GRPCServer ¶

type GRPCServer struct {
	*grpc.Server
	// contains filtered or unexported fields
}

func NewGRPCServer() (*GRPCServer, error)

func (s *GRPCServer) Run() error

func (s *GRPCServer) Shutdown(_ context.Context) error

type HTTPOptions ¶ added in v0.1.6

type HTTPOptions struct {
	Mode        string
	Addr        string
	Middlewares []string
	PingTimeout time.Duration `mapstructure:"ping-timeout"`
	Healthz     bool
	Metrics     bool
	Profiling   bool
}

HTTPOptions defines options for building an HTTPServer.

type HTTPServer ¶

type HTTPServer struct {
	*gin.Engine
	// contains filtered or unexported fields
}

HTTPServer is both a HTTPServer and a gin.Engine.

func NewHTTPServer() (*HTTPServer, error)

func (s *HTTPServer) Run() error

func (s *HTTPServer) Shutdown(ctx context.Context) error

type Option ¶ added in v0.3.0

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

Option configures the server.

func WithGRPC() Option

func WithShutdown(sd shutdown.ShutdownFunc) Option

type OptionFunc ¶ added in v0.3.0

type OptionFunc func(*Server)

OptionFunc wraps a func so it satisfies the Option interface.

type Servable ¶

type Servable interface {
	Run() error
	Shutdown(context.Context) error
}

Servable defines the behavior of a server.

type Server ¶

type Server struct {
	Name       string
	HTTPServer *HTTPServer
	GRPCServer *GRPCServer
	// contains filtered or unexported fields
}

Server defines the structure of a server.

func NewServer(name string, opts ...Option) (*Server, error)

func (s *Server) Run() error