context

Documentation

Index

• type Cancellable
  • func NewCancellable() Cancellable
  • func NewNoOpCanncellable() Cancellable
• type Context
  • func NewContext() Context
• type Options
  • func NewOptions() Options
• type Pool
  • func NewPool(opts Options) Pool

Types

type Cancellable

type Cancellable interface {
	// IsCancelled determines whether the object is cancelled.
	IsCancelled() bool

	// Cancel cancels the object.
	Cancel()

	// Reset resets the object.
	Reset()
}

Cancellable is an object that can be cancelled.

func NewCancellable

func NewCancellable() Cancellable

NewCancellable creates a new cancellable object

func NewNoOpCanncellable

func NewNoOpCanncellable() Cancellable

NewNoOpCanncellable returns a no-op cancellable

type Context

type Context interface {
	// IsClosed returns whether the context is closed.
	IsClosed() bool

	// RegisterFinalizer will register a resource finalizer.
	RegisterFinalizer(resource.Finalizer)

	// RegisterCloser will register a resource closer.
	RegisterCloser(resource.Closer)

	// DependsOn will register a blocking context that
	// must complete first before finalizers can be called.
	DependsOn(Context)

	// Close will close the context.
	Close()

	// BlockingClose will close the context and call the
	// registered finalizers in a blocking manner after waiting
	// for any dependent contexts to close. After calling
	// the context becomes safe to reset and reuse again
	// if and only if it is not a pooled context.
	BlockingClose()

	// Reset will reset the context for reuse.
	Reset()

	// BlockingCloseReset will close the context and call the
	// registered finalizers in a blocking manner after waiting
	// for any dependent contexts to close. After calling
	// the context becomes reset and is safe for reuse again as it
	// will not be returned to a pool.
	BlockingCloseReset()

	// GoContext returns the Go std context.
	GoContext() (stdctx.Context, bool)

	// SetGoContext sets the Go std context.
	SetGoContext(stdctx.Context)

	// StartTraceSpan starts a new span and returns a child ctx.
	StartTraceSpan(string) (Context, opentracing.Span)

	// StartSampledTraceSpan starts a new span and returns a child ctx
	// and a bool if the span is being sampled. This is used over StartTraceSpan()
	// for hot paths where performance is crucial.
	StartSampledTraceSpan(string) (Context, opentracing.Span, bool)
}

Context provides context to an operation.

func NewContext

func NewContext() Context

NewContext creates a new context.

type Options

type Options interface {
	// SetContextPoolOptions sets the context pool options.
	SetContextPoolOptions(pool.ObjectPoolOptions) Options

	// ContextPoolOptions returns the context pool options.
	ContextPoolOptions() pool.ObjectPoolOptions

	// SetFinalizerPoolOptions sets the finalizer pool options.
	SetFinalizerPoolOptions(pool.ObjectPoolOptions) Options

	// FinalizerPoolOptions returns the finalizer pool options.
	FinalizerPoolOptions() pool.ObjectPoolOptions
}

Options controls knobs for context pooling.

func NewOptions

func NewOptions() Options

NewOptions returns a new Options object.

type Pool

type Pool interface {
	// Get provides a context from the pool.
	Get() Context

	// Put returns a context to the pool.
	Put(Context)
}

Pool provides a pool for contexts.

func NewPool

func NewPool(opts Options) Pool

NewPool creates a new context pool.