afw_adaptor_impl.h File Reference

Helpers for adaptor implementation development. More...

#include "afw_interface.h"

Go to the source code of this file.

Data Structures
struct	afw_adaptor_impl_core_object_type_s
	afw_adaptor_impl_t supported_core_object_types entry. More...
struct	afw_adaptor_impl_s
	Internal struct used by common adaptor code for all adaptors. More...
struct	afw_adaptor_impl_session_s
	Internal session info used by afw_adaptor_impl*() functions. More...
struct	afw_adaptor_impl_request_s
	Internal request info used by afw_adaptor_impl*() functions. More...

Macros
#define	AFW_ADAPTOR_IMPL_LOCK_READ_BEGIN(adaptor)   AFW_LOCK_READ_BEGIN((adaptor)->impl->adaptor_lock_rw)
	Macro to begin an adaptor read lock section. More...
#define	AFW_ADAPTOR_IMPL_LOCK_READ_END   AFW_LOCK_READ_END
	Macro to end an adaptor read lock section. More...
#define	AFW_ADAPTOR_IMPL_LOCK_WRITE_BEGIN(adaptor)   AFW_LOCK_WRITE_BEGIN((adaptor)->impl->adaptor_lock_rw)
	Macro to begin an adaptor write lock section. More...
#define	AFW_ADAPTOR_IMPL_LOCK_WRITE_END   AFW_LOCK_WRITE_END
	Macro to end an adaptor write lock section. More...
#define	AFW_ADAPTOR_IMPL_ERROR_ADAPTOR_IMMUTABLE   AFW_THROW_ERROR_Z(read_only, "Adaptor is read-only.", xctx)

Typedefs
typedef struct afw_adaptor_impl_core_object_type_s	afw_adaptor_impl_core_object_type_t
	afw_adaptor_impl_t supported_core_object_types entry.

Functions
afw_adaptor_t *	afw_adaptor_impl_create_cede_p (const afw_adaptor_inf_t *inf, afw_size_t instance_size, const afw_object_t *properties, const afw_pool_t *p, afw_xctx_t *xctx)
	Developers should call this in all create functions for afw_adaptor. More...
void	afw_adaptor_impl_object_type_cache_initialize (afw_adaptor_object_type_cache_t *object_type_cache, const afw_adaptor_object_type_cache_inf_t *inf, const afw_adaptor_session_t *session, afw_boolean_t all_object_types_immutable, afw_xctx_t *xctx)
	Initialize object type cache instance. More...
void	afw_adaptor_impl_set_object_types_fully_loaded (const afw_adaptor_t *adaptor, afw_xctx_t *xctx)
	Set object types fully loaded. More...
const afw_object_t *	afw_adaptor_impl_generic_object_type_object_get (const afw_adaptor_t *adaptor, const afw_utf8_t *object_type_id, const afw_pool_t *p, afw_xctx_t *xctx)
	Create a generic object type object. More...
void	afw_adaptor_impl_push_qualifiers (const afw_adaptor_t *adaptor, afw_xctx_t *xctx)
	Push adaptor qualifiers to xctx. More...
void	afw_adaptor_impl_throw_property_invalid (const afw_adaptor_t *adaptor, const afw_utf8_t *property_name, afw_xctx_t *xctx)
	Developers should call this for configuration property errors. More...
void	afw_adaptor_impl_throw_property_required (const afw_adaptor_t *adaptor, const afw_utf8_t *property_name, afw_xctx_t *xctx)
	Developers should call this for missing required configuration property. More...
void	afw_adaptor_impl_call_object_cb_from_list (const afw_list_t *list, void *context, afw_object_cb_t callback, afw_xctx_t *xctx)
	Call object cb from list. More...
afw_boolean_t	afw_adaptor_impl_is_journal_entry_applicable (const afw_adaptor_journal_t *instance, const afw_object_t *entry, const afw_object_t *consumer, const afw_value_t *const *filter, afw_xctx_t *xctx)
	Determine whether a journal entry is applicable to a consumer. More...
void	afw_adaptor_impl_set_supported_core_object_type (const afw_adaptor_t *adaptor, const afw_utf8_t *object_type_id, afw_boolean_t allow_entity, afw_boolean_t allow_write, afw_xctx_t *xctx)
	Indicates support of a core object type. More...

Variables
	afw_adaptor_impl_object_type_cache_inf
	inf for an implementation of afw_adaptor_object_type_cache. More...

Detailed Description

Helpers for adaptor implementation development.

Definition in file afw_adaptor_impl.h.