Adaptive Framework  0.9.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
afw_adaptor_journal.h
Go to the documentation of this file.
1 // See the 'COPYING' file in the project root for licensing information.
2 /*
3  * Adaptive Framework Adaptor Journal
4  *
5  * Copyright (c) 2010-2023 Clemson University
6  *
7  */
8 
9 #ifndef __AFW_ADAPTOR_JOURNAL_H__
10 #define __AFW_ADAPTOR_JOURNAL_H__
11 
12 #include "afw_interface.h"
13 
26 
27 
38  const afw_utf8_t *adaptor_id,
39  const afw_utf8_t *consumer_id,
40  afw_size_t limit,
41  const afw_pool_t *p,
42  afw_xctx_t *xctx);
43 
44 
45 
54  const afw_utf8_t *adaptor_id,
55  const afw_pool_t *p,
56  afw_xctx_t *xctx);
57 
58 
68  const afw_utf8_t *adaptor_id,
69  const afw_utf8_t *cursor,
70  const afw_pool_t *p,
71  afw_xctx_t *xctx);
72 
73 
83  const afw_utf8_t *adaptor_id,
84  const afw_utf8_t *cursor,
85  const afw_pool_t *p,
86  afw_xctx_t *xctx);
87 
88 
99  const afw_utf8_t *adaptor_id,
100  const afw_utf8_t *consumer_id,
101  afw_size_t limit,
102  const afw_pool_t *p,
103  afw_xctx_t *xctx);
104 
105 
115 AFW_DECLARE(const afw_object_t *)
117  const afw_utf8_t *adaptor_id,
118  const afw_utf8_t *consumer_id,
119  const afw_utf8_t *cursor,
120  afw_size_t limit,
121  const afw_pool_t *p,
122  afw_xctx_t *xctx);
123 
124 
133 AFW_DECLARE(void)
135  const afw_utf8_t *adaptor_id,
136  const afw_utf8_t *consumer_id,
137  const afw_utf8_t *cursor,
138  const afw_pool_t *p,
139  afw_xctx_t *xctx);
140 
141 
142 
143 /* _AdaptiveJournalEntry update_object(). */
144 AFW_DECLARE(void)
145 afw_adaptor_journal_entry_consume(
146  const afw_adaptor_session_t *session,
147  const afw_utf8_t *object_id,
148  const afw_object_t *update_object,
149  afw_xctx_t *xctx);
150 
151 
152 
153 AFW_END_DECLARES
154 
157 #endif /* __AFW_ADAPTOR_JOURNAL_H__ */
#define AFW_BEGIN_DECLARES
#define AFW_DECLARE(type)
Declare a public afw function.
Interfaceafw_interface header.
const afw_object_t * afw_adaptor_journal_get_by_cursor(const afw_utf8_t *adaptor_id, const afw_utf8_t *cursor, const afw_pool_t *p, afw_xctx_t *xctx)
Journal - get entry at cursor.
const afw_object_t * afw_adaptor_journal_get_first(const afw_utf8_t *adaptor_id, const afw_pool_t *p, afw_xctx_t *xctx)
Journal - get first entry.
const afw_object_t * afw_adaptor_journal_get_next_for_consumer_after_cursor(const afw_utf8_t *adaptor_id, const afw_utf8_t *consumer_id, const afw_utf8_t *cursor, afw_size_t limit, const afw_pool_t *p, afw_xctx_t *xctx)
Journal - get next entry after cursor for consumer.
void afw_adaptor_journal_mark_consumed(const afw_utf8_t *adaptor_id, const afw_utf8_t *consumer_id, const afw_utf8_t *cursor, const afw_pool_t *p, afw_xctx_t *xctx)
Journal - mark entry consumed by consumer.
const afw_object_t * afw_adaptor_journal_get_next_for_consumer(const afw_utf8_t *adaptor_id, const afw_utf8_t *consumer_id, afw_size_t limit, const afw_pool_t *p, afw_xctx_t *xctx)
Journal - get next entry for consumer.
const afw_object_t * afw_adaptor_journal_advance_cursor_for_consumer(const afw_utf8_t *adaptor_id, const afw_utf8_t *consumer_id, afw_size_t limit, const afw_pool_t *p, afw_xctx_t *xctx)
Journal - advance cursor for consumer.
const afw_object_t * afw_adaptor_journal_get_next_after_cursor(const afw_utf8_t *adaptor_id, const afw_utf8_t *cursor, const afw_pool_t *p, afw_xctx_t *xctx)
Journal - get next entry after cursor.
apr_size_t afw_size_t
size_t.
Definition: afw_common.h:151
Interface afw_adaptor_session public struct.
Interface afw_object public struct.
Interface afw_pool public struct.
NFC normalized UTF-8 string.
Definition: afw_common.h:545
Interface afw_xctx public struct.