as_policy_read Struct Reference

Detailed Description

Read Policy

Definition at line 507 of file as_policy.h.

#include "as_policy.h"

Collaboration diagram for as_policy_read:

Data Fields
bool	async_heap_rec
as_policy_base	base
bool	deserialize
as_policy_key	key
as_policy_read_mode_ap	read_mode_ap
as_policy_read_mode_sc	read_mode_sc
as_policy_replica	replica

Related Functions
(Note that these are not member functions.)
static void	as_policy_read_copy (const as_policy_read *src, as_policy_read *trg)
static as_policy_read *	as_policy_read_init (as_policy_read *p)

Friends And Related Function Documentation

static void as_policy_read_copy ( const as_policy_read *  src, as_policy_read *  trg  )

related

Shallow copy as_policy_read values.

Parameters

src	The source policy.
trg	The target policy.

Definition at line 1456 of file as_policy.h.

static as_policy_read * as_policy_read_init ( as_policy_read *  p )

related

Initialize as_policy_read to default values.

Parameters

p	The policy to initialize.

Returns

The initialized policy.

Definition at line 1435 of file as_policy.h.

References as_policy_base_read_init(), AS_POLICY_KEY_DEFAULT, AS_POLICY_READ_MODE_AP_DEFAULT, AS_POLICY_READ_MODE_SC_DEFAULT, AS_POLICY_REPLICA_DEFAULT, async_heap_rec, base, deserialize, key, read_mode_ap, read_mode_sc, and replica.

Field Documentation

bool as_policy_read::async_heap_rec

Should as_record instance be allocated on the heap before user listener is called in async commands. If true, the user is responsible for calling as_record_destroy() when done with the record. If false, as_record_destroy() is automatically called by the client after the user listener function completes. This field is ignored for sync commands.

Default: false

Definition at line 552 of file as_policy.h.

as_policy_base as_policy_read::base

Generic policy fields.

Definition at line 512 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 542 of file as_policy.h.

as_policy_key as_policy_read::key

Specifies the behavior for the key.

Definition at line 517 of file as_policy.h.

as_policy_read_mode_ap as_policy_read::read_mode_ap

Read policy for AP (availability) namespaces. Default: AS_POLICY_READ_MODE_AP_ONE

Definition at line 528 of file as_policy.h.

as_policy_read_mode_sc as_policy_read::read_mode_sc

Read policy for SC (strong consistency) namespaces. Default: AS_POLICY_READ_MODE_SC_SESSION

Definition at line 534 of file as_policy.h.

as_policy_replica as_policy_read::replica

Algorithm used to determine target node.

Definition at line 522 of file as_policy.h.

---

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

• as_policy.h