afw_adaptor_key_value

Modules
	afw_adaptor_key_value

Data Structures
struct	afw_adaptor_key_value_s
	Interface afw_adaptor_key_value public struct. More...
struct	afw_adaptor_key_value_inf_s
	Interface afw_adaptor_key_value_inf_s struct. More...

Macros
#define	AFW_ADAPTOR_KEY_VALUE_INTERFACE_NAME   "afw_adaptor_key_value"
	define for interface afw_adaptor_key_value name.
#define	afw_adaptor_key_value_add(instance, namespace, key, value, xctx)
	Call method add of interface afw_adaptor_key_value. More...
#define	afw_adaptor_key_value_delete(instance, namespace, key, value, must_exist, xctx)
	Call method delete of interface afw_adaptor_key_value. More...
#define	afw_adaptor_key_value_replace(instance, namespace, key, value, must_exist, xctx)
	Call method replace of interface afw_adaptor_key_value. More...
#define	afw_adaptor_key_value_get(instance, namespace, key, xctx)
	Call method get of interface afw_adaptor_key_value. More...

Typedefs
typedef void(*	afw_adaptor_key_value_add_t) (const afw_adaptor_key_value_t *instance, const afw_utf8_t *namespace, const afw_memory_t *key, const afw_memory_t *value, afw_xctx_t *xctx)
typedef void(*	afw_adaptor_key_value_delete_t) (const afw_adaptor_key_value_t *instance, const afw_utf8_t *namespace, const afw_memory_t *key, const afw_memory_t *value, afw_boolean_t must_exist, afw_xctx_t *xctx)
typedef void(*	afw_adaptor_key_value_replace_t) (const afw_adaptor_key_value_t *instance, const afw_utf8_t *namespace, const afw_memory_t *key, const afw_memory_t *value, afw_boolean_t must_exist, afw_xctx_t *xctx)
typedef const afw_memory_t *(*	afw_adaptor_key_value_get_t) (const afw_adaptor_key_value_t *instance, const afw_utf8_t *namespace, const afw_memory_t *key, afw_xctx_t *xctx)

Detailed Description

Adaptor implementation of key value interface.

Macro Definition Documentation

afw_adaptor_key_value_add

#define afw_adaptor_key_value_add	(		instance,
			namespace,
			key,
			value,
			xctx
	)

Value:

(instance)->inf->add( \
    (instance), \
    (namespace), \
    (key), \
    (value), \
    (xctx) \
)

Call method add of interface afw_adaptor_key_value.

Parameters

instance	Pointer to this adaptor key value instance.
namespace	Namespace for key.
key	Key.
value	Value.
xctx	This is the caller's xctx.

Definition at line 1154 of file afw_interface.h.

afw_adaptor_key_value_delete

#define afw_adaptor_key_value_delete	(		instance,
			namespace,
			key,
			value,
			must_exist,
			xctx
	)

Value:

(instance)->inf->delete( \
    (instance), \
    (namespace), \
    (key), \
    (value), \
    (must_exist), \
    (xctx) \
)

Call method delete of interface afw_adaptor_key_value.

Parameters

instance	Pointer to this adaptor key value instance.
namespace	Namespace for key.
key	Key.
value	Value the key must have or NULL if it doesn't matter.
must_exist	It is an error if value does not exist.
xctx	This is the caller's xctx.

Definition at line 1178 of file afw_interface.h.

afw_adaptor_key_value_get

#define afw_adaptor_key_value_get	(		instance,
			namespace,
			key,
			xctx
	)

Value:

(instance)->inf->get( \
    (instance), \
    (namespace), \
    (key), \
    (xctx) \
)

Call method get of interface afw_adaptor_key_value.

Parameters

instance	Pointer to this adaptor key value instance.
namespace	Namespace for key.
key	Key.
xctx	This is the caller's xctx.

Definition at line 1229 of file afw_interface.h.

afw_adaptor_key_value_replace

#define afw_adaptor_key_value_replace	(		instance,
			namespace,
			key,
			value,
			must_exist,
			xctx
	)

Value:

(instance)->inf->replace( \
    (instance), \
    (namespace), \
    (key), \
    (value), \
    (must_exist), \
    (xctx) \
)

Call method replace of interface afw_adaptor_key_value.

Parameters

instance	Pointer to this adaptor key value instance.
namespace	Namespace for key.
key	Key.
value	Value the key must have or NULL if it doesn't matter.
must_exist	It is an error if value does not exist. If must_exist is false, the keyed value will be added if it doesn't exist.
xctx	This is the caller's xctx.

Definition at line 1205 of file afw_interface.h.

Typedef Documentation

afw_adaptor_key_value_add_t

typedef void(* afw_adaptor_key_value_add_t) (const afw_adaptor_key_value_t *instance, const afw_utf8_t *namespace, const afw_memory_t *key, const afw_memory_t *value, afw_xctx_t *xctx)

See also

afw_adaptor_key_value_add()

Definition at line 1101 of file afw_interface.h.

afw_adaptor_key_value_delete_t

typedef void(* afw_adaptor_key_value_delete_t) (const afw_adaptor_key_value_t *instance, const afw_utf8_t *namespace, const afw_memory_t *key, const afw_memory_t *value, afw_boolean_t must_exist, afw_xctx_t *xctx)

See also

afw_adaptor_key_value_delete()

Definition at line 1110 of file afw_interface.h.

afw_adaptor_key_value_get_t

typedef const afw_memory_t*(* afw_adaptor_key_value_get_t) (const afw_adaptor_key_value_t *instance, const afw_utf8_t *namespace, const afw_memory_t *key, afw_xctx_t *xctx)

See also

afw_adaptor_key_value_get()

Definition at line 1130 of file afw_interface.h.

afw_adaptor_key_value_replace_t

typedef void(* afw_adaptor_key_value_replace_t) (const afw_adaptor_key_value_t *instance, const afw_utf8_t *namespace, const afw_memory_t *key, const afw_memory_t *value, afw_boolean_t must_exist, afw_xctx_t *xctx)

See also

afw_adaptor_key_value_replace()

Definition at line 1120 of file afw_interface.h.