server

package

v0.0.0-...-9aa8380 Latest Latest Go to latest Published: Jun 11, 2022 License: AGPL-3.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Server struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewServer(cfg *config.ServerConfig, logger hclog.Logger) *Server

func (s *Server) FailedNotify() <-chan struct{}

FailedNotify returns a channel that will be closed when the server has failed to start.

func (s *Server) OnAdminEvent(ctx context.Context, request *eventlistener.AdminEventRequest) (*shared.Empty, error)

OnAdminEvent is the implementation of the OnAdminEvent protobuf service.

func (s *Server) OnEvent(ctx context.Context, request *eventlistener.EventRequest) (*shared.Empty, error)

OnEvent is the implementation of the OnEvent protobuf service.

func (s *Server) ReadyNotify() <-chan struct{}

ReadyNotify returns a channel that will be closed when the server is ready to serve client requests.

func (s *Server) Start()

func (s *Server) StartFailureReason() error

StartFailureReason returns an error which caused the server not to start.

func (s *Server) Stop()

Stop stops the server, if the server is started.

func (s *Server) StoppedNotify() <-chan struct{}

StoppedNotify returns a channel that will be closed when the server has stopped.