/
component.go
75 lines (61 loc) · 2.15 KB
/
component.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
// Copyright The OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package componenthelper
import (
"context"
"go.opentelemetry.io/collector/component"
)
// StartFunc specifies the function invoked when the component.Component is being started.
type StartFunc func(context.Context, component.Host) error
// Start starts the component.
func (f StartFunc) Start(ctx context.Context, host component.Host) error {
return f(ctx, host)
}
// ShutdownFunc specifies the function invoked when the component.Component is being shutdown.
type ShutdownFunc func(context.Context) error
// Shutdown shuts down the component.
func (f ShutdownFunc) Shutdown(ctx context.Context) error {
return f(ctx)
}
// Option represents the possible options for New.
type Option func(*baseComponent)
// WithStart overrides the default `Start` function for a component.Component.
// The default always returns nil.
func WithStart(startFunc StartFunc) Option {
return func(o *baseComponent) {
o.StartFunc = startFunc
}
}
// WithShutdown overrides the default `Shutdown` function for a component.Component.
// The default always returns nil.
func WithShutdown(shutdownFunc ShutdownFunc) Option {
return func(o *baseComponent) {
o.ShutdownFunc = shutdownFunc
}
}
type baseComponent struct {
StartFunc
ShutdownFunc
}
// New returns a component.Component configured with the provided options.
func New(options ...Option) component.Component {
bc := &baseComponent{
StartFunc: func(ctx context.Context, host component.Host) error { return nil },
ShutdownFunc: func(ctx context.Context) error { return nil },
}
for _, op := range options {
op(bc)
}
return bc
}