context

Documentation

Index

• func Background() *context
• func FromContext(ctx stdcontext.Context) *context
• func GetCorrelationID(ctx stdcontext.Context) string
• func New(opts ...Option) *context
• func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc)
• type CancelFunc
  • func WithCancel(parent stdcontext.Context) (*context, CancelFunc)
• type Context
• type Option
  • func WithArgument(key string, value interface{}) Option
  • func WithArguments(args map[string]interface{}) Option
  • func WithCorrelationID(cID string) Option
  • func WithMethod(method string) Option
  • func WithParent(parent Context) Option

Functions

func Background

func Background() *context

Background context wrapper

func FromContext

func FromContext(ctx stdcontext.Context) *context

FromContext returns a new context from a parent

func GetCorrelationID

func GetCorrelationID(ctx stdcontext.Context) string

GetCorrelationID returns the correlation if there is one

func New

func New(opts ...Option) *context

New constructs a new *context from a parent Context and Options

func WithTimeout

func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc)

WithTimeout wraps stdcontext.WithTimeout

Types

type CancelFunc

type CancelFunc func()

A CancelFunc tells an operation to abandon its work

func WithCancel

func WithCancel(parent stdcontext.Context) (*context, CancelFunc)

WithCancel returns a copy of parent with a new Done channel

type Context

type Context stdcontext.Context

Context that matches std context

type Option

type Option func(*context)

Option allows configuring the context

func WithArgument

func WithArgument(key string, value interface{}) Option

WithArgument sets a Context argument

func WithArguments

func WithArguments(args map[string]interface{}) Option

WithArguments sets the Context arguments

func WithCorrelationID

func WithCorrelationID(cID string) Option

WithCorrelationID sets the CorrelationID

func WithMethod

func WithMethod(method string) Option

WithMethod sets the Context method name

func WithParent

func WithParent(parent Context) Option

WithParent sets the context's parent context