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.h File Reference Header file for the GATReservationCPI class. More... #include "GATContext.h" #include "GATPreferences.h" #include "GATReservation.h" Include dependency graph for GATReservationCPI.h: This graph shows which files directly or indirectly include this file: Go to the source code of this file. Compounds struct   GATReservationCPI_Instance   The #GATReservationCPI_Instance structure holds all data items supplied by the client during the construction of the corresponding GAT object. More... struct   GATReservationCPI_Data Defines #define  _GATRESERVATIONCPI_H_ #define  GATRESERVATIONCPI_VERSION1   1 #define  GATRESERVATIONCPI_VERSION   GATRESERVATIONCPI_VERSION1 Typedefs typedef GATReservationCPI_S *  GATReservationCPI typedef void(*  GATReservationCPI_Adaptor_Destroy )(void *) typedef GATResult(*  GATReservationCPI_Adaptor_ServiceActions )(void *, GATReservationCPI_Instance *, GATTimePeriod_const) typedef void(*  GATReservationCPI_Adaptor_DestroyInstance )(void *, GATReservationCPI_Instance *) typedef GATResult(*  GATReservationCPI_Adaptor_CreateInstance )(void *, GATReservationCPI_Instance *) typedef GATResult(*  GATReservationCPI_Adaptor_CloneInstance )(void *, GATReservationCPI_Instance const *, GATReservationCPI_Instance *) typedef GATResult(*  GATReservationCPI_Adaptor_EqualsInstance )(void *, GATReservationCPI_Instance const *, GATReservationCPI_Instance const *, GATBool *) typedef GATResult(*  GATReservationCPI_Adaptor_Cancel )(void *, GATReservationCPI_Instance *) typedef GATResult(*  GATReservationCPI_Adaptor_GetResource )(void *, GATReservationCPI_Instance const *, GATResource_const *) Functions GATReservationCPI  GATReservationCPI_Create (unsigned long int version, GATReservationCPI_Data *data)   GATReservationCPI_Create The GATReservationCPI constructor. void  GATReservationCPI_Destroy (GATReservationCPI *cpi)   GATReservationCPI_Destroy The GATReservationCPI destructor. GATResult  GATReservationCPI_CreateInstance (GATReservationCPI cpi, GATReservationCPI_Instance *instance_data)   GATReservationCPI_CreateInstance Create a new CPI object instance. void  GATReservationCPI_DestroyInstance (GATReservationCPI cpi, GATReservationCPI_Instance *instance_data)   GATReservationCPI_DestroyInstance Create a new CPI object instance. GATResult  GATReservationCPI_CloneInstance (GATReservationCPI cpi, GATReservationCPI_Instance const *instance_data, GATReservationCPI_Instance *new_instance_data)   GATReservationCPI_CloneInstance Clones a CPI object instance. GATResult  GATReservationCPI_EqualsInstance (GATReservationCPI cpi, GATReservationCPI_Instance const *lhs, GATReservationCPI_Instance const *rhs, GATBool *isequal)   GATReservationCPI_EqualsInstance Compares two CPI object instances. GATResult  GATReservationCPI_Cancel (GATReservationCPI reservation, GATReservationCPI_Instance *instance_data)   GATReservationCPI_Cancel Cancel this reservation. GATResult  GATReservationCPI_GetResource (GATReservationCPI reservation, GATReservationCPI_Instance const *instance_data, GATResource_const *resource)   GATReservationCPI_GetResource Get the associated resource of this reservation. Detailed Description Header file for the GATReservationCPI class. Date: Thu Oct 23 2003 Version: Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATReservationCPI.h,v 1.7 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) Definition in file GATReservationCPI.h. Define Documentation #define _GATRESERVATIONCPI_H_   Definition at line 18 of file GATReservationCPI.h. #define GATRESERVATIONCPI_VERSION1   1   Definition at line 27 of file GATReservationCPI.h. #define GATRESERVATIONCPI_VERSION   GATRESERVATIONCPI_VERSION1   Definition at line 30 of file GATReservationCPI.h. Referenced by GATReservationCPI_Create(), and resourcebroker_adaptor_Register_GATReservationCPI(). Typedef Documentation typedef struct GATReservationCPI_S* GATReservationCPI   Definition at line 20 of file GATReservationCPI.h. typedef void(* GATReservationCPI_Adaptor_Destroy)(void *)   Definition at line 48 of file GATReservationCPI.h. typedef GATResult(* GATReservationCPI_Adaptor_ServiceActions)(void *, GATReservationCPI_Instance *, GATTimePeriod_const)   Definition at line 50 of file GATReservationCPI.h. typedef void(* GATReservationCPI_Adaptor_DestroyInstance)(void *, GATReservationCPI_Instance *)   Definition at line 54 of file GATReservationCPI.h. typedef GATResult(* GATReservationCPI_Adaptor_CreateInstance)(void *, GATReservationCPI_Instance *)   Definition at line 57 of file GATReservationCPI.h. typedef GATResult(* GATReservationCPI_Adaptor_CloneInstance)(void *, GATReservationCPI_Instance const *, GATReservationCPI_Instance *)   Definition at line 60 of file GATReservationCPI.h. typedef GATResult(* GATReservationCPI_Adaptor_EqualsInstance)(void *, GATReservationCPI_Instance const *, GATReservationCPI_Instance const *, GATBool *)   Definition at line 63 of file GATReservationCPI.h. typedef GATResult(* GATReservationCPI_Adaptor_Cancel)(void *, GATReservationCPI_Instance *)   Definition at line 68 of file GATReservationCPI.h. typedef GATResult(* GATReservationCPI_Adaptor_GetResource)(void *, GATReservationCPI_Instance const *, GATResource_const *)   Definition at line 71 of file GATReservationCPI.h. Function Documentation GATReservationCPI GATReservationCPI_Create (  unsigned long int    version, GATReservationCPI_Data *    data )    GATReservationCPI_Create The GATReservationCPI constructor. new_cpi is the constructor for GATReservationCPI objects. Parameters: version  Version of the GATReservationCPI_Data structure data  Pointer to adaptor CPI instance data structure. Returns: A new GATReservationCPI Definition at line 64 of file GATReservationCPI.c. References GATReservationCPI_Data::cancel, GATReservationCPI_S::cancel, GATReservationCPI_Data::clone_instance, GATReservationCPI_S::clone_instance, GATReservationCPI_Data::create_instance, GATReservationCPI_S::create_instance, GATReservationCPI_Data::data, GATReservationCPI_S::data, data, GATReservationCPI_Data::destroy, GATReservationCPI_S::destroy, GATReservationCPI_Data::destroy_instance, GATReservationCPI_S::destroy_instance, GATReservationCPI_Data::equals_instance, GATReservationCPI_S::equals_instance, GATReservationCPI_IsValidData_V1(), GATRESERVATIONCPI_VERSION, GATTrue, GATReservationCPI_Data::get_resource, GATReservationCPI_S::get_resource, GATReservationCPI_Data::service_actions, and GATReservationCPI_S::service_actions. Referenced by resourcebroker_adaptor_Register_GATReservationCPI(). void GATReservationCPI_Destroy (  GATReservationCPI *    object )    GATReservationCPI_Destroy The GATReservationCPI destructor. This is the destructor for GATReservationCPI objects. Parameters: this  An old GATReservationCPI Definition at line 120 of file GATReservationCPI.c. Referenced by resourcebroker_adaptor_Register_GATReservationCPI(). GATResult GATReservationCPI_CreateInstance (  GATReservationCPI    cpi, GATReservationCPI_Instance *    instance_data )    GATReservationCPI_CreateInstance Create a new CPI object instance. Calls the adaptor to create a new CPI object instance. Parameters: this  The CPI object. context  a GATContext instance_data  The instance data of the attached CPI object Returns: An error code. Definition at line 143 of file GATReservationCPI.c. References cpi, GATReservationCPI_S::create_instance, and GATReservationCPI_S::data. Referenced by GATReservation_Create(). void GATReservationCPI_DestroyInstance (  GATReservationCPI    cpi, GATReservationCPI_Instance *    instance_data )    GATReservationCPI_DestroyInstance Create a new CPI object instance. Calls the adaptor to destroy a CPI object instance. Parameters: this  The CPI object. instance_data  The instance data of the attached CPI object Definition at line 158 of file GATReservationCPI.c. References cpi, GATReservationCPI_S::data, and GATReservationCPI_S::destroy_instance. Referenced by GATReservation_Destroy(). GATResult GATReservationCPI_CloneInstance (  GATReservationCPI    cpi, GATReservationCPI_Instance const *    instance_data, GATReservationCPI_Instance *    new_instance_data )    GATReservationCPI_CloneInstance Clones a CPI object instance. Calls the adaptor to clone a CPI object instance. Parameters: this  The CPI object. instance_data  The instance data of the CPI object to clone. rhs  The new instance data is to be returned here. Returns: An error code. Definition at line 197 of file GATReservationCPI.c. References GATReservationCPI_S::clone_instance, cpi, and GATReservationCPI_S::data. Referenced by GATReservation_Clone(). GATResult GATReservationCPI_EqualsInstance (  GATReservationCPI    cpi, GATReservationCPI_Instance const *    lhs, GATReservationCPI_Instance const *    rhs, GATBool *    isequal )    GATReservationCPI_EqualsInstance Compares two CPI object instances. Calls the adaptor to compare two CPI object instances. Parameters: this  The CPI object. lhs  The instance data of the left CPI object rhs  The instance data of the right CPI object isequal  The pointer to the variable, where the result is to be returned to. Returns: An error code. Definition at line 178 of file GATReservationCPI.c. References cpi, GATReservationCPI_S::data, GATReservationCPI_S::equals_instance, and GATBool. Referenced by GATReservation_Equals(). GATResult GATReservationCPI_Cancel (  GATReservationCPI    reservation, GATReservationCPI_Instance *    instance_data )    GATReservationCPI_Cancel Cancel this reservation. Call the adaptor to cancel a reservation. Parameters: reservation  The reservation to cancel. instance_data  The instance data of the CPI object to clone. unique_name  The unique name of this reservation. Returns: An error code. Definition at line 216 of file GATReservationCPI.c. References GATReservationCPI_S::cancel, and GATReservationCPI_S::data. Referenced by GATReservation_Cancel(). GATResult GATReservationCPI_GetResource (  GATReservationCPI    reservation, GATReservationCPI_Instance const *    instance_data, GATResource_const *    resource )    GATReservationCPI_GetResource Get the associated resource of this reservation. Call the adaptor to get the associated resource. Parameters: reservation  The reservation to cancel. instance_data  The instance data of the CPI object to clone. unique_name  The unique name of this reservation. resource  The pointer to the variable, where the resulting resource should be returned. Returns: An error code. Definition at line 236 of file GATReservationCPI.c. References GATReservationCPI_S::data, GATResource_const, and GATReservationCPI_S::get_resource. Referenced by GATReservation_GetResource().