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

GATResourceCPI.h Go to the documentation of this file. /** @file GATResourceCPI.h * Header file for the GATResourceCPI class. * * @date Sat Oct 25 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATResourceCPI.h,v 1.11 2004/03/24 19:30:58 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(_GATRESOURCECPI_H_) #define _GATRESOURCECPI_H_ typedef struct GATResourceCPI_S *GATResourceCPI; #include "GATContext.h" #include "GATPreferences.h" #include "GATMonitorable.h" /* Versioning constants for the GATResourceCPI_Data struct */ #define GATRESOURCECPI_VERSION1 1 /* the newest version we know of */ #define GATRESOURCECPI_VERSION GATRESOURCECPI_VERSION1 /** * The @c #GATResourceCPI_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 */ GATType type; /* the actual type of this object */ GATBool isdirty; /* dirty status for the whole object */ GATMonitorable_Impl monitorable; /* monitoring support */ GATObject_const source; /* the object this CPI is associated with */ void *instance_data; /* eventually supplied CPI provider instance data */ } GATResourceCPI_Instance; /* prototypes for the adapter callback functions */ typedef void (*GATResourceCPI_Adaptor_Destroy)(void *); typedef GATResult (*GATResourceCPI_Adaptor_ServiceActions)(void *, GATResourceCPI_Instance *, GATTimePeriod_const); /* instance specific functions */ typedef void (*GATResourceCPI_Adaptor_DestroyInstance)(void *, GATResourceCPI_Instance *); typedef GATResult (*GATResourceCPI_Adaptor_CreateInstance)(void *, GATResourceCPI_Instance *, void *); typedef GATResult (*GATResourceCPI_Adaptor_CloneInstance)(void *, GATResourceCPI_Instance const *, GATResourceCPI_Instance *); typedef GATResult (*GATResourceCPI_Adaptor_EqualsInstance)(void *, GATResourceCPI_Instance const *, GATResourceCPI_Instance const *, GATBool *); /* CPI specific API */ typedef GATResult (* GATResourceCPI_Adaptor_GetResourceDescription)(void *, GATResourceCPI_Instance const *, GATResourceDescription_const *); typedef GATResult (* GATResourceCPI_Adaptor_GetReservation)(void *, GATResourceCPI_Instance const *, GATReservation_const *); /* callback function prototypes for the GATMonitorable interface support */ typedef GATResult (* GATResourceCPI_Adaptor_GetMetrics)(void *, GATResourceCPI_Instance const *, GATList_GATMetric *); typedef GATResult (* GATResourceCPI_Adaptor_GetMetricEvent)(void *, GATResourceCPI_Instance const *, GATMetric, GATMetricEvent *); /* Serialisation API */ typedef GATResult (*GATResourceCPI_Adaptor_Serialise)(void *, GATResourceCPI_Instance const *, GATObject, GATBool); typedef GATResult (*GATResourceCPI_Adaptor_DeSerialise)(void *, GATObject, GATResourceCPI_Instance *); /* CPI data passed from the adaptor while registering the CPI */ typedef struct { /* CPI data (adaptor instance data) */ void *data; GATResourceCPI_Adaptor_Destroy destroy; GATResourceCPI_Adaptor_ServiceActions service_actions; /* CPI instance data */ GATResourceCPI_Adaptor_CreateInstance create_instance; GATResourceCPI_Adaptor_DestroyInstance destroy_instance; GATResourceCPI_Adaptor_CloneInstance clone_instance; GATResourceCPI_Adaptor_EqualsInstance equals_instance; /* CPI functionality */ GATResourceCPI_Adaptor_GetResourceDescription get_resource_description; GATResourceCPI_Adaptor_GetReservation get_reservation; /* CPI monitoring support */ GATResourceCPI_Adaptor_GetMetrics get_metrics; GATResourceCPI_Adaptor_GetMetricEvent get_metric_event; /* CPI serialisation */ GATResourceCPI_Adaptor_Serialise serialise; GATResourceCPI_Adaptor_DeSerialise deserialise; } GATResourceCPI_Data; #ifdef __cplusplus extern "C" { #endif /* Adaptor API */ /** GATResourceCPI_Create * The GATResourceCPI constructor. * new_cpi is the constructor for GATResourceCPI objects. * * @param version Version of the GATResourceCPI_Data structure * @param data Pointer to adaptor CPI instance data structure. * * @return A new GATResourceCPI */ GATResourceCPI GATResourceCPI_Create(unsigned long int version, GATResourceCPI_Data *data); /* API internal to the GAT engine */ /** GATResourceCPI_Destroy * @brief The GATResourceCPI destructor. * * This is the destructor for GATResourceCPI objects. * * @param this An old GATResourceCPI */ void GATResourceCPI_Destroy(GATResourceCPI *cpi); /* CPI instance specific functions */ /** GATResourceCPI_CreateInstance * @brief Create a new CPI object instance * * Calls the adaptor to create a new CPI object instance. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * @param initialisation_data Additional data provided by the adaptor while * creating this new instance. * * @return An error code. */ GATResult GATResourceCPI_CreateInstance(GATResourceCPI cpi, GATResourceCPI_Instance *instance_data, void *initialisation_data); /** GATResourceCPI_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 GATResourceCPI_DestroyInstance(GATResourceCPI cpi, GATResourceCPI_Instance *instance_data); /** GATResourceCPI_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 GATResourceCPI_CloneInstance(GATResourceCPI cpi, GATResourceCPI_Instance const *instance_data, GATResourceCPI_Instance *new_instance_data); /** GATResourceCPI_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 GATResourceCPI_EqualsInstance(GATResourceCPI cpi, GATResourceCPI_Instance const *lhs, GATResourceCPI_Instance const *rhs, GATBool *isequal); /* CPI specific API */ /** GATResourceCPI_GetResourceDescription * @brief Returns the associated resource description. * * The function GATResourceCPI_GetResourceDescription calls the adaptor to * get the resource description associated with this GATResource. * * @param this The CPI object. * @param instance_data The instance data of the CPI object. * @param description The pointer to the variable, which receives the * resulting resource description. * * @return An error code. */ GATResult GATResourceCPI_GetResourceDescription(GATResourceCPI cpi, GATResourceCPI_Instance const *instance_data, GATResourceDescription_const *description); /** GATResourceCPI_GetReservation * @brief Returns the associated reservation. * * The function GATResourceCPI_GetReservation calls the adaptor to get the * reservation associated with this GATResource. * * @param this The CPI object. * @param instance_data The instance data of the CPI object. * @param reservation The pointer to a variable, which receives the resulting * reservation. * * @return An error code. */ GATResult GATResourceCPI_GetReservation(GATResourceCPI cpi, GATResourceCPI_Instance const *instance_data, GATReservation_const *reservation); /* GATMonitorable */ /** GATResourceCPI_GetMetrics * * The function GATResourceCPI_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 GATResourceCPI_GetMetrics(GATResourceCPI cpi, GATResourceCPI_Instance const *data, GATList_GATMetric *metrics); /** GATResourceCPI_GetMetricEvent * * The function GATResourceCPI_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 GATResourceCPI_GetMetricEvent(GATResourceCPI cpi, GATResourceCPI_Instance const *data, GATMetric metric, GATMetricEvent *event); /* Serialisation API */ /** GATResourceCPI_Serialise * @brief Serialise the instance data. * * Calls the adaptor to serialise the instance data. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * @param stream The stream to use be used for serialisation. * * @return An error code. */ GATResult GATResourceCPI_Serialise(GATResourceCPI cpi, GATResourceCPI_Instance const *data, GATObject stream, GATBool clear_dirty); /** GATResourceCPI_DeSerialise * @brief De-serialise the instance data * * Call the adaptor to de-serialise the instance data. * * @param context The GAT context to be used for object construction. * @param stream The stream interface to use for the serialisation. * @param instance_data The pointer to a variable, which contains the client * data of the new object. The member instance data of this object * may receive the pointer to the new instance data of the CPI object. * * @return An error code. */ GATResult GATResourceCPI_DeSerialise(GATResourceCPI cpi, GATObject stream, GATResourceCPI_Instance *data); #ifdef __cplusplus } /* extern "C" */ #endif #endif /* !defined(_GATRESOURCECPI_H_) */