-
Notifications
You must be signed in to change notification settings - Fork 59
Expand file tree
/
Copy pathprocessor_job.py
More file actions
50 lines (41 loc) · 1.64 KB
/
processor_job.py
File metadata and controls
50 lines (41 loc) · 1.64 KB
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
# Copyright 2022 The FeatHub 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
#
# https://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.
from abc import ABC, abstractmethod
from concurrent.futures import Future
from typing import Optional
class ProcessorJob(ABC):
"""
Provides APIs to get or wait for a job's execution result.
"""
def __init__(self) -> None:
pass
@abstractmethod
def cancel(self) -> Future:
"""
Cancel the ProcessorJob if the ProcessorJob hasn't reached termination state.
The cancel call is async and the return Future is completed when the canceling
command is acknowledged. User should call `wait` to wait for the job
termination if user wants to ensure that the processor job reached termination
state.
:return: The Future that is completed when the canceling command is
acknowledged.
"""
pass
@abstractmethod
def wait(self, timeout_ms: Optional[int] = None) -> None:
"""
Waits for at most the given time (milliseconds) for the job termination.
:param timeout_ms: If it is None, waits for the job termination indefinitely.
"""
pass