api

Documentation

Index

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

Types

type Server

type Server interface {
	// Run starts the API server and blocks the calling goroutine
	Run() error

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

	// Addr returns the server's host address
	Addr() string

	// Store returns the server's store interface
	Store() store.Store
}

Server interfaces an API server implementation

func NewServer

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

NewServer creates a new API server instance