server

package

v1.1.1188 Latest Latest Go to latest Published: Jun 19, 2024 License: MIT Imports: 26 Imported by: 0

Details

This section is empty.

View Source

var (
	VersionTag string
	CommitHash string
	BuildDate  string
)

The following variables are set by -ldflags at build time.

This section is empty.

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

Server is the shar server type responsible for hosting the SHAR API.

func New(options ...option.Option) (*Server, error)

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

func (s *Server) GetEndPoint() string

GetEndPoint will return the URL of the GRPC health endpoint for the shar server

func (s *Server) Listen() error

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

func (s *Server) Ready() bool

Ready returns true if the SHAR server is servicing API calls.

func (s *Server) Shutdown()

Shutdown gracefully shuts down the GRPC server, and requests that

Path	Synopsis
option