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 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
// Copyright 2015-2018 Aerospike, Inc.
//
// Portions may be licensed to Aerospike, Inc. under one or more contributor
// license agreements.
//
// 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 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.
//! Policy types encapsulate optional parameters for various client operations.
#![allow(clippy::missing_errors_doc)]
mod admin_policy;
mod batch_policy;
mod client_policy;
mod commit_level;
mod concurrency;
mod consistency_level;
mod expiration;
mod generation_policy;
mod priority;
mod query_policy;
mod read_policy;
mod record_exists_action;
mod scan_policy;
mod write_policy;
pub use self::admin_policy::AdminPolicy;
pub use self::batch_policy::BatchPolicy;
pub use self::client_policy::ClientPolicy;
pub use self::commit_level::CommitLevel;
pub use self::concurrency::Concurrency;
pub use self::consistency_level::ConsistencyLevel;
pub use self::expiration::Expiration;
pub use self::generation_policy::GenerationPolicy;
pub use self::priority::Priority;
pub use self::query_policy::QueryPolicy;
pub use self::read_policy::ReadPolicy;
pub use self::record_exists_action::RecordExistsAction;
pub use self::scan_policy::ScanPolicy;
pub use self::write_policy::WritePolicy;
use crate::expressions::FilterExpression;
use std::option::Option;
use std::time::{Duration, Instant};
/// Trait implemented by most policy types; policies that implement this trait typically encompass
/// an instance of `BasePolicy`.
pub trait Policy {
/// Transaction priority.
fn priority(&self) -> &Priority;
#[doc(hidden)]
/// Deadline for current transaction based on specified timeout. For internal use only.
fn deadline(&self) -> Option<Instant>;
/// Total transaction timeout for both client and server. The timeout is tracked on the client
/// and also sent to the server along with the transaction in the wire protocol. The client
/// will most likely timeout first, but the server has the capability to timeout the
/// transaction as well.
///
/// The timeout is also used as a socket timeout. Default: 0 (no timeout).
fn timeout(&self) -> Option<Duration>;
/// Maximum number of retries before aborting the current transaction. A retry may be attempted
/// when there is a network error. If `max_retries` is exceeded, the abort will occur even if
/// the timeout has not yet been exceeded.
fn max_retries(&self) -> Option<usize>;
/// Time to sleep between retries. Set to zero to skip sleep. Default: 500ms.
fn sleep_between_retries(&self) -> Option<Duration>;
/// How replicas should be consulted in read operations to provide the desired consistency
/// guarantee.
fn consistency_level(&self) -> &ConsistencyLevel;
}
#[doc(hidden)]
/// Policy-like object that encapsulates a base policy instance.
pub trait PolicyLike {
/// Retrieve a reference to the base policy.
fn base(&self) -> &BasePolicy;
}
impl<T> Policy for T
where
T: PolicyLike,
{
fn priority(&self) -> &Priority {
self.base().priority()
}
fn consistency_level(&self) -> &ConsistencyLevel {
self.base().consistency_level()
}
fn deadline(&self) -> Option<Instant> {
self.base().deadline()
}
fn timeout(&self) -> Option<Duration> {
self.base().timeout()
}
fn max_retries(&self) -> Option<usize> {
self.base().max_retries()
}
fn sleep_between_retries(&self) -> Option<Duration> {
self.base().sleep_between_retries()
}
}
/// Common parameters shared by all policy types.
#[derive(Debug, Clone)]
pub struct BasePolicy {
/// Priority of request relative to other transactions.
/// Currently, only used for scans.
/// This is deprected for Scan/Query commands and will not be sent to the server.
pub priority: Priority,
/// How replicas should be consulted in a read operation to provide the desired
/// consistency guarantee. Default to allowing one replica to be used in the
/// read operation.
pub consistency_level: ConsistencyLevel,
/// Timeout specifies transaction timeout.
/// This timeout is used to set the socket timeout and is also sent to the
/// server along with the transaction in the wire protocol.
/// Default to no timeout (0).
pub timeout: Option<Duration>,
/// MaxRetries determines maximum number of retries before aborting the current transaction.
/// A retry is attempted when there is a network error other than timeout.
/// If maxRetries is exceeded, the abort will occur even if the timeout
/// has not yet been exceeded.
pub max_retries: Option<usize>,
/// SleepBetweenReplies determines duration to sleep between retries if a
/// transaction fails and the timeout was not exceeded. Enter zero to skip sleep.
pub sleep_between_retries: Option<Duration>,
/// Optional FilterExpression
pub filter_expression: Option<FilterExpression>,
}
impl Policy for BasePolicy {
fn priority(&self) -> &Priority {
&self.priority
}
fn deadline(&self) -> Option<Instant> {
match self.timeout {
Some(timeout) => Some(Instant::now() + timeout),
None => None,
}
}
fn timeout(&self) -> Option<Duration> {
self.timeout
}
fn max_retries(&self) -> Option<usize> {
self.max_retries
}
fn sleep_between_retries(&self) -> Option<Duration> {
self.sleep_between_retries
}
fn consistency_level(&self) -> &ConsistencyLevel {
&self.consistency_level
}
}