/Users/deen/code/yugabyte-db/src/yb/docdb/expiration.h
Line | Count | Source (jump to first uncovered line) |
1 | | // Copyright (c) YugaByte, Inc. |
2 | | // |
3 | | // Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except |
4 | | // in compliance with the License. You may obtain a copy of the License at |
5 | | // |
6 | | // http://www.apache.org/licenses/LICENSE-2.0 |
7 | | // |
8 | | // Unless required by applicable law or agreed to in writing, software distributed under the License |
9 | | // is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express |
10 | | // or implied. See the License for the specific language governing permissions and limitations |
11 | | // under the License. |
12 | | // |
13 | | |
14 | | #ifndef YB_DOCDB_EXPIRATION_H |
15 | | #define YB_DOCDB_EXPIRATION_H |
16 | | |
17 | | #include "yb/docdb/value.h" |
18 | | |
19 | | namespace yb { |
20 | | namespace docdb { |
21 | | |
22 | | // Useful for calculating expiration. |
23 | | struct Expiration { |
24 | | Expiration() : |
25 | 16.1M | ttl(ValueControlFields::kMaxTtl) {} |
26 | | |
27 | | explicit Expiration(MonoDelta default_ttl) : |
28 | 10.0M | ttl(default_ttl) {} |
29 | | |
30 | | explicit Expiration(HybridTime new_write_ht) : |
31 | | ttl(ValueControlFields::kMaxTtl), |
32 | 0 | write_ht(new_write_ht) {} |
33 | | |
34 | | explicit Expiration(HybridTime new_write_ht, MonoDelta new_ttl) : |
35 | | ttl(new_ttl), |
36 | 1.86M | write_ht(new_write_ht) {} |
37 | | |
38 | | MonoDelta ttl; |
39 | | HybridTime write_ht = HybridTime::kMin; |
40 | | |
41 | | // A boolean which dictates whether the TTL of kMaxValue |
42 | | // should override the existing TTL. Not compatible with |
43 | | // the concept of default TTL when set to true. |
44 | | bool always_override = false; |
45 | | |
46 | | Result<MonoDelta> ComputeRelativeTtl(const HybridTime& input_time); |
47 | | std::string ToString() const; |
48 | | }; |
49 | | |
50 | | } // namespace docdb |
51 | | } // namespace yb |
52 | | |
53 | | #endif // YB_DOCDB_EXPIRATION_H |