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

GATResourceBrokerCPI.h Go to the documentation of this file. /** @file GATResourceBrokerCPI.h * Header file for the GATResourceBrokerCPI class. * * A GATResourcebrokerCPI encapsulates all the methods that a * GATResourceBroker capability provider provides. * * @date Thu Oct 23 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATResourceBrokerCPI.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(_GATRESOURCEBROKERCPI_H_) #define _GATRESOURCEBROKERCPI_H_ typedef struct GATResourceBrokerCPI_S *GATResourceBrokerCPI; #include "GATContext.h" #include "GATPreferences.h" #include "GATResource.h" #include "GATResourceDescription.h" #include "GATReservation.h" #include "GATTime.h" #include "GATTimePeriod.h" #include "GATJob.h" #include "GATJobDescription.h" #include "GATResourceBroker.h" /* Versioning constants for the GATResourceBrokerCPI_Data struct */ #define GATRESOURCEBROKERCPI_VERSION1 1 /* the newest version we know of */ #define GATRESOURCEBROKERCPI_VERSION GATRESOURCEBROKERCPI_VERSION1 /** * The @c #GATResourceBrokerCPI_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 vo_name; /* of the virtual organisation to use */ void *instance_data; /* eventually supplied CPI provider instance data */ } GATResourceBrokerCPI_Instance; /* prototypes for the adapter callback functions */ typedef void (*GATResourceBrokerCPI_Adaptor_Destroy)(void *); typedef GATResult (*GATResourceBrokerCPI_Adaptor_ServiceActions)(void *, GATResourceBrokerCPI_Instance *, GATTimePeriod_const); /* instance specific functions */ typedef void (*GATResourceBrokerCPI_Adaptor_DestroyInstance)(void *, GATResourceBrokerCPI_Instance *); typedef GATResult (*GATResourceBrokerCPI_Adaptor_CreateInstance)(void *, GATResourceBrokerCPI_Instance *); typedef GATResult (*GATResourceBrokerCPI_Adaptor_CloneInstance)(void *, GATResourceBrokerCPI_Instance const *, GATResourceBrokerCPI_Instance *); typedef GATResult (*GATResourceBrokerCPI_Adaptor_EqualsInstance)(void *, GATResourceBrokerCPI_Instance const *, GATResourceBrokerCPI_Instance const *, GATBool *); /* CPI specific API */ typedef GATResult (*GATResourceBrokerCPI_Adaptor_ReserveResource_Description)( void *, GATResourceBrokerCPI_Instance const *, GATResourceDescription_const, GATTime_const, GATTimePeriod_const, GATReservation *); typedef GATResult (*GATResourceBrokerCPI_Adaptor_ReserveResource)( void *, GATResourceBrokerCPI_Instance const *, GATResource_const, GATTime_const, GATTimePeriod_const, GATReservation *); typedef GATResult (*GATResourceBrokerCPI_Adaptor_FindResources)( void *, GATResourceBrokerCPI_Instance const *, GATResourceDescription_const, GATList_GATResource *); typedef GATResult (*GATResourceBrokerCPI_Adaptor_SubmitJob)( void *, GATResourceBrokerCPI_Instance const *, GATJobDescription_const, GATJob *); /* CPI data passed from the adaptor while registering the CPI */ typedef struct { /* CPI data (type local data) */ void *data; GATResourceBrokerCPI_Adaptor_Destroy destroy; GATResourceBrokerCPI_Adaptor_ServiceActions service_actions; /* CPI instance data */ GATResourceBrokerCPI_Adaptor_CreateInstance create_instance; GATResourceBrokerCPI_Adaptor_DestroyInstance destroy_instance; GATResourceBrokerCPI_Adaptor_CloneInstance clone_instance; GATResourceBrokerCPI_Adaptor_EqualsInstance equals_instance; /* CPI functionality */ GATResourceBrokerCPI_Adaptor_ReserveResource_Description reserve_description; GATResourceBrokerCPI_Adaptor_ReserveResource reserve; GATResourceBrokerCPI_Adaptor_FindResources find_resources; GATResourceBrokerCPI_Adaptor_SubmitJob submit_job; } GATResourceBrokerCPI_Data; #ifdef __cplusplus extern "C" { #endif /* Adaptor API */ /** GATResourceBrokerCPI_Create * The GATResourceBrokerCPI constructor. * new_cpi is the constructor for GATResourceBrokerCPI objects. * * @param version Version of the GATResourceBrokerCPI_Data structure * @param data Pointer to adaptor CPI instance data structure. * * @return A new GATResourceBrokerCPI */ GATResourceBrokerCPI GATResourceBrokerCPI_Create(unsigned long int version, GATResourceBrokerCPI_Data *data); /* API internal to the GAT engine */ /** GATResourceBrokerCPI_Destroy * @brief The GATResourceBrokerCPI destructor. * * This is the destructor for GATResourceBrokerCPI objects. * * @param this An old GATResourceBrokerCPI */ void GATResourceBrokerCPI_Destroy(GATResourceBrokerCPI *cpi); /* CPI instance specific functions */ /** GATResourceBrokerCPI_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 GATResourceBrokerCPI_CreateInstance(GATResourceBrokerCPI cpi, GATResourceBrokerCPI_Instance *instance_data); /** GATResourceBrokerCPI_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 GATResourceBrokerCPI_DestroyInstance(GATResourceBrokerCPI cpi, GATResourceBrokerCPI_Instance *instance_data); /** GATResourceBrokerCPI_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 GATResourceBrokerCPI_CloneInstance(GATResourceBrokerCPI cpi, GATResourceBrokerCPI_Instance const *instance_data, GATResourceBrokerCPI_Instance *new_instance_data); /** GATResourceBrokerCPI_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 GATResourceBrokerCPI_EqualsInstance(GATResourceBrokerCPI cpi, GATResourceBrokerCPI_Instance const *lhs, GATResourceBrokerCPI_Instance const *rhs, GATBool *isequal); /* CPI specific API */ /** GATResourceBrokerCPI_ReserveResource_Description * @brief Reserve a resource, which mets the description. * * Call the adaptor to allocate a reservation * * @param broker The ResourceBroker CPI object. * @param instance_data The instance data of the CPI object to clone. * @param description The ResourceDescription to use to select the appropriate * resource. * @param time The (optional) time, when the reservation has to start * @param duration The (optional) time period for which to reserve the * resource. * @param reservation The pointer to the GATReservation variable to use to * return the resulting reservation. * * @return An error value. */ GATResult GATResourceBrokerCPI_ReserveResource_Description(GATResourceBrokerCPI broker, GATResourceBrokerCPI_Instance const *instance_data, GATResourceDescription_const description, GATTime_const zeit, GATTimePeriod_const duration, GATReservation *reservation); /** GATResourceBrokerCPI_ReserveResource * @brief Reserve a given resource. * * Call the adaptor to allocate a reservation * * @param broker The ResourceBroker CPI object. * @param instance_data The instance data of the CPI object to clone. * @param resource The resource to reserve. * @param time The (optional) time, when the reservation has to start * @param duration The (optional) time period for which to reserve the * resource. * @param reservation The pointer to the GATReservation variable to use to * return the resulting reservation. * * @return An error value. */ GATResult GATResourceBrokerCPI_ReserveResource(GATResourceBrokerCPI broker, GATResourceBrokerCPI_Instance const *instance_data, GATResource_const resource, GATTime_const zeit, GATTimePeriod_const duration, GATReservation *reservation); /** GATResourceBrokerCPI_FindResources * @brief Find a list of matching resources. * * Call the adaptor to find a list of resources matching the given resource * description. * * @param broker The ResourceBroker CPI object. * @param instance_data The instance data of the CPI object to clone. * @param description The resource description to match. * @param resources The pointer to the GATList_GATResource variable to use to * return the resulting list of resources. * * @return An error value. */ GATResult GATResourceBrokerCPI_FindResources(GATResourceBrokerCPI broker, GATResourceBrokerCPI_Instance const *instance_data, GATResourceDescription_const description, GATList_GATResource *resources); /** GATResourceBrokerCPI_SubmitJob * @brief Submit a new job. * * Call the adaptor to submit a new job to a resource. * * @param broker The ResourceBroker CPI object. * @param instance_data The instance data of the CPI object to clone. * @param description The resource description to match. * @param resources The pointer to the GATJob variable to use to * return the resulting job. * * @return An error value. */ GATResult GATResourceBrokerCPI_SubmitJob(GATResourceBrokerCPI broker, GATResourceBrokerCPI_Instance const *instance_data, GATJobDescription_const description, GATJob *job); #ifdef __cplusplus } /* extern "C" */ #endif #endif /* !defined(_GATRESOURCEBROKERCPI_H_) */