Grid Application Toolkit A simple API for Grid Applications

Menu Home API-Specification API-Overview Status C Reference Manual Download Java Java-Reference General GridLab - WP-1 Links

GATAdvertServiceCPI.c Go to the documentation of this file. /** @file GATAdvertServiceCPI.c * Source file for the GATAdvertServiceCPI class. * * @date Fri Feb 13 2004 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATAdvertServiceCPI.c,v 1.5 2004/04/02 12:31:57 hartmutkaiser Exp $ * * Copyright (C) Hartmut Kaiser * This file is part of the GAT Engine. * Contributed by Hartmut Kaiser <hartmutkaiser [at] t-online [dot] de>. * * Use, modification and distribution is subject to the Gridlab Software * License. (See accompanying file GLlicense.txt or copy at * http://www.gridlab.org/GLlicense.txt) */ static const char *rcsid = "$Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATAdvertServiceCPI.c,v 1.5 2004/04/02 12:31:57 hartmutkaiser Exp $"; /* System Header Files */ #include <stdio.h> #include <stdlib.h> /* GAT Header Files */ #include "GATErrors.h" #include "GATAdvertServiceCPI.h" /* Macros */ /* Structures, unions and enums */ struct GATAdvertServiceCPI_S { /* CPI data (type local data) */ void *data; GATAdvertServiceCPI_Adaptor_Destroy destroy; /* CPI instance data */ GATAdvertServiceCPI_Adaptor_ServiceActions service_actions; GATAdvertServiceCPI_Adaptor_CreateInstance create_instance; GATAdvertServiceCPI_Adaptor_DestroyInstance destroy_instance; GATAdvertServiceCPI_Adaptor_CloneInstance clone_instance; GATAdvertServiceCPI_Adaptor_EqualsInstance equals_instance; /* CPI functionality */ GATAdvertServiceCPI_Adaptor_Add add_entry; GATAdvertServiceCPI_Adaptor_Delete delete_entry; GATAdvertServiceCPI_Adaptor_GetMetaData get_metadata; GATAdvertServiceCPI_Adaptor_GetAdvertisable get_advertisable; GATAdvertServiceCPI_Adaptor_Find find_entries; /* CPI monitoring support */ GATAdvertServiceCPI_Adaptor_GetMetrics get_metrics; GATAdvertServiceCPI_Adaptor_GetMetricEvent get_metric_event; }; /* Static function prototypes */ static GATBool GATAdvertServiceCPI_IsValidData_V1(GATAdvertServiceCPI_Data *data); /* File scope variables */ /* External functions */ /** GATAdvertServiceCPI_Create * The GATAdvertServiceCPI constructor. * new_cpi is the constructor for GATAdvertServiceCPI objects. * * @param version Version of the GATAdvertServiceCPI_Data structure * @param data Pointer to adaptor CPI instance data structure. * * @return A new GATAdvertServiceCPI */ GATAdvertServiceCPI GATAdvertServiceCPI_Create(unsigned long int version, GATAdvertServiceCPI_Data *data) { GATAdvertServiceCPI new_cpi = NULL; if (version <= GATADVERTSERVICECPI_VERSION) { if (version == GATADVERTSERVICECPI_VERSION && GATTrue == GATAdvertServiceCPI_IsValidData_V1(data)) { new_cpi = (GATAdvertServiceCPI)malloc(sizeof(*new_cpi)); if(NULL != new_cpi) { new_cpi->data = data->data; new_cpi->destroy = data->destroy; new_cpi->service_actions = data->service_actions; new_cpi->destroy_instance = data->destroy_instance; new_cpi->create_instance = data->create_instance; new_cpi->equals_instance = data->equals_instance; new_cpi->clone_instance = data->clone_instance; new_cpi->add_entry = data->add_entry; new_cpi->delete_entry = data->delete_entry; new_cpi->get_metadata = data->get_metadata; new_cpi->get_advertisable = data->get_advertisable; new_cpi->find_entries = data->find_entries; new_cpi->get_metrics = data->get_metrics; new_cpi->get_metric_event = data->get_metric_event; } } /* add functionality for newer versions here else if (version == GATADVERTSERVICECPI_VERSION2 && GATAdvertServiceCPI_IsValidData_V2(data)) { ... } */ else { /* Missing required functions */ /* error_code = GAT_INVALID_PARAMETER; */ new_cpi = NULL; } } else { /* unknown version */ /* error_code = GAT_UNKNOWN_VERSION; */ new_cpi = NULL; } return new_cpi; } /** GATAdvertServiceCPI_Destroy * @brief The GATAdvertServiceCPI destructor. * * This is the destructor for GATAdvertServiceCPI objects. * * @param this An old GATAdvertServiceCPI */ void GATAdvertServiceCPI_Destroy(GATAdvertServiceCPI *object) { if(NULL != object && NULL != *object) { /* call the adapter supplied destroy function */ (*object)->destroy((*object)->data); free(*object); *object = NULL; } } /** GATAdvertServiceCPI_CreateInstance * @brief Create a new CPI object instance * * Calls the adaptor to create a new CPI object instance. * * @param this The CPI object. * @param context a GATContext * @param instance_data The instance data of the attached CPI object * * @return An error code. */ GATResult GATAdvertServiceCPI_CreateInstance(GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance *instance_data) { return cpi->create_instance(cpi->data, instance_data); } /** GATAdvertServiceCPI_DestroyInstance * @brief Create a new CPI object instance * * Calls the adaptor to destroy a CPI object instance. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object */ void GATAdvertServiceCPI_DestroyInstance(GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance *instance_data) { cpi->destroy_instance(cpi->data, instance_data); } /** GATAdvertServiceCPI_EqualsInstance * @brief Compares two CPI object instances. * * Calls the adaptor to compare two CPI object instances. * * @param this The CPI object. * @param lhs The instance data of the left CPI object * @param rhs The instance data of the right CPI object * @param isequal The pointer to the variable, where the result is to be * returned to. * * @return An error code. */ GATResult GATAdvertServiceCPI_EqualsInstance(GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance const *lhs, GATAdvertServiceCPI_Instance const *rhs, GATBool *isequal) { return cpi->equals_instance(cpi->data, lhs, rhs, isequal); } /** GATAdvertServiceCPI_CloneInstance * @brief Clones a CPI object instance. * * Calls the adaptor to clone a CPI object instance. * * @param this The CPI object. * @param instance_data The instance data of the CPI object to clone. * @param new_instance_data The new instance data is to be returned here. * * @return An error code. */ GATResult GATAdvertServiceCPI_CloneInstance(GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance const *instance_data, GATAdvertServiceCPI_Instance *new_instance_data) { return cpi->clone_instance(cpi->data, instance_data, new_instance_data); } /** GATAdvertServiceCPI_GetMetrics * * The function GATAdvertServiceCPI_GetMetrics returns the list of metrics supported * by this adaptor. * * @param cpi The CPI object. * @param instance_data The instance data of the attached CPI object * @param The pointer to the variable, which receives the resulting list of * metrics. * * @return An error code. */ GATResult GATAdvertServiceCPI_GetMetrics(GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance const *data, GATList_GATMetric *metrics) { return cpi->get_metrics(cpi->data, data, metrics); } /** GATAdvertServiceCPI_GetMetricEvent * * The function GATAdvertServiceCPI_GetMetricEvent returns the metric event, which is * associated with the given metric. * * @param cpi The CPI object. * @param instance_data The instance data of the attached CPI object * @param metric The continuous metric, for which the metric event is to be * returned. * @param event The pointer to the variable, which receives the resulting * metric event. * * @return An error code. */ GATResult GATAdvertServiceCPI_GetMetricEvent(GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance const *data, GATMetric metric, GATMetricEvent *event) { return cpi->get_metric_event(cpi->data, data, metric, event); } /** GATAdvertServiceCPI_Add * * Calls the adaptor to add a new entry to the advert service. * * @param this The CPI object. * @param instance_data The instance data of the CPI object to add the entry * to. * @param advertisable The advertisable object, which should be stored in the * given advertservice. * @param metadata The meta data to rassociate with the newly created entry. * @param path The path inside the advert service, where the newly created * entry is to be stored. * * @return An error code. */ GATResult GATAdvertServiceCPI_Add(GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance *instance_data, GATObject_const advertisable, GATTable_const metadata, GATString_const path) { return cpi->add_entry(cpi->data, instance_data, advertisable, metadata, path); } /** GATAdvertServiceCPI_Delete * * Calls the adaptor to delete an entry from the advert service. * * @param this The CPI object. * @param instance_data The instance data of the CPI object to delete the entry * from. * @param path The path of the entry to delete from the given advert service. * * @return An error code. */ GATResult GATAdvertServiceCPI_Delete(GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance *instance_data, GATString_const path) { return cpi->delete_entry(cpi->data, instance_data, path); } /** GATAdvertServiceCPI_GetMetaData * * Calls the adaptor to retrieve the meta data of a given entry in the advert * service. * * @param this The CPI object. * @param instance_data The instance data of the CPI object to get the meta * data for a certain entry from. * @param path The path of the entry, for which the meta data should be * retrieved. * @param The pointer to a variable, which receives the requested meta data. * * @return An error code. */ GATResult GATAdvertServiceCPI_GetMetaData(GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance const *instance_data, GATString_const path, GATTable *metadata) { return cpi->get_metadata(cpi->data, instance_data, path, metadata); } /** GATAdvertServiceCPI_GetAdvertisable * * Calls the adaptor to retrieve the advertisable object stored in a given * entry in the advert service. * * @param this The CPI object. * @param instance_data The instance data of the CPI object to get the * advertised object for a certain entry from. * @param path The path of the entry, for which the stroed advertisable should * be retrieved. * @param advertisable The pointer to a variable, which should receive the * requested advertisable object. * * @return An error code. */ GATResult GATAdvertServiceCPI_GetAdvertisable(GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance const *instance_data, GATString_const path, GATObject *advertisable) { return cpi->get_advertisable(cpi->data, instance_data, path, advertisable); } /** GATAdvertServiceCPI_Find * * Calls the adaptor to find a list of matching entries in the advert service. * * @param this The CPI object. * @param instance_data The instance data of the CPI object, where to find the * matching entries. * @param metadata The meta data search criteria to use for the query. * @param paths The pointer to a variable, which should receive the list of * paths pointing to matching entries inside the given advert service. * * @return An error code. */ GATResult GATAdvertServiceCPI_Find(GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance const *instance_data, GATTable_const metadata, GATList_String *paths) { return cpi->find_entries(cpi->data, instance_data, metadata, paths); } /* Local functions */ static GATBool GATAdvertServiceCPI_IsValidData_V1(GATAdvertServiceCPI_Data *data) { return ( NULL != data->get_metrics && NULL != data->get_metric_event && NULL != data->destroy && NULL != data->add_entry && NULL != data->delete_entry && NULL != data->get_metadata && NULL != data->get_advertisable && NULL != data->find_entries && NULL != data->create_instance && NULL != data->destroy_instance && NULL != data->clone_instance && NULL != data->equals_instance ) ? GATTrue : GATFalse; }