afw_adaptor_journal

Files
file	afw_adaptor_journal_impl_declares.h
	Interface afw_interface implementation declares.

Macros
#define	__AFW_ADAPTOR_JOURNAL_IMPL_DECLARES_H__   1
#define	_AFW_IMPLEMENTATION_ID_   "unspecified"
#define	_AFW_IMPLEMENTATION_SPECIFIC_   NULL
#define	_AFW_IMPLEMENTATION_SOURCE_FILE_   __FILE__

Functions
	impl_afw_adaptor_journal_add_entry (const afw_adaptor_journal_t *instance, const afw_adaptor_impl_request_t *impl_request, const afw_object_t *entry, afw_xctx_t *xctx)
	impl_afw_adaptor_journal_get_entry (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)
	impl_afw_adaptor_journal_mark_entry_consumed (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

This file should only be included in c source files that implement interface afw_adaptor_journal.

You can find a skeleton for using this #include file in the corresponding source directory in file generated/interface_closet/skeleton_afw_adaptor_journal.c.

Mutiple *_impl.declares.h can be included in each c source file, but only one for each interface name.

After the #include for afw_adaptor_journal_impl_declares.h:

1. declarations will exist for all of the interfaces methods with names of impl_afw_adaptor_journal_ followed by the method name.
2. rti will be defined with a name of impl_afw_adaptor_journal_rti.
3. inf will be defined with a name of impl_afw_adaptor_journal_inf.

Before including, define the following symbols:

• AFW_IMPLEMENTATION_ID - Implementation id string for this implementation.
• AFW_IMPLEMENTATION_INF_SPECIFIER - (optional) defaults to static.
• AFW_IMPLEMENTATION_INF_LABEL - (optional) defaults to impl_afw_adaptor_journal_inf.

Example:

     static const sometype_t impl_myimpl_stuff =  {
         ...
     };
  
     #define AFW_IMPLEMENTATION_ID "myimpl"
     #define AFW_IMPLEMENTATION_SPECIFIC &impl_myimpl_stuff
     #include "afw_adaptor_journal_impl_declares.h"
  
   A second #include "afw_adaptor_journal_impl_declares.h" can be specified if
" *   #define "AFW_ADAPTOR_JOURNAL_INF_ONLY" is specified to generate inf only."

Function Documentation

impl_afw_adaptor_journal_add_entry()

impl_afw_adaptor_journal_add_entry	(	const afw_adaptor_journal_t *	instance,
		const afw_adaptor_impl_request_t *	impl_request,
		const afw_object_t *	entry,
		afw_xctx_t *	xctx
	)

Todo:

FIXME: authorization check

Todo:

FIXME: add in registers for cleanup.

Todo:

FIXME: is this the right options to use? Probably not.

Definition at line 1607 of file afw_adaptor_impl.c.

impl_afw_adaptor_journal_get_entry()

impl_afw_adaptor_journal_get_entry	(	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
	)

Todo:

FIXME: authorization check

Todo:

FIXME: Is this an error?

Definition at line 1628 of file afw_adaptor_impl.c.

impl_afw_adaptor_journal_mark_entry_consumed()

impl_afw_adaptor_journal_mark_entry_consumed	(	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
	)

Todo:

FIXME: authorization check

Definition at line 1653 of file afw_adaptor_impl.c.