api

Documentation

Index

• type Server
  • func NewServer(conf *config.ServerConfig) (Server, error)

Types

type Server

type Server interface {
	// Launche starts the API server and unblocks as soon as the server
	// is running
	Launch() error

	// Shutdown instructs the server to shut down gracefully and blocks until
	// the server is shut down
	Shutdown(context.Context) error

	// AwaitShutdown blocks until the server is shut down
	AwaitShutdown()
}

Server interfaces an API server implementation

func NewServer

func NewServer(conf *config.ServerConfig) (Server, error)

NewServer creates a new API server instance