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

GATReservationCPI.c Go to the documentation of this file. /** @file GATReservationCPI.c * Source file for the GATReservationCPI class. * * @date Thu Oct 23 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATReservationCPI.c,v 1.5 2004/04/02 12:31: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) */ static const char *rcsid = "$Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATReservationCPI.c,v 1.5 2004/04/02 12:31:58 hartmutkaiser Exp $"; /* System Header Files */ #include <stdio.h> #include <stdlib.h> /* GAT Header Files */ #include "GATErrors.h" #include "GATReservationCPI.h" /* Macros */ /* Structures, unions and enums */ struct GATReservationCPI_S { /* CPI data (type local data) */ void *data; GATReservationCPI_Adaptor_Destroy destroy; GATReservationCPI_Adaptor_ServiceActions service_actions; /* CPI instance data */ GATReservationCPI_Adaptor_CreateInstance create_instance; GATReservationCPI_Adaptor_DestroyInstance destroy_instance; GATReservationCPI_Adaptor_CloneInstance clone_instance; GATReservationCPI_Adaptor_EqualsInstance equals_instance; /* CPI functionality */ GATReservationCPI_Adaptor_Cancel cancel; GATReservationCPI_Adaptor_GetResource get_resource; }; /* Static function prototypes */ static GATBool GATReservationCPI_IsValidData_V1(GATReservationCPI_Data *data); /* File scope variables */ /* External functions */ /** GATReservationCPI_Create * The GATReservationCPI constructor. * new_cpi is the constructor for GATReservationCPI objects. * * @param version Version of the GATReservationCPI_Data structure * @param data Pointer to adaptor CPI instance data structure. * * @return A new GATReservationCPI */ GATReservationCPI GATReservationCPI_Create(unsigned long int version, GATReservationCPI_Data *data) { GATReservationCPI new_cpi = NULL; if (version <= GATRESERVATIONCPI_VERSION) { if (version == GATRESERVATIONCPI_VERSION && GATTrue == GATReservationCPI_IsValidData_V1(data)) { new_cpi = (GATReservationCPI)malloc(sizeof(struct GATReservationCPI_S)); 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->cancel = data->cancel; new_cpi->get_resource = data->get_resource; } } /* add functionality for newer versions here else if (version == GATRESERVATIONCPI_VERSION2 && GATReservationCPI_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; } /** GATReservationCPI_Destroy * @brief The GATReservationCPI destructor. * * This is the destructor for GATReservationCPI objects. * * @param this An old GATReservationCPI */ void GATReservationCPI_Destroy(GATReservationCPI *object) { if(NULL != object && NULL != *object) { /* call the adapter supplied destroy function */ (*object)->destroy((*object)->data); free(*object); *object = NULL; } } /** GATReservationCPI_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 GATReservationCPI_CreateInstance(GATReservationCPI cpi, GATReservationCPI_Instance *instance_data) { return cpi->create_instance(cpi->data, instance_data); } /** GATReservationCPI_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 GATReservationCPI_DestroyInstance(GATReservationCPI cpi, GATReservationCPI_Instance *instance_data) { cpi->destroy_instance(cpi->data, instance_data); } /** GATReservationCPI_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 GATReservationCPI_EqualsInstance(GATReservationCPI cpi, GATReservationCPI_Instance const *lhs, GATReservationCPI_Instance const *rhs, GATBool *isequal) { return cpi->equals_instance(cpi->data, lhs, rhs, isequal); } /** GATReservationCPI_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 rhs The new instance data is to be returned here. * * @return An error code. */ GATResult GATReservationCPI_CloneInstance(GATReservationCPI cpi, GATReservationCPI_Instance const *instance_data, GATReservationCPI_Instance *new_instance_data) { return cpi->clone_instance(cpi->data, instance_data, new_instance_data); } /** GATReservationCPI_Cancel * @brief Cancel this reservation * * Call the adaptor to cancel a reservation. * * @param reservation The reservation to cancel. * @param instance_data The instance data of the CPI object to clone. * @param unique_name The unique name of this reservation. * * @return An error code. */ GATResult GATReservationCPI_Cancel(GATReservationCPI reservation, GATReservationCPI_Instance *instance_data) { return reservation->cancel(reservation->data, instance_data); } /** GATReservationCPI_GetResource * @brief Get the associated resource of this reservation. * * Call the adaptor to get the associated resource. * * @param reservation The reservation to cancel. * @param instance_data The instance data of the CPI object to clone. * @param unique_name The unique name of this reservation. * @param resource The pointer to the variable, where the resulting resource * should be returned. * * @return An error code. */ GATResult GATReservationCPI_GetResource(GATReservationCPI reservation, GATReservationCPI_Instance const *instance_data, GATResource_const *resource) { return reservation->get_resource(reservation->data, instance_data, resource); } /* Local functions */ static GATBool GATReservationCPI_IsValidData_V1(GATReservationCPI_Data *data) { return ( NULL != data->destroy && // NULL != data->service_actions && NULL != data->create_instance && NULL != data->destroy_instance && NULL != data->clone_instance && NULL != data->equals_instance && NULL != data->cancel && NULL != data->get_resource ) ? GATTrue : GATFalse; }