-
Notifications
You must be signed in to change notification settings - Fork 451
/
types.go
123 lines (97 loc) · 3.97 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
// Copyright (c) 2018 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 context
import (
stdctx "context"
"github.com/m3db/m3/src/x/pool"
"github.com/m3db/m3/src/x/resource"
"github.com/opentracing/opentracing-go"
)
// Cancellable is an object that can be cancelled.
type Cancellable interface {
// IsCancelled determines whether the object is cancelled.
IsCancelled() bool
// Cancel cancels the object.
Cancel()
// Reset resets the object.
Reset()
}
// Context provides context to an operation.
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)
}
// Pool provides a pool for contexts.
type Pool interface {
// Get provides a context from the pool.
Get() Context
// Put returns a context to the pool.
Put(Context)
}
// Options controls knobs for context pooling.
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
}
// contextPool is the internal pool interface for contexts.
type contextPool interface {
Pool
getFinalizeablesList() *finalizeableList
putFinalizeablesList(v *finalizeableList)
}