mirror of
https://github.com/rocky-linux/peridot.git
synced 2024-12-26 04:00:55 +00:00
90 lines
4.1 KiB
Go
90 lines
4.1 KiB
Go
// The MIT License
|
|
//
|
|
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
|
|
//
|
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
|
|
package workflow
|
|
|
|
import (
|
|
"go.temporal.io/sdk/internal"
|
|
)
|
|
|
|
// Context is a clone of context.Context with Done() returning Channel instead
|
|
// of native channel.
|
|
// A Context carries a deadline, a cancellation signal, and other values across
|
|
// API boundaries.
|
|
//
|
|
// Context's methods may be called by multiple goroutines simultaneously.
|
|
type Context = internal.Context
|
|
|
|
// ContextAware is an optional interface that can be implemented alongside
|
|
// DataConverter. This interface allows Temporal to pass Workflow/Activity
|
|
// contexts to the DataConverter so that it may tailor it's behaviour.
|
|
//
|
|
// Note that data converters may be called in non-context-aware situations to
|
|
// convert payloads that may not be customized per context. Data converter
|
|
// implementers should not expect or require contextual data be present.
|
|
type ContextAware = internal.ContextAware
|
|
|
|
// ErrCanceled is the error returned by Context.Err when the context is canceled.
|
|
var ErrCanceled = internal.ErrCanceled
|
|
|
|
// ErrDeadlineExceeded is the error returned by Context.Err when the context's
|
|
// deadline passes.
|
|
var ErrDeadlineExceeded = internal.ErrDeadlineExceeded
|
|
|
|
// A CancelFunc tells an operation to abandon its work.
|
|
// A CancelFunc does not wait for the work to stop.
|
|
// After the first call, subsequent calls to a CancelFunc do nothing.
|
|
type CancelFunc = internal.CancelFunc
|
|
|
|
// WithCancel returns a copy of parent with a new Done channel. The returned
|
|
// context's Done channel is closed when the returned cancel function is called
|
|
// or when the parent context's Done channel is closed, whichever happens first.
|
|
//
|
|
// Canceling this context releases resources associated with it, so code should
|
|
// call cancel as soon as the operations running in this Context complete.
|
|
func WithCancel(parent Context) (ctx Context, cancel CancelFunc) {
|
|
return internal.WithCancel(parent)
|
|
}
|
|
|
|
// WithValue returns a copy of parent in which the value associated with key is
|
|
// val.
|
|
//
|
|
// Use context Values only for request-scoped data that transits processes and
|
|
// APIs, not for passing optional parameters to functions.
|
|
func WithValue(parent Context, key interface{}, val interface{}) Context {
|
|
return internal.WithValue(parent, key, val)
|
|
}
|
|
|
|
// NewDisconnectedContext returns a new context that won't propagate parent's cancellation to the new child context.
|
|
// One common use case is to do cleanup work after workflow is canceled.
|
|
// err := workflow.ExecuteActivity(ctx, ActivityFoo).Get(ctx, &activityFooResult)
|
|
// if err != nil && temporal.IsCanceledError(ctx.Err()) {
|
|
// // activity failed, and workflow context is canceled
|
|
// disconnectedCtx, _ := workflow.newDisconnectedContext(ctx);
|
|
// workflow.ExecuteActivity(disconnectedCtx, handleCancellationActivity).Get(disconnectedCtx, nil)
|
|
// return err // workflow return CanceledError
|
|
// }
|
|
func NewDisconnectedContext(parent Context) (ctx Context, cancel CancelFunc) {
|
|
return internal.NewDisconnectedContext(parent)
|
|
}
|