server

Documentation

Index

• func EphemeralStorage() ephemeralStorageOption
• func PanicRecovery(enabled bool) panicOption
• type Option
• type Server
  • func New(log *zap.Logger, options ...Option) *Server
  • func (s *Server) Listen(natsURL string, grpcPort int)
  • func (s *Server) Ready() bool
  • func (s *Server) Shutdown()

Functions

func EphemeralStorage

func EphemeralStorage() ephemeralStorageOption

EphemeralStorage instructs SHAR to use memory rather than disk for storage. This is not recommended for production use.

func PanicRecovery

func PanicRecovery(enabled bool) panicOption

PanicRecovery enables or disables SHAR's ability to recover from server panics. This is on by default, and disabling it is not recommended for production use.

Types

type Option

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

Option represents a SHAR server option

type Server

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

func New

func New(log *zap.Logger, options ...Option) *Server

New creates a new SHAR server. Leave the exporter nil if telemetry is not required

func (*Server) Listen

func (s *Server) Listen(natsURL string, grpcPort int)

Listen starts the GRPC server for both serving requests, and thw GRPC health endpoint.

func (*Server) Ready

func (s *Server) Ready() bool

func (*Server) Shutdown

func (s *Server) Shutdown()

Shutdown gracefully shuts down the GRPC server, and requests that