temporal

Documentation

Index

• Variables
• func InterruptCh() <-chan interface{}
• type Server
  • func NewServer(opts ...ServerOption) *Server
  • func (s *Server) Start() error
  • func (s *Server) Stop()
• type ServerOption
  • func ForServices(names []string) ServerOption
  • func InterruptOn(interruptCh <-chan interface{}) ServerOption
  • func WithAuthorizer(authorizer authorization.Authorizer) ServerOption
  • func WithClaimMapper(claimMapper func(cfg *config.Config) authorization.ClaimMapper) ServerOption
  • func WithConfig(cfg *config.Config) ServerOption
  • func WithConfigLoader(configDir string, env string, zone string) ServerOption
  • func WithCustomMetricsReporter(reporter tally.BaseStatsReporter) ServerOption
  • func WithElasticsearchHttpClient(c *http.Client) ServerOption
  • func WithPersistenceServiceResolver(r resolver.ServiceResolver) ServerOption
  • func WithTLSConfigFactory(tlsConfigProvider encryption.TLSConfigProvider) ServerOption

Variables

var (
	Services = []string{
		primitives.FrontendService,
		primitives.HistoryService,
		primitives.MatchingService,
		primitives.WorkerService,
	}
)

Services is the list of all valid temporal services

Functions

func InterruptCh

func InterruptCh() <-chan interface{}

Types

type Server

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

Server is temporal server.

func NewServer

func NewServer(opts ...ServerOption) *Server

NewServer returns a new instance of server that serves one or many services.

func (*Server) Start

func (s *Server) Start() error

Start temporal server.

func (*Server) Stop

func (s *Server) Stop()

Stops the server.

type ServerOption

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

func ForServices

func ForServices(names []string) ServerOption

func InterruptOn

func InterruptOn(interruptCh <-chan interface{}) ServerOption

InterruptOn interrupts server on the signal from server. If channel is nil Start() will block forever.

func WithAuthorizer

func WithAuthorizer(authorizer authorization.Authorizer) ServerOption

Sets low level authorizer to allow/deny all API calls

func WithClaimMapper

func WithClaimMapper(claimMapper func(cfg *config.Config) authorization.ClaimMapper) ServerOption

Configures a role mapper for authorization

func WithConfig

func WithConfig(cfg *config.Config) ServerOption

func WithConfigLoader

func WithConfigLoader(configDir string, env string, zone string) ServerOption

func WithCustomMetricsReporter

func WithCustomMetricsReporter(reporter tally.BaseStatsReporter) ServerOption

Set custom tally metric reporter

func WithElasticsearchHttpClient

func WithElasticsearchHttpClient(c *http.Client) ServerOption

Set custom persistence service resolver which will convert service name or address value from config to another a....

func WithPersistenceServiceResolver

func WithPersistenceServiceResolver(r resolver.ServiceResolver) ServerOption

Set custom persistence service resolver which will convert service name or address value from config to another a....

func WithTLSConfigFactory

func WithTLSConfigFactory(tlsConfigProvider encryption.TLSConfigProvider) ServerOption

Overrides default provider of TLS configuration