/
interface.go
85 lines (72 loc) · 2.23 KB
/
interface.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
// Copyright (C) 2020-2021, IrineSistiana
//
// This file is part of mosdns.
//
// mosdns is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// mosdns is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
package handler
import "context"
// Plugin represents the basic plugin.
type Plugin interface {
Tag() string
Type() string
}
// Executable can do some cool stuffs.
type Executable interface {
Exec(ctx context.Context, qCtx *Context) (err error)
}
// ExecutablePlugin: See Executable.
type ExecutablePlugin interface {
Plugin
Executable
}
// ESExecutable: Early Stoppable Executable.
type ESExecutable interface {
// ExecES: Execute something. earlyStop indicates that it wants
// to stop the utils.ExecutableCmdSequence ASAP.
ExecES(ctx context.Context, qCtx *Context) (earlyStop bool, err error)
}
// ESExecutablePlugin: See ESExecutable.
type ESExecutablePlugin interface {
Plugin
ESExecutable
}
// Matcher represents a matcher that can match certain patten in Context.
type Matcher interface {
Match(ctx context.Context, qCtx *Context) (matched bool, err error)
}
// MatcherPlugin: See Matcher.
type MatcherPlugin interface {
Plugin
Matcher
}
// ContextConnector can choose when and how to execute its successor.
type ContextConnector interface {
// Connect connects this ContextPlugin to its predecessor.
Connect(ctx context.Context, qCtx *Context, pipeCtx *PipeContext) (err error)
}
// ContextPlugin: See ContextConnector.
type ContextPlugin interface {
Plugin
ContextConnector
}
// Service represents a background service.
type Service interface {
// Shutdown and release resources.
Shutdown() error
}
// ServicePlugin: See Service.
type ServicePlugin interface {
Plugin
Service
}