Read options

Functions
kv_error_t	kv_create_read_options (const kv_consistency_t *consistency, kv_long_t timeout_ms, kv_read_options_t **optionsp)
	Creates and initializes a read options structure to be used for read operations. More...
void	kv_release_read_options (kv_read_options_t **optionsp)
	Releases the resources use by the read options structure;. More...

Detailed Description

Read options is passed to read-only store operations to specify arguments that control non-default behavior related to consistency and operation timeouts.

Function Documentation

kv_error_t kv_create_read_options	(	const kv_consistency_t *	consistency,
		kv_long_t	timeout_ms,
		kv_read_options_t **	optionsp
	)

Creates and initializes a read options structure to be used for read operations.

Parameters

[in]	consistency	The consistency policy used for the read options, if NULL the default consistency is used. It can be created using kv_create_simple_consistency(), kv_create_time_consistency() or kv_create_version_consistency(). It is owned by the read options structure and released implicitly when it is released.
[in]	timeout_ms	The time, specified in milliseconds, allowed for processing the operation. If zero, the default request timeout is used.
[out]	optionsp	The output read options handle.

Returns

KV_SUCCESS on success, and an error code (a negative number) on failure.

void kv_release_read_options

(

kv_read_options_t **

optionsp

)

Releases the resources use by the read options structure;.

Parameters

[in]

optionsp

The pointer to the read options handle to release.