Adaptive Framework  0.9.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
afw_adaptor_session_impl_declares.h
Go to the documentation of this file.
1 // See the 'COPYING' file in the project root for licensing information.
2 /*
3  * Interface afw_interface Implementation Declares
4  *
5  * Copyright (c) 2010-2023 Clemson University
6  *
7  */
8 
10 
12 
75 #ifdef __AFW_ADAPTOR_SESSION_IMPL_DECLARES_H__
76 #ifndef AFW_ADAPTOR_SESSION_INF_ONLY
77 #error "afw_adaptor_session_impl_declares.h already included."
78 #endif
79 #endif
80 #ifndef __AFW_ADAPTOR_SESSION_IMPL_DECLARES_H__
81 #ifdef AFW_ADAPTOR_SESSION_INF_ONLY
82 #error "afw_adaptor_session_impl_declares.h must be included before AFW_ADAPTOR_SESSION_INF_ONLY."
83 #endif
84 #define __AFW_ADAPTOR_SESSION_IMPL_DECLARES_H__ 1
85 #endif
86 
87 #ifdef AFW_IMPLEMENTATION_ID
88 #define _AFW_IMPLEMENTATION_ID_ AFW_IMPLEMENTATION_ID
89 #else
90 #define _AFW_IMPLEMENTATION_ID_ "unspecified"
91 #endif
92 #ifdef AFW_IMPLEMENTATION_SPECIFIC
93 #define _AFW_IMPLEMENTATION_SPECIFIC_ AFW_IMPLEMENTATION_SPECIFIC
94 #else
95 #define _AFW_IMPLEMENTATION_SPECIFIC_ NULL
96 #endif
97 #ifndef AFW_ADAPTOR_SESSION_INF_ONLY
98 
99 #ifndef impl_afw_adaptor_session_destroy
100 /* Declare method destroy */
101 AFW_DECLARE_STATIC(void)
103  const afw_adaptor_session_t * instance,
104  afw_xctx_t * xctx);
105 #endif
106 
107 #ifndef impl_afw_adaptor_session_retrieve_objects
108 /* Declare method retrieve_objects */
109 AFW_DECLARE_STATIC(void)
111  const afw_adaptor_session_t * instance,
112  const afw_adaptor_impl_request_t * impl_request,
113  const afw_utf8_t * object_type_id,
114  const afw_query_criteria_t * criteria,
115  void * context,
116  afw_object_cb_t callback,
117  const afw_object_t * adaptor_type_specific,
118  const afw_pool_t * p,
119  afw_xctx_t * xctx);
120 #endif
121 
122 #ifndef impl_afw_adaptor_session_get_object
123 /* Declare method get_object */
124 AFW_DECLARE_STATIC(void)
126  const afw_adaptor_session_t * instance,
127  const afw_adaptor_impl_request_t * impl_request,
128  const afw_utf8_t * object_type_id,
129  const afw_utf8_t * object_id,
130  void * context,
131  afw_object_cb_t callback,
132  const afw_object_t * adaptor_type_specific,
133  const afw_pool_t * p,
134  afw_xctx_t * xctx);
135 #endif
136 
137 #ifndef impl_afw_adaptor_session_add_object
138 /* Declare method add_object */
139 AFW_DECLARE_STATIC(const afw_utf8_t *)
141  const afw_adaptor_session_t * instance,
142  const afw_adaptor_impl_request_t * impl_request,
143  const afw_utf8_t * object_type_id,
144  const afw_utf8_t * suggested_object_id,
145  const afw_object_t * object,
146  const afw_object_t * adaptor_type_specific,
147  afw_xctx_t * xctx);
148 #endif
149 
150 #ifndef impl_afw_adaptor_session_modify_object
151 /* Declare method modify_object */
152 AFW_DECLARE_STATIC(void)
154  const afw_adaptor_session_t * instance,
155  const afw_adaptor_impl_request_t * impl_request,
156  const afw_utf8_t * object_type_id,
157  const afw_utf8_t * object_id,
158  const afw_adaptor_modify_entry_t * const * entry,
159  const afw_object_t * adaptor_type_specific,
160  afw_xctx_t * xctx);
161 #endif
162 
163 #ifndef impl_afw_adaptor_session_replace_object
164 /* Declare method replace_object */
165 AFW_DECLARE_STATIC(void)
167  const afw_adaptor_session_t * instance,
168  const afw_adaptor_impl_request_t * impl_request,
169  const afw_utf8_t * object_type_id,
170  const afw_utf8_t * object_id,
171  const afw_object_t * replacement_object,
172  const afw_object_t * adaptor_type_specific,
173  afw_xctx_t * xctx);
174 #endif
175 
176 #ifndef impl_afw_adaptor_session_delete_object
177 /* Declare method delete_object */
178 AFW_DECLARE_STATIC(void)
180  const afw_adaptor_session_t * instance,
181  const afw_adaptor_impl_request_t * impl_request,
182  const afw_utf8_t * object_type_id,
183  const afw_utf8_t * object_id,
184  const afw_object_t * adaptor_type_specific,
185  afw_xctx_t * xctx);
186 #endif
187 
188 #ifndef impl_afw_adaptor_session_begin_transaction
189 /* Declare method begin_transaction */
190 AFW_DECLARE_STATIC(const afw_adaptor_transaction_t *)
192  const afw_adaptor_session_t * instance,
193  afw_xctx_t * xctx);
194 #endif
195 
196 #ifndef impl_afw_adaptor_session_get_journal_interface
197 /* Declare method get_journal_interface */
198 AFW_DECLARE_STATIC(const afw_adaptor_journal_t *)
199 impl_afw_adaptor_session_get_journal_interface(
200  const afw_adaptor_session_t * instance,
201  afw_xctx_t * xctx);
202 #endif
203 
204 #ifndef impl_afw_adaptor_session_get_key_value_interface
205 /* Declare method get_key_value_interface */
206 AFW_DECLARE_STATIC(const afw_adaptor_key_value_t *)
208  const afw_adaptor_session_t * instance,
209  afw_xctx_t * xctx);
210 #endif
211 
212 #ifndef impl_afw_adaptor_session_get_index_interface
213 /* Declare method get_index_interface */
214 AFW_DECLARE_STATIC(const afw_adaptor_impl_index_t *)
216  const afw_adaptor_session_t * instance,
217  afw_xctx_t * xctx);
218 #endif
219 
220 #ifndef impl_afw_adaptor_session_get_object_type_cache_interface
221 /* Declare method get_object_type_cache_interface */
222 AFW_DECLARE_STATIC(const afw_adaptor_object_type_cache_t *)
223 impl_afw_adaptor_session_get_object_type_cache_interface(
224  const afw_adaptor_session_t * instance,
225  afw_xctx_t * xctx);
226 #endif
227 #endif
228 
229 /* inf for interface afw_adaptor_session */
230 #ifdef __BASE_FILE__
231 #define _AFW_IMPLEMENTATION_SOURCE_FILE_ __BASE_FILE__
232 #else
233 #define _AFW_IMPLEMENTATION_SOURCE_FILE_ __FILE__
234 #endif
235 #ifdef AFW_IMPLEMENTATION_INF_SPECIFIER
236 AFW_IMPLEMENTATION_INF_SPECIFIER(afw_adaptor_session_inf_t)
237 #else
238 static const afw_adaptor_session_inf_t
239 #endif
240 #ifdef AFW_IMPLEMENTATION_INF_LABEL
241 AFW_IMPLEMENTATION_INF_LABEL = {
242 #else
243 impl_afw_adaptor_session_inf = {
244 #endif
245  {
246  AFW_UTF8_LITERAL("afw_adaptor_session"),
247  AFW_UTF8_LITERAL(_AFW_IMPLEMENTATION_SOURCE_FILE_),
248  AFW_UTF8_LITERAL(_AFW_IMPLEMENTATION_ID_),
249  _AFW_IMPLEMENTATION_SPECIFIC_
250  },
259  impl_afw_adaptor_session_get_journal_interface,
262  impl_afw_adaptor_session_get_object_type_cache_interface
263 };
264 
265 #undef _AFW_IMPLEMENTATION_ID_
266 #undef _AFW_IMPLEMENTATION_SPECIFIC_
267 #undef _AFW_IMPLEMENTATION_SOURCE_FILE_
268 
#define AFW_BEGIN_DECLARES
Interface afw_interface opaque typedefs.
impl_afw_adaptor_session_modify_object(const afw_adaptor_session_t *instance, const afw_adaptor_impl_request_t *impl_request, const afw_utf8_t *object_type_id, const afw_utf8_t *object_id, const afw_adaptor_modify_entry_t *const *entry, const afw_object_t *adaptor_type_specific, afw_xctx_t *xctx)
impl_afw_adaptor_session_replace_object(const afw_adaptor_session_t *instance, const afw_adaptor_impl_request_t *impl_request, const afw_utf8_t *object_type_id, const afw_utf8_t *object_id, const afw_object_t *replacement_object, const afw_object_t *adaptor_type_specific, afw_xctx_t *xctx)
impl_afw_adaptor_session_delete_object(const afw_adaptor_session_t *instance, const afw_adaptor_impl_request_t *impl_request, const afw_utf8_t *object_type_id, const afw_utf8_t *object_id, const afw_object_t *adaptor_type_specific, afw_xctx_t *xctx)
impl_afw_adaptor_session_retrieve_objects(const afw_adaptor_session_t *instance, const afw_adaptor_impl_request_t *impl_request, const afw_utf8_t *object_type_id, const afw_query_criteria_t *criteria, void *context, afw_object_cb_t callback, const afw_object_t *adaptor_type_specific, const afw_pool_t *p, afw_xctx_t *xctx)
impl_afw_adaptor_session_begin_transaction(const afw_adaptor_session_t *instance, afw_xctx_t *xctx)
impl_afw_adaptor_session_destroy(const afw_adaptor_session_t *instance, afw_xctx_t *xctx)
impl_afw_adaptor_session_get_index_interface(const afw_adaptor_session_t *instance, afw_xctx_t *xctx)
impl_afw_adaptor_session_add_object(const afw_adaptor_session_t *instance, const afw_adaptor_impl_request_t *impl_request, const afw_utf8_t *object_type_id, const afw_utf8_t *suggested_object_id, const afw_object_t *object, const afw_object_t *adaptor_type_specific, afw_xctx_t *xctx)
impl_afw_adaptor_session_get_object(const afw_adaptor_session_t *instance, const afw_adaptor_impl_request_t *impl_request, const afw_utf8_t *object_type_id, const afw_utf8_t *object_id, void *context, afw_object_cb_t callback, const afw_object_t *adaptor_type_specific, const afw_pool_t *p, afw_xctx_t *xctx)
impl_afw_adaptor_session_get_key_value_interface(const afw_adaptor_session_t *instance, afw_xctx_t *xctx)
afw_boolean_t(* afw_object_cb_t)(const afw_object_t *object, void *context, afw_xctx_t *xctx)
Typedef for afw_adaptor_session_object callback.
Definition: afw_common.h:1176
#define AFW_UTF8_LITERAL(A_STRING)
String literal initializer.
Definition: afw_common.h:582
Interface afw_adaptor_impl_index public struct.
Internal request info used by afw_adaptor_impl*() functions.
Interface afw_adaptor_journal public struct.
Interface afw_adaptor_key_value public struct.
Adaptor modify entry.
Interface afw_adaptor_object_type_cache public struct.
Interface afw_adaptor_session_inf_s struct.
Interface afw_adaptor_session public struct.
Interface afw_adaptor_transaction public struct.
Interface afw_object public struct.
Interface afw_pool public struct.
Parsed query criteria.
NFC normalized UTF-8 string.
Definition: afw_common.h:545
Interface afw_xctx public struct.