options

Documentation

Index

• type AttachOption
• type AttachOptions
• type AwakeableOption
• type AwakeableOptions
• type ClientOption
• type ClientOptions
• type GetOption
• type GetOptions
• type HandlerOption
• type HandlerOptions
• type PromiseOption
• type PromiseOptions
• type RequestOption
• type RequestOptions
• type ResolveAwakeableOption
• type ResolveAwakeableOptions
• type RunOption
• type RunOptions
• type SendOption
• type SendOptions
• type ServiceDefinitionOption
• type ServiceDefinitionOptions
• type SetOption
• type SetOptions
• type SleepOption
• type SleepOptions

Types

type AttachOption

type AttachOption interface {
	BeforeAttach(*AttachOptions)
}

type AttachOptions

type AttachOptions struct {
	Codec encoding.Codec
}

type AwakeableOption

type AwakeableOption interface {
	BeforeAwakeable(*AwakeableOptions)
}

type AwakeableOptions

type AwakeableOptions struct {
	Codec encoding.Codec
}

type ClientOption

type ClientOption interface {
	BeforeClient(*ClientOptions)
}

type ClientOptions

type ClientOptions struct {
	Codec encoding.Codec
}

type GetOption

type GetOption interface {
	BeforeGet(*GetOptions)
}

type GetOptions

type GetOptions struct {
	Codec encoding.Codec
}

type HandlerOption

type HandlerOption interface {
	BeforeHandler(*HandlerOptions)
}

type HandlerOptions

type HandlerOptions struct {
	Codec         encoding.PayloadCodec
	Metadata      map[string]string
	Documentation string
}

type PromiseOption

type PromiseOption interface {
	BeforePromise(*PromiseOptions)
}

type PromiseOptions

type PromiseOptions struct {
	Codec encoding.Codec
}

type RequestOption

type RequestOption interface {
	BeforeRequest(*RequestOptions)
}

type RequestOptions

type RequestOptions struct {
	IdempotencyKey string
	Headers        map[string]string
}

type ResolveAwakeableOption

type ResolveAwakeableOption interface {
	BeforeResolveAwakeable(*ResolveAwakeableOptions)
}

type ResolveAwakeableOptions

type ResolveAwakeableOptions struct {
	Codec encoding.Codec
}

type RunOption

type RunOption interface {
	BeforeRun(*RunOptions)
}

type RunOptions

type RunOptions struct {
	// MaxRetryAttempts before giving up.
	//
	// When giving up, Run will return a TerminalError wrapping the original error message.
	MaxRetryAttempts *uint

	// MaxRetryDuration before giving up.
	//
	// When giving up, Run will return a TerminalError wrapping the original error message.
	MaxRetryDuration *time.Duration

	// InitialRetryInterval for the first retry attempt.
	//
	// The retry interval will grow by a factor specified in RetryIntervalFactor.
	//
	// If any of the other retry options are set, this will be set by default to 50 milliseconds.
	InitialRetryInterval *time.Duration

	// RetryIntervalFactor to use when computing the next retry delay.
	//
	// If any of the other retry options are set, this will be set by default to 2, meaning retry interval will double at each attempt.
	RetryIntervalFactor *float32

	// MaxRetryInterval between retries.
	// Retry interval will grow by a factor specified in RetryIntervalFactor up to the interval specified in this value.
	//
	// If any of the other retry options are set, this will be set by default to 2 seconds.
	MaxRetryInterval *time.Duration

	// Name used for observability.
	Name string

	// Codec used to encode/decode the run result.
	Codec encoding.Codec
}

type SendOption

type SendOption interface {
	BeforeSend(*SendOptions)
}

type SendOptions

type SendOptions struct {
	IdempotencyKey string
	Headers        map[string]string
	Delay          time.Duration
}

type ServiceDefinitionOption

type ServiceDefinitionOption interface {
	BeforeServiceDefinition(*ServiceDefinitionOptions)
}

type ServiceDefinitionOptions

type ServiceDefinitionOptions struct {
	DefaultCodec  encoding.PayloadCodec
	Metadata      map[string]string
	Documentation string
}

type SetOption

type SetOption interface {
	BeforeSet(*SetOptions)
}

type SetOptions

type SetOptions struct {
	Codec encoding.Codec
}

type SleepOption

type SleepOption interface {
	BeforeSleep(*SleepOptions)
}

type SleepOptions

type SleepOptions struct {
	// Name used for observability.
	Name string
}