Skip to content
Snippets Groups Projects
Commit 9af9b252 authored by Joscha Schmiedt's avatar Joscha Schmiedt
Browse files

Fix broken renaming of clinkahead.h

parent c188d234
Branches
Tags
2 merge requests!61Release 0.3.0,!55Rename caosdb-cpplib to linkahead-cpplib
Hide whitespace changes
Inline Side-by-side
Showing
with 113 additions and 115 deletions
include/clinkahead.h
+ 113
− 115
View file @ 9af9b252
......@@ -33,37 +33,37 @@ extern "C" {
/**
* Return the constant linkahead::LIBLINKAHEAD_VERSION_MAJOR.
*/
int dconstants_LIBLINKAHEAD_VERSION_MAJOR();
int linkahead_constants_LIBLINKAHEAD_VERSION_MAJOR();
/**
* Return the constant linkahead::LIBLINKAHEAD_VERSION_MINOR
*/
int dconstants_LIBLINKAHEAD_VERSION_MINOR();
int linkahead_constants_LIBLINKAHEAD_VERSION_MINOR();
/**
* Return the constant linkahead::LIBLINKAHEAD_VERSION_PATCH.
*/
int dconstants_LIBLINKAHEAD_VERSION_PATCH();
int linkahead_constants_LIBLINKAHEAD_VERSION_PATCH();
/**
* Return the constant linkahead::COMPATIBLE_SERVER_VERSION_MAJOR.
*/
int dconstants_COMPATIBLE_SERVER_VERSION_MAJOR();
int linkahead_constants_COMPATIBLE_SERVER_VERSION_MAJOR();
/**
* Return the constant linkahead::COMPATIBLE_SERVER_VERSION_MINOR.
*/
int dconstants_COMPATIBLE_SERVER_VERSION_MINOR();
int linkahead_constants_COMPATIBLE_SERVER_VERSION_MINOR();
/**
* Return the constant linkahead::COMPATIBLE_SERVER_VERSION_PATCH.
*/
int dconstants_COMPATIBLE_SERVER_VERSION_PATCH();
int linkahead_constants_COMPATIBLE_SERVER_VERSION_PATCH();
/**
* Return the constant linkahead::COMPATIBLE_SERVER_VERSION_PRE_RELEASE.
*/
const char *dconstants_COMPATIBLE_SERVER_VERSION_PRE_RELEASE();
const char *linkahead_constants_COMPATIBLE_SERVER_VERSION_PRE_RELEASE();
/**
* Return the status code reserved for errors in clients wrapping this
* interface.
*/
int dstatus_code_OTHER_CLIENT_ERROR();
int linkahead_status_code_OTHER_CLIENT_ERROR();
/**
* A wrapper of the C++ Connection class.
......@@ -72,10 +72,10 @@ int dstatus_code_OTHER_CLIENT_ERROR();
* capability for type checking in C even though the C++ class
* Connection is opaque in C.
*/
typedef struct dconnection_connection {
typedef struct linkahead_connection_connection {
void *wrapped_connection;
bool _deletable;
} dconnection_connection;
} linkahead_connection_connection;
/**
* A wrapper of the C++ ConnectionConfiguration class.
......@@ -84,10 +84,10 @@ typedef struct dconnection_connection {
* capability for type checking in C even though the C++ class
* Connection is opaque in C.
*/
typedef struct dconnection_connection_configuration {
typedef struct linkahead_connection_connection_configuration {
void *wrapped_connection_configuration;
bool _deletable;
} dconnection_connection_configuration;
} linkahead_connection_connection_configuration;
/**
* A wrapper of the C++ VersionInfo class.
......@@ -96,55 +96,55 @@ typedef struct dconnection_connection_configuration {
* capability for type checking in C even though the C++ class
* Connection is opaque in C.
*/
typedef struct dinfo_version_info {
typedef struct linkahead_info_version_info {
int major;
int minor;
int patch;
const char *pre_release;
const char *build;
} dinfo_version_info;
} linkahead_info_version_info;
typedef struct dconnection_certificate_provider {
typedef struct linkahead_connection_certificate_provider {
void *wrapped_certificate_provider;
bool _deletable;
} dconnection_certificate_provider;
} linkahead_connection_certificate_provider;
typedef struct dauthentication_authenticator {
typedef struct linkahead_authentication_authenticator {
void *wrapped_authenticator;
bool _deletable;
} dauthentication_authenticator;
} linkahead_authentication_authenticator;
/**
* Return the environment variable of the given name.
*
* If the environment variable is not set, return the fallback instead.
*/
const char *dutility_get_env_fallback(const char *name, const char *fallback);
const char *linkahead_utility_get_env_fallback(const char *name, const char *fallback);
/**
* Return a description of the status code.
*/
const char *dget_status_description(int code);
const char *linkahead_get_status_description(int code);
/**
* Create a pem-file certificate provider.
*
* Use the destructor function
* `dconnection_delete_certificate_provider` to free the wrapped
* `linkahead_connection_delete_certificate_provider` to free the wrapped
* provider.
*
* EXPERT USE ONLY. Memory management with this function is a bit tricky.
* Only use it when you know what you are doing.
*/
int dconnection_create_pem_file_certificate_provider(dconnection_certificate_provider *out,
const char *path);
int linkahead_connection_create_pem_file_certificate_provider(
linkahead_connection_certificate_provider *out, const char *path);
/**
* Destructor function for a certificate provider.
*
* EXPERT USE ONLY. Only use it when you know what you are doing.
*/
int dconnection_delete_certificate_provider(dconnection_certificate_provider *provider);
int linkahead_connection_delete_certificate_provider(linkahead_connection_certificate_provider *provider);
/**
* Create a tls-secured connection configuration.
......@@ -152,43 +152,43 @@ int dconnection_delete_certificate_provider(dconnection_certificate_provider *pr
* The configuration is needed to instantiate a connection.
*
* Use the destructor function
* `dconnection_delete_connection_configuration` to free the wrapped
* `linkahead_connection_delete_connection_configuration` to free the wrapped
* configuration.
*
* EXPERT USE ONLY. Memory management with this function is a bit tricky.
* Only use it when you know what you are doing.
*/
int dconnection_create_tls_connection_configuration(dconnection_connection_configuration *out,
const char *host, const int port,
dauthentication_authenticator *authenticator,
dconnection_certificate_provider *provider);
int linkahead_connection_create_tls_connection_configuration(
linkahead_connection_connection_configuration *out, const char *host, const int port,
linkahead_authentication_authenticator *authenticator,
linkahead_connection_certificate_provider *provider);
/**
* Create a tls-secured connection configuration.
*
* The configuration is needed to instantiate a connection.
*
* Use `dconnection_create_tls_connection_configuration` for a
* Use `linkahead_connection_create_tls_connection_configuration` for a
* tls-secured connection which also supports authentication.
*
* Use the destructor function
* `dconnection_delete_connection_configuration` to free the wrapped
* `linkahead_connection_delete_connection_configuration` to free the wrapped
* configuration.
*
* EXPERT USE ONLY. Memory management with this function is a bit tricky.
* Only use it when you know what you are doing.
*/
int dconnection_create_insecure_connection_configuration(dconnection_connection_configuration *out,
const char *host, const int port);
int linkahead_connection_create_insecure_connection_configuration(
linkahead_connection_connection_configuration *out, const char *host, const int port);
/**
* Destructor function for the dconnection_connection_configuration
* Destructor function for the linkahead_connection_connection_configuration
* struct.
*
* EXPERT USE ONLY. Only use it when you know what you are doing.
*/
int dconnection_delete_connection_configuration(
dconnection_connection_configuration *configuration);
int linkahead_connection_delete_connection_configuration(
linkahead_connection_connection_configuration *configuration);
/**
* Add a public certificate of a trusted certificate authority to an
......@@ -196,28 +196,28 @@ int dconnection_delete_connection_configuration(
*
* @param cacert path to a pem-file.
*/
int dconnection_configuration_add_cacert(dconnection_connection_configuration *configuration,
const char *cacert);
int linkahead_connection_configuration_add_cacert(
linkahead_connection_connection_configuration *configuration, const char *cacert);
/**
* Create a plain password authenticator.
*
* Use the destructor function
* `dauthentication_delete_authenticator` to free the wrapped
* `linkahead_authentication_delete_authenticator` to free the wrapped
* authenticator.
*
* EXPERT USE ONLY. Memory management with this function is a bit tricky.
* Only use it when you know what you are doing.
*/
int dauthentication_create_plain_password_authenticator(dauthentication_authenticator *out,
const char *username, const char *password);
int linkahead_authentication_create_plain_password_authenticator(
linkahead_authentication_authenticator *out, const char *username, const char *password);
/**
* Destructor function for the dauthentication_authenticator struct.
* Destructor function for the linkahead_authentication_authenticator struct.
*
* EXPERT USE ONLY. Only use it when you know what you are doing.
*/
int dauthentication_delete_authenticator(dauthentication_authenticator *authenticator);
int linkahead_authentication_delete_authenticator(linkahead_authentication_authenticator *authenticator);
/**
* Create a connection instance.
......@@ -226,92 +226,97 @@ int dauthentication_delete_authenticator(dauthentication_authenticator *authenti
* interaction with a CaosDB server.
*
* Use the destructor function
* `dconnection_delete_connection` to free the wrapped
* `linkahead_connection_delete_connection` to free the wrapped
* connection.
*
* EXPERT USE ONLY. Memory management with this function is a bit tricky.
* Only use it when you know what you are doing.
*/
int dconnection_create_connection(dconnection_connection *out,
const dconnection_connection_configuration *configuration);
int linkahead_connection_create_connection(
linkahead_connection_connection *out,
const linkahead_connection_connection_configuration *configuration);
/**
* Destructor function for the dconnection_connection struct.
* Destructor function for the linkahead_connection_connection struct.
*
* EXPERT USE ONLY. Only use it when you know what you are doing.
*/
int dconnection_delete_connection(dconnection_connection *connection);
int linkahead_connection_delete_connection(linkahead_connection_connection *connection);
/**
* Request the version of the server.
*/
int dconnection_get_version_info(dinfo_version_info *out, const dconnection_connection *connection);
int linkahead_connection_get_version_info(linkahead_info_version_info *out,
const linkahead_connection_connection *connection);
/**
* Get the default connection from the ConnectionManager.
*
* The default connection is to be specified in a configuration file.
*/
int dconnection_connection_manager_get_default_connection(dconnection_connection *out);
int linkahead_connection_connection_manager_get_default_connection(linkahead_connection_connection *out);
/**
* Get a named connection from the ConnectionManager.
*
* The named connection is to be specified in a configuration file.
*/
int dconnection_connection_manager_get_connection(dconnection_connection *out, const char *name);
int linkahead_connection_connection_manager_get_connection(linkahead_connection_connection *out,
const char *name);
/****************************************************************************
* ENTITY STUFF AND TRANSACTIONS
****************************************************************************/
typedef struct dtransaction_transaction {
typedef struct linkahead_transaction_transaction {
void *wrapped_transaction;
bool _deletable;
} dtransaction_transaction;
} linkahead_transaction_transaction;
/**
* Create a transaction on an existing connection.
*
* This transaction has to be deleted manually by
* dtransaction_delete_transaction() later on.
* linkahead_transaction_delete_transaction() later on.
*/
int dconnection_connection_create_transaction(dconnection_connection *connection,
dtransaction_transaction *out);
int dtransaction_delete_transaction(dtransaction_transaction *transaction);
int dtransaction_transaction_retrieve_by_id(dtransaction_transaction *transaction, const char *id);
int dtransaction_transaction_retrieve_and_download_file_by_id(dtransaction_transaction *transaction,
const char *id, const char *path);
int dtransaction_transaction_retrieve_by_ids(dtransaction_transaction *transaction,
const char *ids[], int length);
int dtransaction_transaction_query(dtransaction_transaction *transaction, const char *query);
int dtransaction_transaction_execute(dtransaction_transaction *transaction);
int linkahead_connection_connection_create_transaction(linkahead_connection_connection *connection,
linkahead_transaction_transaction *out);
int linkahead_transaction_delete_transaction(linkahead_transaction_transaction *transaction);
int linkahead_transaction_transaction_retrieve_by_id(linkahead_transaction_transaction *transaction,
const char *id);
int linkahead_transaction_transaction_retrieve_and_download_file_by_id(
linkahead_transaction_transaction *transaction, const char *id, const char *path);
int linkahead_transaction_transaction_retrieve_by_ids(linkahead_transaction_transaction *transaction,
const char *ids[], int length);
int linkahead_transaction_transaction_query(linkahead_transaction_transaction *transaction,
const char *query);
int linkahead_transaction_transaction_execute(linkahead_transaction_transaction *transaction);
// TODO(fspreck) execute_asynchronously may be added as a separate
// function once we actually support asynchronous execution.
typedef struct dtransaction_result_set {
typedef struct linkahead_transaction_result_set {
void *wrapped_result_set;
bool _deletable;
} dtransaction_result_set;
} linkahead_transaction_result_set;
typedef struct dentity_entity {
void *wrapped_entity;
bool _deletable;
} dentity_entity;
int dtransaction_transaction_get_result_set(dtransaction_transaction *transaction,
dtransaction_result_set *out);
int linkahead_transaction_transaction_get_result_set(linkahead_transaction_transaction *transaction,
linkahead_transaction_result_set *out);
/**
* Release the result set from the transaction.
*
* The transactions is spoiled after this action and should not be used anymore.
*
* Note: The result_set has to be deleted via dtransaction_delete_result_set.
* Note: The result_set has to be deleted via linkahead_transaction_delete_result_set.
*
* EXPERT USE ONLY. Only use it when you know what you are doing.
*/
int dtransaction_transaction_release_result_set(dtransaction_transaction *transaction,
dtransaction_result_set *out);
int linkahead_transaction_transaction_release_result_set(linkahead_transaction_transaction *transaction,
linkahead_transaction_result_set *out);
/**
* Release the entity from the result set.
*
......@@ -322,27 +327,28 @@ int dtransaction_transaction_release_result_set(dtransaction_transaction *transa
*
* EXPERT USE ONLY. Only use it when you know what you are doing.
*/
int dtransaction_result_set_release_at(dtransaction_result_set *result_set, dentity_entity *entity,
int index);
int linkahead_transaction_result_set_release_at(linkahead_transaction_result_set *result_set,
dentity_entity *entity, int index);
/**
* Destructor for dtransaction_result_set.
* Destructor for linkahead_transaction_result_set.
*
* EXPERT USE ONLY. Only use it when you know what you are doing.
*/
int dtransaction_delete_result_set(dtransaction_result_set *result_set);
int linkahead_transaction_delete_result_set(linkahead_transaction_result_set *result_set);
int dtransaction_transaction_get_count_result(dtransaction_transaction *transaction, long *out);
int linkahead_transaction_transaction_get_count_result(linkahead_transaction_transaction *transaction,
long *out);
int linkahead_transaction_result_set_at(linkahead_transaction_result_set *result_set,
linkahead_entity_entity *entity, int index);
linkahead_entity_entity *entity, int index);
int linkahead_transaction_result_set_size(linkahead_transaction_result_set *result_set, int *out);
int linkahead_transaction_transaction_insert_entity(linkahead_transaction_transaction *transaction,
linkahead_entity_entity *entity);
linkahead_entity_entity *entity);
int linkahead_transaction_transaction_update_entity(linkahead_transaction_transaction *transaction,
linkahead_entity_entity *entity);
linkahead_entity_entity *entity);
int linkahead_transaction_transaction_delete_by_id(linkahead_transaction_transaction *transaction,
const char *id);
const char *id);
typedef struct linkahead_entity_property {
void *wrapped_property;
......@@ -375,36 +381,34 @@ int linkahead_entity_entity_get_role(linkahead_entity_entity *entity, char **out
int linkahead_entity_entity_get_name(linkahead_entity_entity *entity, char **out);
int linkahead_entity_entity_get_description(linkahead_entity_entity *entity, char **out);
int linkahead_entity_entity_get_local_path(linkahead_entity_entity *entity, char **out);
int linkahead_entity_entity_get_datatype(linkahead_entity_entity *entity,
linkahead_entity_datatype *out);
int linkahead_entity_entity_get_datatype(linkahead_entity_entity *entity, linkahead_entity_datatype *out);
int linkahead_entity_entity_get_unit(linkahead_entity_entity *entity, char **out);
int linkahead_entity_entity_get_value(linkahead_entity_entity *entity, linkahead_entity_value *out);
int linkahead_entity_entity_get_version_id(linkahead_entity_entity *entity, char **out);
int linkahead_entity_entity_get_errors_size(linkahead_entity_entity *entity, int *out);
int linkahead_entity_entity_get_error(linkahead_entity_entity *entity,
linkahead_entity_message *out, int index);
int linkahead_entity_entity_get_error(linkahead_entity_entity *entity, linkahead_entity_message *out,
int index);
int linkahead_entity_entity_get_warnings_size(linkahead_entity_entity *entity, int *out);
int linkahead_entity_entity_get_warning(linkahead_entity_entity *entity,
linkahead_entity_message *out, int index);
int linkahead_entity_entity_get_warning(linkahead_entity_entity *entity, linkahead_entity_message *out,
int index);
int linkahead_entity_entity_get_infos_size(linkahead_entity_entity *entity, int *out);
int linkahead_entity_entity_get_info(linkahead_entity_entity *entity, linkahead_entity_message *out,
int index);
int index);
int linkahead_entity_entity_get_properties_size(linkahead_entity_entity *entity, int *out);
int linkahead_entity_entity_get_property(linkahead_entity_entity *entity,
linkahead_entity_property *out, int index);
int linkahead_entity_entity_get_property(linkahead_entity_entity *entity, linkahead_entity_property *out,
int index);
int linkahead_entity_entity_get_parents_size(linkahead_entity_entity *entity, int *out);
int linkahead_entity_entity_get_parent(linkahead_entity_entity *entity,
linkahead_entity_parent *out, int index);
int linkahead_entity_entity_get_parent(linkahead_entity_entity *entity, linkahead_entity_parent *out,
int index);
int linkahead_entity_property_get_id(linkahead_entity_property *property, char **out);
int linkahead_entity_property_get_name(linkahead_entity_property *property, char **out);
int linkahead_entity_property_get_description(linkahead_entity_property *property, char **out);
int linkahead_entity_property_get_importance(linkahead_entity_property *property, char **out);
int linkahead_entity_property_get_datatype(linkahead_entity_property *property,
linkahead_entity_datatype *out);
linkahead_entity_datatype *out);
int linkahead_entity_property_get_unit(linkahead_entity_property *property, char **out);
int linkahead_entity_property_get_value(linkahead_entity_property *property,
linkahead_entity_value *out);
int linkahead_entity_property_get_value(linkahead_entity_property *property, linkahead_entity_value *out);
int linkahead_entity_parent_get_id(linkahead_entity_parent *parent, char **out);
int linkahead_entity_parent_get_name(linkahead_entity_parent *parent, char **out);
int linkahead_entity_parent_get_description(linkahead_entity_parent *parent, char **out);
......@@ -430,8 +434,8 @@ int linkahead_entity_value_get_as_double(linkahead_entity_value *value, double *
int linkahead_entity_value_get_as_integer(linkahead_entity_value *value, int64_t *out);
int linkahead_entity_value_get_as_bool(linkahead_entity_value *value, bool *out);
int linkahead_entity_value_get_as_vector_size(linkahead_entity_value *value, int *out);
int linkahead_entity_value_get_as_vector_at(linkahead_entity_value *value,
linkahead_entity_value *out, const int index);
int linkahead_entity_value_get_as_vector_at(linkahead_entity_value *value, linkahead_entity_value *out,
const int index);
// CONSTRUCTORS AND DESTRUCTORS
int linkahead_entity_create_entity(linkahead_entity_entity *out);
......@@ -445,8 +449,7 @@ int linkahead_entity_delete_parent(linkahead_entity_parent *out);
int linkahead_entity_create_atomic_datatype(linkahead_entity_datatype *out, const char *name);
int linkahead_entity_create_reference_datatype(linkahead_entity_datatype *out, const char *name);
int linkahead_entity_create_atomic_list_datatype(linkahead_entity_datatype *out, const char *name);
int linkahead_entity_create_reference_list_datatype(linkahead_entity_datatype *out,
const char *name);
int linkahead_entity_create_reference_list_datatype(linkahead_entity_datatype *out, const char *name);
int linkahead_entity_delete_datatype(linkahead_entity_datatype *out);
// VALUE CONSTRUCTORS (resolve overloaded constructors)
......@@ -455,44 +458,39 @@ int linkahead_entity_create_string_value(linkahead_entity_value *out, const char
int linkahead_entity_create_double_value(linkahead_entity_value *out, const double value);
int linkahead_entity_create_bool_value(linkahead_entity_value *out, const bool value);
int linkahead_entity_create_int_vector_value(linkahead_entity_value *out, const int64_t *value,
const int length);
const int length);
int linkahead_entity_create_string_vector_value(linkahead_entity_value *out, const char **value,
const int length);
const int length);
int linkahead_entity_create_double_vector_value(linkahead_entity_value *out, const double *value,
const int length);
const int length);
int linkahead_entity_create_bool_vector_value(linkahead_entity_value *out, const bool *value,
const int length);
const int length);
int linkahead_entity_delete_value(linkahead_entity_value *out);
// SETTERS FOR EVERYTHING THAT MAY BE SET
int linkahead_entity_entity_set_role(linkahead_entity_entity *entity, const char *role);
int linkahead_entity_entity_set_name(linkahead_entity_entity *entity, const char *name);
int linkahead_entity_entity_set_description(linkahead_entity_entity *entity,
const char *description);
int linkahead_entity_entity_set_description(linkahead_entity_entity *entity, const char *description);
int linkahead_entity_entity_set_local_path(linkahead_entity_entity *entity, const char *name);
int linkahead_entity_entity_set_file_path(linkahead_entity_entity *entity, const char *name);
int linkahead_entity_entity_set_datatype(linkahead_entity_entity *entity,
linkahead_entity_datatype *datatype);
linkahead_entity_datatype *datatype);
int linkahead_entity_entity_set_unit(linkahead_entity_entity *entity, const char *unit);
int linkahead_entity_entity_set_value(linkahead_entity_entity *entity,
linkahead_entity_value *value);
int linkahead_entity_entity_set_value(linkahead_entity_entity *entity, linkahead_entity_value *value);
int linkahead_entity_entity_append_parent(linkahead_entity_entity *entity,
linkahead_entity_parent *parent);
int linkahead_entity_entity_append_parent(linkahead_entity_entity *entity, linkahead_entity_parent *parent);
int linkahead_entity_entity_remove_parent(linkahead_entity_entity *entity, int index);
int linkahead_entity_entity_append_property(linkahead_entity_entity *entity,
linkahead_entity_property *property);
linkahead_entity_property *property);
int linkahead_entity_entity_remove_property(linkahead_entity_entity *entity, int index);
int linkahead_entity_property_set_id(linkahead_entity_property *property, const char *id);
int linkahead_entity_property_set_name(linkahead_entity_property *property, const char *name);
int linkahead_entity_property_set_datatype(linkahead_entity_property *property,
linkahead_entity_datatype *datatype);
int linkahead_entity_property_set_importance(linkahead_entity_property *property,
const char *importance);
linkahead_entity_datatype *datatype);
int linkahead_entity_property_set_importance(linkahead_entity_property *property, const char *importance);
int linkahead_entity_property_set_unit(linkahead_entity_property *property, const char *unit);
int linkahead_entity_property_set_value(linkahead_entity_property *property,
linkahead_entity_value *value);
int linkahead_entity_property_set_value(linkahead_entity_property *property, linkahead_entity_value *value);
int linkahead_entity_parent_set_id(linkahead_entity_parent *parent, const char *id);
int linkahead_entity_parent_set_name(linkahead_entity_parent *parent, const char *name);
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment