server

Documentation

Index

• Variables
• func Concurrency(n int) concurrencyOption
• func EphemeralStorage() ephemeralStorageOption
• func GrpcPort(port int) grpcPortOption
• func NatsConn(conn *nats.Conn) natsConnOption
• func NatsUrl(url string) natsUrlOption
• func PanicRecovery(enabled bool) panicOption
• func PreventOrphanServiceTasks() orphanTaskOption
• func WithApiAuthorizer(authFn authz.APIFunc) apiAuthorizerOption
• func WithAuthentication(authFn authn.Check) authenticationOption
• func WithNoHealthServer() noHealthServerOption
• func WithSharVersion(version *version2.Version) sharVersionOption
• func WithTelemetryEndpoint(endpoint string) telemetryEndpointOption
• type Option
• type Server
  • func New(options ...Option) *Server
  • func (s *Server) Details()
  • func (s *Server) GetEndPoint() string
  • func (s *Server) Listen()
  • func (s *Server) Ready() bool
  • func (s *Server) Shutdown()

Variables

var (
	VersionTag string
	CommitHash string
	BuildDate  string
)

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

Functions

func Concurrency

func Concurrency(n int) concurrencyOption

Concurrency specifies the number of threads for each of SHAR's queue listeneres.

func EphemeralStorage

func EphemeralStorage() ephemeralStorageOption

EphemeralStorage instructs SHAR to use memory rather than disk for storage. This is not recommended for production use.

func GrpcPort

func GrpcPort(port int) grpcPortOption

GrpcPort specifies the port healthcheck is listening on

func NatsConn

func NatsConn(conn *nats.Conn) natsConnOption

NatsConn specifies the nats Conn to use

func NatsUrl

func NatsUrl(url string) natsUrlOption

NatsUrl specifies the nats URL to connect to

func PanicRecovery

func PanicRecovery(enabled bool) panicOption

PanicRecovery enables or disables SHAR's ability to recover from server panics. This is on by default, and disabling it is not recommended for production use.

func PreventOrphanServiceTasks

func PreventOrphanServiceTasks() orphanTaskOption

PreventOrphanServiceTasks enables or disables SHAR's validation of service task names againt existing workflows.

func WithApiAuthorizer

func WithApiAuthorizer(authFn authz.APIFunc) apiAuthorizerOption

WithApiAuthorizer specifies a handler function for API authorization.

func WithAuthentication

func WithAuthentication(authFn authn.Check) authenticationOption

WithAuthentication specifies a handler function for API authorization.

func WithNoHealthServer

func WithNoHealthServer() noHealthServerOption

WithNoHealthServer specifies a handler function for API authorization.

func WithSharVersion

func WithSharVersion(version *version2.Version) sharVersionOption

WithSharVersion instructs SHAR to claim it is a specific version. This is highly inadvisable as datalos may occur.

func WithTelemetryEndpoint

func WithTelemetryEndpoint(endpoint string) telemetryEndpointOption

WithTelemetryEndpoint specifies a handler function for API authorization.

Types

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option represents a SHAR server option

type Server

type Server struct {
	SharVersion *version.Version
	// contains filtered or unexported fields
}

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

func New

func New(options ...Option) *Server

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

func (*Server) Details

func (s *Server) Details()

Details prints the details to stdout of the current SHAR server.

func (*Server) GetEndPoint

func (s *Server) GetEndPoint() string

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

func (*Server) Listen

func (s *Server) Listen()

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

func (*Server) Ready

func (s *Server) Ready() bool

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

func (*Server) Shutdown

func (s *Server) Shutdown()

Shutdown gracefully shuts down the GRPC server, and requests that