gserver

Documentation

Index

• type GRPCRegistrator
• type RouteRegistrator
• type Server
  • func Start(name string, cfg *config.HTTPServer, container *dig.Container, ...) (e *Server, err error)
  • func (e *Server) AddService(svc Service)
  • func (e *Server) Audit(source string, eventType string, identity string, contextID string, ...)
  • func (e *Server) Close()
  • func (e *Server) Configuration() *config.HTTPServer
  • func (e *Server) Discovery() appcontainer.Discovery
  • func (e *Server) Err() <-chan error
  • func (e *Server) Hostname() string
  • func (e *Server) IsReady() bool
  • func (e *Server) ListenURLs() []string
  • func (e *Server) LocalIP() string
  • func (e *Server) Name() string
  • func (e *Server) Service(name string) Service
  • func (e *Server) StartedAt() time.Time
• type Service
• type ServiceFactory
• type StartSubcriber

Types

type GRPCRegistrator

type GRPCRegistrator interface {
	RegisterGRPC(*grpc.Server)
}

GRPCRegistrator provides interface to register gRPC service

type RouteRegistrator

type RouteRegistrator interface {
	RegisterRoute(rest.Router)
}

RouteRegistrator provides interface to register HTTP route

type Server

type Server struct {
	Listeners []net.Listener
	// contains filtered or unexported fields
}

Server contains a running trusty server and its listeners.

func Start

func Start(
	name string,
	cfg *config.HTTPServer,
	container *dig.Container,
	serviceFactories map[string]ServiceFactory,
) (e *Server, err error)

Start returns running Server

func (*Server) AddService

func (e *Server) AddService(svc Service)

AddService to the server

func (*Server) Audit

func (e *Server) Audit(
	source string,
	eventType string,
	identity string,
	contextID string,
	raftIndex uint64,
	message string)

Audit create an audit event

func (*Server) Close

func (e *Server) Close()

Close gracefully shuts down all servers/listeners. Client requests will be terminated with request timeout. After timeout, enforce remaning requests be closed immediately.

func (*Server) Configuration

func (e *Server) Configuration() *config.HTTPServer

Configuration of the server

func (*Server) Discovery

func (e *Server) Discovery() appcontainer.Discovery

Discovery returns Discovery interface

func (*Server) Err

func (e *Server) Err() <-chan error

Err returns error channel

func (*Server) Hostname

func (e *Server) Hostname() string

Hostname is the hostname

func (*Server) IsReady

func (e *Server) IsReady() bool

IsReady returns true when the server is ready to serve

func (*Server) ListenURLs

func (e *Server) ListenURLs() []string

ListenURLs is the list of URLs that the server listens on

func (*Server) LocalIP

func (e *Server) LocalIP() string

LocalIP is the local IP4

func (*Server) Name

func (e *Server) Name() string

Name returns server name

func (*Server) Service

func (e *Server) Service(name string) Service

Service returns service by name

func (*Server) StartedAt

func (e *Server) StartedAt() time.Time

StartedAt returns Time when the server has started

type Service

type Service interface {
	Name() string
	Close()
	// IsReady indicates that service is ready to serve its end-points
	IsReady() bool
}

Service provides a way for subservices to be registered so they get added to the http API.

type ServiceFactory

type ServiceFactory func(*Server) interface{}

ServiceFactory is interface to create Services

type StartSubcriber

type StartSubcriber interface {
	// OnStarted is called when the server started and
	// is ready to serve requests
	OnStarted() error
}

StartSubcriber provides