/
interface.go
107 lines (92 loc) · 3.34 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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
// 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.
//go:generate mockgen -copyright_file ../../../LICENSE -package $GOPACKAGE -source $GOFILE -destination interface_mock.go -self_package github.com/uber/cadence/service/history/task
package task
import (
"time"
"github.com/uber/cadence/common"
"github.com/uber/cadence/common/task"
"github.com/uber/cadence/service/history/shard"
)
type (
// Info contains the metadata for a task
Info interface {
GetVersion() int64
GetTaskID() int64
GetTaskType() int
GetVisibilityTimestamp() time.Time
GetWorkflowID() string
GetRunID() string
GetDomainID() string
}
// Task is the interface for all tasks generated by history service
Task interface {
task.PriorityTask
Info
GetQueueType() QueueType
GetShard() shard.Context
GetAttempt() int
}
// Key identifies a Task and defines a total order among tasks
Key interface {
Less(Key) bool
}
// Executor contains the execution logic for Task
Executor interface {
Execute(taskInfo Info, shouldProcessTask bool) error
}
// Filter filters Task
Filter func(task Info) (bool, error)
// Initializer initializes a Task based on the Info
Initializer func(Info) Task
// PriorityAssigner assigns priority to Tasks
PriorityAssigner interface {
Assign(Task) error
}
// Processor is the worker pool for processing Tasks
Processor interface {
common.Daemon
StopShardProcessor(shard.Context)
Submit(Task) error
TrySubmit(Task) (bool, error)
}
// Redispatcher buffers tasks and periodically redispatch them to Processor
// redispatch can also be triggered immediately by calling the Redispatch method
Redispatcher interface {
common.Daemon
AddTask(Task)
Redispatch(targetSize int)
Size() int
}
// QueueType is the type of task queue
QueueType int
)
const (
// QueueTypeActiveTransfer is the queue type for active transfer queue processor
QueueTypeActiveTransfer QueueType = iota + 1
// QueueTypeStandbyTransfer is the queue type for standby transfer queue processor
QueueTypeStandbyTransfer
// QueueTypeActiveTimer is the queue type for active timer queue processor
QueueTypeActiveTimer
// QueueTypeStandbyTimer is the queue type for standby timer queue processor
QueueTypeStandbyTimer
// QueueTypeReplication is the queue type for replication queue processor
QueueTypeReplication
)