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

Detailed Description

Key Apply Policy

Definition at line 408 of file as_policy.h.

#include "as_policy.h"

+ Collaboration diagram for as_policy_apply:

Data Fields

as_policy_commit_level commit_level
 
as_policy_key key
 
uint32_t timeout
 
uint32_t ttl
 

Related Functions

(Note that these are not member functions.)

static void as_policy_apply_copy (as_policy_apply *src, as_policy_apply *trg)
 
static as_policy_applyas_policy_apply_init (as_policy_apply *p)
 

Friends And Related Function Documentation

static void as_policy_apply_copy ( as_policy_apply src,
as_policy_apply trg 
)
related

Copy as_policy_apply values.

Parameters
srcThe source policy.
trgThe target policy.

Definition at line 1021 of file as_policy.h.

References commit_level, key, timeout, and ttl.

static as_policy_apply * as_policy_apply_init ( as_policy_apply p)
related

Initialize as_policy_apply to default values.

Parameters
pThe policy to initialize.
Returns
The initialized policy.

Definition at line 1003 of file as_policy.h.

References AS_POLICY_COMMIT_LEVEL_DEFAULT, AS_POLICY_KEY_DEFAULT, AS_POLICY_TIMEOUT_DEFAULT, commit_level, key, timeout, and ttl.

Field Documentation

as_policy_commit_level as_policy_apply::commit_level

Specifies the number of replicas required to be committed successfully when writing before returning transaction succeeded.

Definition at line 426 of file as_policy.h.

as_policy_key as_policy_apply::key

Specifies the behavior for the key.

Definition at line 419 of file as_policy.h.

uint32_t as_policy_apply::timeout

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

Definition at line 414 of file as_policy.h.

uint32_t as_policy_apply::ttl

The time-to-live (expiration) of the record in seconds. There are two special values that can be set in the record TTL: (*) ZERO (defined as AS_RECORD_DEFAULT_TTL), which means that the record will adopt the default TTL value from the namespace. (*) 0xFFFFFFFF (also, -1 in a signed 32 bit int) (defined as AS_RECORD_NO_EXPIRE_TTL), which means that the record will get an internal "void_time" of zero, and thus will never expire.

Note that the TTL value will be employed ONLY on write/update calls.

Definition at line 439 of file as_policy.h.


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