server

Documentation

Index

• type Listeners
  • func (l *Listeners) Close() error
• type Options
• type Server
  • func NewServer(opts Options) *Server
  • func (s *Server) Run(ctx context.Context) error
  • func (s *Server) Stop(ctx context.Context)

Types

type Listeners

type Listeners struct {
	// Main handle all incoming requests.
	Main net.Listener

	// GWConn forwards HTTP requests to the gRPC server.
	GWConn *grpc.ClientConn
}

Listeners combines the API server listeners and forwarders.

func (*Listeners) Close

func (l *Listeners) Close() error

Close all underlying connections (i.e. listeners and forwarders).

type Options

type Options struct {
	Port    int
	Swagger bool
	UI      bool
}

Options to configure it once for all.

type Server

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

Server is a helper to manager an API Server.

func NewServer

func NewServer(opts Options) *Server

NewServer returns a fresh API server.

func (*Server) Run

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

Run the API server in backend. It first start the listeners then proceed to launch the connection multiplexers for the gRPC server and its HTTP gateway.

func (*Server) Stop

func (s *Server) Stop(ctx context.Context)