run

Documentation

Index

• func CadenceWorkerActor(worker CadenceWorker) (execute func() error, interrupt func(error))
• func CadenceWorkerRun(worker CadenceWorker) (execute func() error, interrupt func(error))
• func GRPCServe(server GRPCServer, lis net.Listener) (execute func() error, interrupt func(error))
• func GracefulRestart(ctx context.Context, upg Upgrader) (execute func() error, interrupt func(error))
• func HTTPServe(server HTTPServer, lis net.Listener, shutdownTimeout time.Duration) (execute func() error, interrupt func(error))
• func TemporalWorkerActor(worker TemporalWorker) (execute func() error, interrupt func(error))
• type CadenceWorker
• type GRPCServer
• type HTTPServer
• type ServeLogger
• type TemporalWorker
• type Upgrader
• type Wrapper
  • func LogServe(logger ServeLogger) Wrapper

Functions

func CadenceWorkerActor

func CadenceWorkerActor(worker CadenceWorker) (execute func() error, interrupt func(error))

CadenceWorkerActor returns an actor, i.e. an execute and interrupt func, that terminates when the underlying worker fails or stops running.

Although the Cadence Worker component has a blocking Run function, internally it waits for a SIGTERM signal which does not fit perfectly into run group.

See https://github.com/uber-go/cadence-client/issues/642

func CadenceWorkerRun

func CadenceWorkerRun(worker CadenceWorker) (execute func() error, interrupt func(error))

Deprecated: use CadenceWorkerActor instead.

func GRPCServe

func GRPCServe(server GRPCServer, lis net.Listener) (execute func() error, interrupt func(error))

GRPCServe returns an actor, i.e. an execute and interrupt func, that terminates when the underlying gRPC server fails.

func GracefulRestart

func GracefulRestart(ctx context.Context, upg Upgrader) (execute func() error, interrupt func(error))

GracefulRestart returns an actor, i.e. an execute and interrupt func, that terminates when graceful restart is initiated and the child process signals to be ready, or the parent context is canceled.

func HTTPServe

func HTTPServe(
	server HTTPServer,
	lis net.Listener,
	shutdownTimeout time.Duration,
) (execute func() error, interrupt func(error))

HTTPServe returns an actor, i.e. an execute and interrupt func, that terminates when the underlying HTTP server fails.

It accepts a timeout parameter for the graceful shutdown. 0 means no timeout.

func TemporalWorkerActor

func TemporalWorkerActor(worker TemporalWorker) (execute func() error, interrupt func(error))

TemporalWorkerActor returns an actor, i.e. an execute and interrupt func, that terminates when the underlying worker fails or stops running.

Although the Temporal Worker component has a blocking Run function, internally it waits for a SIGTERM signal which does not fit perfectly into run group.

See https://github.com/temporalio/temporal-go-sdk/issues/94

Types

type CadenceWorker

type CadenceWorker interface {
	// Start starts the worker in a non-blocking fashion.
	Start() error

	// Stop cleans up any resources opened by worker.
	Stop()
}

CadenceWorker is an Uber Cadence worker instance.

See https://godoc.org/go.uber.org/cadence/internal#Worker

type GRPCServer

type GRPCServer interface {
	Serve(lis net.Listener) error
	GracefulStop()
}

GRPCServer is a gRPC server.

type HTTPServer

type HTTPServer interface {
	Serve(lis net.Listener) error
	Shutdown(ctx context.Context) error
}

HTTPServer is an HTTP server.

type ServeLogger

type ServeLogger interface {
	// Info logs an Info event.
	Info(msg string, fields ...map[string]interface{})
}

ServeLogger logs server start/shutdown events.

type TemporalWorker

type TemporalWorker interface {
	// Start starts the worker in a non-blocking fashion.
	Start() error

	// Stop cleans up any resources opened by worker.
	Stop()
}

TemporalWorker is a Temporal worker instance.

See: https://github.com/temporalio/temporal-go-sdk

type Upgrader

type Upgrader interface {
	Ready() error
	Exit() <-chan struct{}
	Stop()
}

Upgrader handles zero downtime upgrades and passing files between processes.

Upgrader is based on https://github.com/cloudflare/tableflip.

type Wrapper

type Wrapper func(execute func() error, interrupt func(error)) (func() error, func(error))

Wrapper is an actor that wraps another actor. It is useful for creating middleware.

func LogServe

func LogServe(logger ServeLogger) Wrapper

LogServe returns an actor, i.e. an execute and interrupt func, that logs a message when a server is being started/shut down.