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.h Go to the documentation of this file. /** @file GATAdvertServiceCPI.h * Header file for the GATAdvertServiceCPI class. * * @date Fri Feb 13 2004 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATAdvertServiceCPI.h,v 1.6 2004/03/24 19:30: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) */ #if !defined(_GATADVERTSERVICECPI_H_) #define _GATADVERTSERVICECPI_H_ typedef struct GATAdvertServiceCPI_S *GATAdvertServiceCPI; #include "GATContext.h" #include "GATPreferences.h" #include "GATMonitorable.h" /* Versioning constants for the GATAdvertServiceCPI_Data struct */ #define GATADVERTSERVICECPI_VERSION1 1 /* the newest version we know of */ #define GATADVERTSERVICECPI_VERSION GATADVERTSERVICECPI_VERSION1 /** * The @c #GATAdvertServiceCPI_Instance structure holds all data items supplied * by the client during the construction of the corresponding GAT object. */ typedef struct { GATContext context; /* the GAT context to use for all GATFile operations */ GATString pwd; /* reference path for resolving relative paths */ GATMonitorable_Impl monitorable; /* monitoring support */ GATObject_const source; /* the object this CPI is associated with */ void *instance_data; /* eventually supplied CPI provider instance data */ } GATAdvertServiceCPI_Instance; /* prototypes for the adapter callback functions */ typedef void (*GATAdvertServiceCPI_Adaptor_Destroy)(void *); typedef GATResult (*GATAdvertServiceCPI_Adaptor_ServiceActions)(void *, GATAdvertServiceCPI_Instance *, GATTimePeriod_const); /* instance specific functions */ typedef void (*GATAdvertServiceCPI_Adaptor_DestroyInstance)(void *, GATAdvertServiceCPI_Instance *); typedef GATResult (*GATAdvertServiceCPI_Adaptor_CreateInstance)(void *, GATAdvertServiceCPI_Instance *); typedef GATResult (*GATAdvertServiceCPI_Adaptor_CloneInstance)(void *, GATAdvertServiceCPI_Instance const *, GATAdvertServiceCPI_Instance *); typedef GATResult (*GATAdvertServiceCPI_Adaptor_EqualsInstance)(void *, GATAdvertServiceCPI_Instance const *, GATAdvertServiceCPI_Instance const *, GATBool *); /* CPI specific API */ typedef GATResult (*GATAdvertServiceCPI_Adaptor_Add)(void *, GATAdvertServiceCPI_Instance *, GATObject_const, GATTable_const, GATString_const); typedef GATResult (*GATAdvertServiceCPI_Adaptor_Delete)(void *, GATAdvertServiceCPI_Instance *, GATString_const); typedef GATResult (*GATAdvertServiceCPI_Adaptor_GetMetaData)(void *, GATAdvertServiceCPI_Instance const *, GATString_const, GATTable *); typedef GATResult (*GATAdvertServiceCPI_Adaptor_GetAdvertisable)(void *, GATAdvertServiceCPI_Instance const *, GATString_const, GATObject *); typedef GATResult (*GATAdvertServiceCPI_Adaptor_Find)(void *, GATAdvertServiceCPI_Instance const *, GATTable_const, GATList_String *); /* callback function prototypes for the GATMonitorable interface support */ typedef GATResult (* GATAdvertServiceCPI_Adaptor_GetMetrics)(void *, GATAdvertServiceCPI_Instance const *, GATList_GATMetric *); typedef GATResult (* GATAdvertServiceCPI_Adaptor_GetMetricEvent)(void *, GATAdvertServiceCPI_Instance const *, GATMetric, GATMetricEvent *); /* CPI data passed from the adaptor while registering the CPI */ typedef struct { /* 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; } GATAdvertServiceCPI_Data; #ifdef __cplusplus extern "C" { #endif /* Adaptor API */ /** 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); /* API internal to the GAT engine */ /** GATAdvertServiceCPI_Destroy * @brief The GATAdvertServiceCPI destructor. * * This is the destructor for GATAdvertServiceCPI objects. * * @param this An old GATAdvertServiceCPI */ void GATAdvertServiceCPI_Destroy(GATAdvertServiceCPI *cpi); /* CPI instance specific functions */ /** 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); /** 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); /** 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); /** 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); /* CPI specific API */ /** 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); /** 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); /** 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); /** 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); /** 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); /* GATMonitorable */ /** 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); /** 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); #ifdef __cplusplus } /* extern "C" */ #endif #endif /* !defined(_GATADVERTSERVICECPI_H_) */