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
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
use crate::core::index::query_timeout::QueryTimeout;
use std::time::{Duration, Instant};
/// A deadline-based implementation of [`QueryTimeout`].
/// Query timeout used to stop rewriting queries that take too long.
pub struct QueryTimeoutImpl {
/// The local variable to store the time beyond which, the processing should exit.
timeout_at: Option<Instant>,
}
impl QueryTimeoutImpl {
/// Sets the time at which to time out by adding the given `time_allowed` to the current time.
///
/// # Arguments
///
/// * `time_allowed` — Number of milliseconds after which to time out.
/// Use `i64::MAX` to effectively never time out.
pub fn new(mut time_allowed: i64) -> Self {
if time_allowed < 0 {
time_allowed = i64::MAX;
}
let duration = if time_allowed == i64::MAX {
None
} else {
Some(Duration::from_millis(time_allowed as u64))
};
let timeout_at = duration.map(|d| Instant::now() + d);
Self { timeout_at }
}
/// Returns time at which to time out, in [`Instant`].
/// Can be compared directly with `Instant::now()`.
pub fn get_timeout_at(&self) -> Option<Instant> {
self.timeout_at
}
/// Reset the timeout value.
pub fn reset(&mut self) {
self.timeout_at = None;
}
}
impl std::fmt::Display for QueryTimeoutImpl {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"timeout_at: {:?} (Instant::now(): {:?})",
self.timeout_at,
Instant::now()
)
}
}
impl QueryTimeout for QueryTimeoutImpl {
/// Return `true` if [`reset`](Self::reset) has not been called and
/// the elapsed time has exceeded the time allowed.
fn should_exit(&self) -> bool {
if let Some(timeout_at) = self.timeout_at {
Instant::now() > timeout_at
} else {
false
}
}
}