afw_adaptor.h

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * Helpers for interfaces afw_adaptor*
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#ifndef __AFW_ADAPTOR_H__
#define __AFW_ADAPTOR_H__
 
#include "afw_interface.h"
 
/* Headers that are part of the adaptor api. */
#include "afw_adaptor_add.h"
#include "afw_adaptor_delete.h"
#include "afw_adaptor_get.h"
#include "afw_adaptor_journal.h"
#include "afw_adaptor_modify.h"
#include "afw_adaptor_replace.h"
#include "afw_adaptor_retrieve.h"
 
AFW_BEGIN_DECLARES
 
 
struct afw_adaptor_id_anchor_s {
    
    const afw_utf8_t *adaptor_id;
    
    const afw_utf8_t *adaptor_type_id;
    
    const afw_adaptor_t *adaptor;
 
    const afw_object_t *properties;
 
    const afw_utf8_t *service_id;
 
    afw_integer_t reference_count;
 
    afw_adaptor_id_anchor_t *stopping;
};
 
 
 
AFW_DECLARE(void)
afw_adaptor_context_prepare(
    const afw_adaptor_t *adaptor,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_adaptor_t *)
afw_adaptor_get_reference(const afw_utf8_t *adaptor_id, afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_query_criteria_t *)
afw_adaptor_query_criteria_parse_object(
    const afw_object_t *query_criteria,
    const afw_utf8_t *adaptor_id,
    const afw_utf8_t *object_type_id,
    const afw_object_t *journal_entry,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_query_criteria_t *)
afw_adaptor_query_criteria_parse_url_encoded_rql_string(
    const afw_utf8_t *url_encoded_rql_string,
    const afw_utf8_t *adaptor_id,
    const afw_utf8_t *object_type_id,
    const afw_object_t *journal_entry,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_adaptor_release(const afw_adaptor_t *adaptor, afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_adaptor_session_commit_and_release_cache(afw_boolean_t abort,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_adaptor_session_t *)
afw_adaptor_session_create(
    const afw_utf8_t *adaptor_id, afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_adaptor_session_t *)
afw_adaptor_session_get_cached(
    const afw_utf8_t *adaptor_id,
    afw_boolean_t begin_transaction,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_adaptor_session_release(
    const afw_adaptor_session_t *session,
    afw_xctx_t *xctx);
 
AFW_END_DECLARES
 
#endif /* __AFW_ADAPTOR_H__ */