afw_adaptor_journal

Modules
	afw_adaptor_journal

Data Structures
struct	afw_adaptor_journal_s
	Interface afw_adaptor_journal public struct. More...
struct	afw_adaptor_journal_inf_s
	Interface afw_adaptor_journal_inf_s struct. More...

Macros
#define	AFW_ADAPTOR_JOURNAL_INTERFACE_NAME   "afw_adaptor_journal"
	define for interface afw_adaptor_journal name.
#define	afw_adaptor_journal_add_entry(instance, impl_request, entry, xctx)
	Call method add_entry of interface afw_adaptor_journal. More...
#define	afw_adaptor_journal_get_entry(instance, impl_request, option, consumer_id, entry_cursor, limit, response, xctx)
	Call method get_entry of interface afw_adaptor_journal. More...
#define	afw_adaptor_journal_mark_entry_consumed(instance, impl_request, consumer_id, entry_cursor, xctx)
	Call method mark_entry_consumed of interface afw_adaptor_journal. More...

Typedefs
typedef const afw_utf8_t *(*	afw_adaptor_journal_add_entry_t) (const afw_adaptor_journal_t *instance, const afw_adaptor_impl_request_t *impl_request, const afw_object_t *entry, afw_xctx_t *xctx)
typedef void(*	afw_adaptor_journal_get_entry_t) (const afw_adaptor_journal_t *instance, const afw_adaptor_impl_request_t *impl_request, afw_adaptor_journal_option_t option, const afw_utf8_t *consumer_id, const afw_utf8_t *entry_cursor, afw_size_t limit, const afw_object_t *response, afw_xctx_t *xctx)
typedef void(*	afw_adaptor_journal_mark_entry_consumed_t) (const afw_adaptor_journal_t *instance, const afw_adaptor_impl_request_t *impl_request, const afw_utf8_t *consumer_id, const afw_utf8_t *entry_cursor, afw_xctx_t *xctx)

Detailed Description

Adaptor journal interface.

Macro Definition Documentation

afw_adaptor_journal_add_entry

#define afw_adaptor_journal_add_entry	(		instance,
			impl_request,
			entry,
			xctx
	)

Value:

(instance)->inf->add_entry( \
    (instance), \
    (impl_request), \
    (entry), \
    (xctx) \
)

Call method add_entry of interface afw_adaptor_journal.

Parameters

instance	Pointer to this adaptive event journal instance.
impl_request	Pass this as first parameter of afw_adaptor_impl_request_*() functions. See afw_adaptor_impl.h for more information.
entry	Pointer to the event to be logged in the journal.
xctx	This is the caller's xctx.

Definition at line 5084 of file afw_interface.h.

afw_adaptor_journal_get_entry

#define afw_adaptor_journal_get_entry	(		instance,
			impl_request,
			option,
			consumer_id,
			entry_cursor,
			limit,
			response,
			xctx
	)

Value:

(instance)->inf->get_entry( \
    (instance), \
    (impl_request), \
    (option), \
    (consumer_id), \
    (entry_cursor), \
    (limit), \
    (response), \
    (xctx) \
)

Call method get_entry of interface afw_adaptor_journal.

Parameters

instance	Pointer to this adaptive event journal instance.
impl_request	Pass this as first parameter of afw_adaptor_impl_request_*() functions. See afw_adaptor_impl.h for more information.
option	Get entry option. See afw_adaptor_journal_option_t for more information.
consumer_id	Peer id of consumer of event of NULL. See afw_adaptor_journal_option_t for information on how this parameter is used or ignored.
entry_cursor	Journal entry cursor or NULL. See afw_adaptor_journal_option_t for information on how this parameter is used or ignored.
limit	Limit or 0. See afw_adaptor_journal_option_t for information on how this parameter is used or ignored.
response	This is an existing response object that can have properties already set. Depending on the option specified, get_entry() will set additional properties. See afw_adaptor_journal_option_t for information on which properties are set and under what condition.
xctx	This is the caller's xctx.

Definition at line 5120 of file afw_interface.h.

afw_adaptor_journal_mark_entry_consumed

#define afw_adaptor_journal_mark_entry_consumed	(		instance,
			impl_request,
			consumer_id,
			entry_cursor,
			xctx
	)

Value:

(instance)->inf->mark_entry_consumed( \
    (instance), \
    (impl_request), \
    (consumer_id), \
    (entry_cursor), \
    (xctx) \
)

Call method mark_entry_consumed of interface afw_adaptor_journal.

Parameters

instance	Pointer to this adaptive event journal instance.
impl_request	Pass this as first parameter of afw_adaptor_impl_request_*() functions. See afw_adaptor_impl.h for more information.
consumer_id	Get entry option. See afw_adaptor_journal_option_t for more information.
entry_cursor	Token of the event to mark consumed.
xctx	This is the caller's xctx.

Definition at line 5152 of file afw_interface.h.

Typedef Documentation

afw_adaptor_journal_add_entry_t

typedef const afw_utf8_t*(* afw_adaptor_journal_add_entry_t) (const afw_adaptor_journal_t *instance, const afw_adaptor_impl_request_t *impl_request, const afw_object_t *entry, afw_xctx_t *xctx)

See also

afw_adaptor_journal_add_entry()

Definition at line 5039 of file afw_interface.h.

afw_adaptor_journal_get_entry_t

typedef void(* afw_adaptor_journal_get_entry_t) (const afw_adaptor_journal_t *instance, const afw_adaptor_impl_request_t *impl_request, afw_adaptor_journal_option_t option, const afw_utf8_t *consumer_id, const afw_utf8_t *entry_cursor, afw_size_t limit, const afw_object_t *response, afw_xctx_t *xctx)

See also

afw_adaptor_journal_get_entry()

Definition at line 5047 of file afw_interface.h.

afw_adaptor_journal_mark_entry_consumed_t

typedef void(* afw_adaptor_journal_mark_entry_consumed_t) (const afw_adaptor_journal_t *instance, const afw_adaptor_impl_request_t *impl_request, const afw_utf8_t *consumer_id, const afw_utf8_t *entry_cursor, afw_xctx_t *xctx)

See also

afw_adaptor_journal_mark_entry_consumed()

Definition at line 5059 of file afw_interface.h.