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 WithAudienceGetter(audienceGetter func(cfg *config.Config) authorization.JWTAudienceMapper) ServerOption
  • func WithAuthorizer(authorizer authorization.Authorizer) ServerOption
  • func WithClaimMapper(claimMapper func(cfg *config.Config) authorization.ClaimMapper) ServerOption
  • func WithClientFactoryProvider(clientFactoryProvider client.FactoryProvider) ServerOption
  • func WithConfig(cfg *config.Config) ServerOption
  • func WithConfigLoader(configDir string, env string, zone string) ServerOption
  • func WithCustomDataStoreFactory(customFactory persistenceclient.AbstractDataStoreFactory) ServerOption
  • func WithCustomMetricsReporter(reporter interface{}) ServerOption
  • func WithDynamicConfigClient(c dynamicconfig.Client) ServerOption
  • func WithElasticsearchHttpClient(c *http.Client) ServerOption
  • func WithLogger(logger log.Logger) ServerOption
  • func WithNamespaceLogger(namespaceLogger log.Logger) ServerOption
  • func WithPersistenceServiceResolver(r resolver.ServiceResolver) ServerOption
  • func WithSearchAttributesMapper(m searchattribute.Mapper) 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()

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 WithAudienceGetter

func WithAudienceGetter(audienceGetter func(cfg *config.Config) authorization.JWTAudienceMapper) ServerOption

Configures JWT audience getter for authorization

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 WithClientFactoryProvider

func WithClientFactoryProvider(clientFactoryProvider client.FactoryProvider) ServerOption

WithClientFactoryProvider sets a custom ClientFactoryProvider NOTE: this option is experimental and may be changed or removed in future release.

func WithConfig

func WithConfig(cfg *config.Config) ServerOption

func WithConfigLoader

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

func WithCustomDataStoreFactory

func WithCustomDataStoreFactory(customFactory persistenceclient.AbstractDataStoreFactory) ServerOption

WithCustomDataStoreFactory sets a custom AbstractDataStoreFactory NOTE: this option is experimental and may be changed or removed in future release.

func WithCustomMetricsReporter

func WithCustomMetricsReporter(reporter interface{}) ServerOption

Set custom metric reporter for (deprecated) Tally it should be tally.BaseStatsReporter for Prometheus with framework metrics.FrameworkCustom it should be metrics.Reporter not used otherwise TODO: replace argument type with metrics.Reporter once tally is deprecated.

func WithDynamicConfigClient

func WithDynamicConfigClient(c dynamicconfig.Client) ServerOption

Set custom dynmaic config client

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 WithLogger

func WithLogger(logger log.Logger) ServerOption

func WithNamespaceLogger

func WithNamespaceLogger(namespaceLogger log.Logger) ServerOption

Sets optional logger for all frontend operations

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 WithSearchAttributesMapper

func WithSearchAttributesMapper(m searchattribute.Mapper) ServerOption

Set custom search attributes mapper which converts search attributes aliases to field names and vice versa.

func WithTLSConfigFactory

func WithTLSConfigFactory(tlsConfigProvider encryption.TLSConfigProvider) ServerOption

Overrides default provider of TLS configuration