Struct aerospike::policy::BasePolicy

pub struct BasePolicy {
    pub priority: Priority,
    pub consistency_level: ConsistencyLevel,
    pub timeout: Option<Duration>,
    pub max_retries: Option<usize>,
    pub sleep_between_retries: Option<Duration>,
    pub filter_expression: Option<FilterExpression>,
}

Common parameters shared by all policy types.

Fields

priority: Priority

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.

consistency_level: ConsistencyLevel

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.

timeout: Option<Duration>

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).

max_retries: Option<usize>

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.

sleep_between_retries: Option<Duration>

SleepBetweenReplies determines duration to sleep between retries if a transaction fails and the timeout was not exceeded. Enter zero to skip sleep.

filter_expression: Option<FilterExpression>

Optional FilterExpression

Implementations

impl BasePolicy

pub const fn filter_expression(&self) -> &Option<FilterExpression>

Get the Optional Filter Expression

Trait Implementations

impl Clone for BasePolicy

fn clone(&self) -> BasePolicy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BasePolicy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Policy for BasePolicy

fn priority(&self) -> &Priority

Transaction priority.

fn timeout(&self) -> Option<Duration>

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.

fn max_retries(&self) -> Option<usize>

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 sleep_between_retries(&self) -> Option<Duration>

Time to sleep between retries. Set to zero to skip sleep. Default: 500ms.

fn consistency_level(&self) -> &ConsistencyLevel

How replicas should be consulted in read operations to provide the desired consistency guarantee.