All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Data Fields | Related Functions
as_policy_read Struct Reference

Detailed Description

Read Policy

Definition at line 428 of file as_policy.h.

#include "as_policy.h"

+ Collaboration diagram for as_policy_read:

Data Fields

as_policy_consistency_level consistency_level
 
bool deserialize
 
as_policy_key key
 
as_policy_replica replica
 
uint32_t retry
 
bool retry_on_timeout
 
uint32_t sleep_between_retries
 
uint32_t timeout
 

Related Functions

(Note that these are not member functions.)

static void as_policy_read_copy (as_policy_read *src, as_policy_read *trg)
 
static as_policy_readas_policy_read_init (as_policy_read *p)
 

Friends And Related Function Documentation

static void as_policy_read_copy ( as_policy_read src,
as_policy_read trg 
)
related

Copy as_policy_read values.

Parameters
srcThe source policy.
trgThe target policy.

Definition at line 1145 of file as_policy.h.

static as_policy_read * as_policy_read_init ( as_policy_read p)
related

Field Documentation

as_policy_consistency_level as_policy_read::consistency_level

Specifies the number of replicas consulted when reading for the desired consistency guarantee.

Definition at line 463 of file as_policy.h.

bool as_policy_read::deserialize

Should raw bytes representing a list or map be deserialized to as_list or as_map. Set to false for backup programs that just need access to raw bytes. Default: true

Definition at line 489 of file as_policy.h.

as_policy_key as_policy_read::key

Specifies the behavior for the key.

Definition at line 452 of file as_policy.h.

as_policy_replica as_policy_read::replica

Specifies the replica to be consulted for the read.

Definition at line 457 of file as_policy.h.

uint32_t as_policy_read::retry

Maximum number of retries when a transaction fails due to a network error. Used by synchronous commands only. Default: 1

Definition at line 440 of file as_policy.h.

bool as_policy_read::retry_on_timeout

Should the client retry a command if the timeout is reached. Used by synchronous commands only.

Values:

  • false: Return error when the timeout has been reached. Note that retries can still occur if a command fails on a network error before the timeout has been reached.
  • true: Retry command with same timeout when the timeout has been reached. The maximum number of retries is defined by retry.

Default: false

Definition at line 482 of file as_policy.h.

uint32_t as_policy_read::sleep_between_retries

Milliseconds to sleep between retries. Used by synchronous commands only. Default: 0 (do not sleep)

Definition at line 447 of file as_policy.h.

uint32_t as_policy_read::timeout

Maximum time in milliseconds to wait for the operation to complete.

Definition at line 433 of file as_policy.h.


The documentation for this struct was generated from the following file: