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

GATRequestCPI.h File Reference Header file for the GATRequestCPI class. More... #include "GATContext.h" #include "GATPreferences.h" #include "GATRequest.h" Include dependency graph for GATRequestCPI.h: This graph shows which files directly or indirectly include this file: Go to the source code of this file. Compounds struct   GATRequestCPI_Instance_S   The #GATRequestCPI_Instance structure holds all data items supplied by the client during the construction of the corresponding GAT object. More... struct   GATRequestCPI_Data Defines #define  _GATREQUESTCPI_H_ #define  GATREQUESTCPI_VERSION1   1 #define  GATREQUESTCPI_VERSION   GATREQUESTCPI_VERSION1 Typedefs typedef GATRequestCPI_S *  GATRequestCPI typedef GATRequestCPI_Instance_S  GATRequestCPI_Instance   The #GATRequestCPI_Instance structure holds all data items supplied by the client during the construction of the corresponding GAT object. typedef void(*  GATRequestCPI_Adaptor_Destroy )(void *) typedef GATResult(*  GATRequestCPI_Adaptor_ServiceActions )(void *, GATRequestCPI_Instance *, GATTimePeriod_const) typedef void(*  GATRequestCPI_Adaptor_DestroyInstance )(void *, GATRequestCPI_Instance *) typedef GATResult(*  GATRequestCPI_Adaptor_CreateInstance )(void *, GATRequestCPI_Instance *, void *) typedef GATResult(*  GATRequestCPI_Adaptor_CloneInstance )(void *, GATRequestCPI_Instance const *, GATRequestCPI_Instance *) typedef GATResult(*  GATRequestCPI_Adaptor_EqualsInstance )(void *, GATRequestCPI_Instance const *, GATRequestCPI_Instance const *, GATBool *) typedef GATResult(*  GATRequestCPI_Adaptor_InitRequestNotifier )(void *, GATRequestCPI_Instance const *, GATRequestNotifier_const *) Functions GATRequestCPI  GATRequestCPI_Create (unsigned long int version, GATRequestCPI_Data *data)   GATRequestCPI_Create The GATRequestCPI constructor. void  GATRequestCPI_Destroy (GATRequestCPI *cpi)   GATRequestCPI_Destroy The GATRequestCPI destructor. GATResult  GATRequestCPI_CreateInstance (GATRequestCPI cpi, GATRequestCPI_Instance *instance_data, void *initialisation_data)   GATRequestCPI_CreateInstance Create a new CPI object instance. void  GATRequestCPI_DestroyInstance (GATRequestCPI cpi, GATRequestCPI_Instance *instance_data)   GATRequestCPI_DestroyInstance Create a new CPI object instance. GATResult  GATRequestCPI_EqualsInstance (GATRequestCPI cpi, GATRequestCPI_Instance const *lhs, GATRequestCPI_Instance const *rhs, GATBool *isequal)   GATRequestCPI_EqualsInstance Compares two CPI object instances. GATResult  GATRequestCPI_CloneInstance (GATRequestCPI cpi, GATRequestCPI_Instance const *instance_data, GATRequestCPI_Instance *new_instance_data)   GATRequestCPI_CloneInstance Clones a CPI object instance. GATResult  GATRequestCPI_InitRequestNotifier (GATRequestCPI cpi, GATRequestCPI_Instance const *instance_data, GATRequestNotifier_const *notifier)   GATRequestCPI_InitRequestNotifier. Detailed Description Header file for the GATRequestCPI class. A GATRequestCPI represents the adaptor supplied interface for an information or command request coming from another process. Date: Fri Jan 30 2004 Version: Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATRequestCPI.h,v 1.7 2004/04/01 17:21:28 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 GATRequestCPI.h. Define Documentation #define _GATREQUESTCPI_H_   Definition at line 21 of file GATRequestCPI.h. #define GATREQUESTCPI_VERSION1   1   Definition at line 30 of file GATRequestCPI.h. #define GATREQUESTCPI_VERSION   GATREQUESTCPI_VERSION1   Definition at line 33 of file GATRequestCPI.h. Referenced by GATRequestCPI_Create(), and resourcebroker_adaptor_Register_GATRequestCPI(). Typedef Documentation typedef struct GATRequestCPI_S* GATRequestCPI   Definition at line 23 of file GATRequestCPI.h. typedef struct GATRequestCPI_Instance_S GATRequestCPI_Instance   The #GATRequestCPI_Instance structure holds all data items supplied by the client during the construction of the corresponding GAT object. typedef void(* GATRequestCPI_Adaptor_Destroy)(void *)   Definition at line 56 of file GATRequestCPI.h. typedef GATResult(* GATRequestCPI_Adaptor_ServiceActions)(void *, GATRequestCPI_Instance *, GATTimePeriod_const)   Definition at line 58 of file GATRequestCPI.h. typedef void(* GATRequestCPI_Adaptor_DestroyInstance)(void *, GATRequestCPI_Instance *)   Definition at line 62 of file GATRequestCPI.h. typedef GATResult(* GATRequestCPI_Adaptor_CreateInstance)(void *, GATRequestCPI_Instance *, void *)   Definition at line 65 of file GATRequestCPI.h. typedef GATResult(* GATRequestCPI_Adaptor_CloneInstance)(void *, GATRequestCPI_Instance const *, GATRequestCPI_Instance *)   Definition at line 68 of file GATRequestCPI.h. typedef GATResult(* GATRequestCPI_Adaptor_EqualsInstance)(void *, GATRequestCPI_Instance const *, GATRequestCPI_Instance const *, GATBool *)   Definition at line 71 of file GATRequestCPI.h. typedef GATResult(* GATRequestCPI_Adaptor_InitRequestNotifier)(void *, GATRequestCPI_Instance const *, GATRequestNotifier_const *)   Definition at line 77 of file GATRequestCPI.h. Function Documentation GATRequestCPI GATRequestCPI_Create (  unsigned long int    version, GATRequestCPI_Data *    data )    GATRequestCPI_Create The GATRequestCPI constructor. new_cpi is the constructor for GATRequestCPI objects. Parameters: version  Version of the GATRequestCPI_Data structure data  Pointer to adaptor CPI instance data structure. Returns: A new GATRequestCPI Definition at line 66 of file GATRequestCPI.c. References GATRequestCPI_Data::clone_instance, GATRequestCPI_S::clone_instance, GATRequestCPI_Data::create_instance, GATRequestCPI_S::create_instance, GATRequestCPI_Data::data, GATRequestCPI_S::data, data, GATRequestCPI_Data::destroy, GATRequestCPI_S::destroy, GATRequestCPI_Data::destroy_instance, GATRequestCPI_S::destroy_instance, GATRequestCPI_Data::equals_instance, GATRequestCPI_S::equals_instance, GATRequestCPI_IsValidData_V1(), GATREQUESTCPI_VERSION, GATTrue, GATRequestCPI_Data::init_notifier, GATRequestCPI_S::init_notifier, GATRequestCPI_Data::service_actions, and GATRequestCPI_S::service_actions. Referenced by resourcebroker_adaptor_Register_GATRequestCPI(). void GATRequestCPI_Destroy (  GATRequestCPI *    object )    GATRequestCPI_Destroy The GATRequestCPI destructor. This is the destructor for GATRequestCPI objects. Parameters: this  An old GATRequestCPI Definition at line 121 of file GATRequestCPI.c. Referenced by resourcebroker_adaptor_Register_GATRequestCPI(). GATResult GATRequestCPI_CreateInstance (  GATRequestCPI    cpi, GATRequestCPI_Instance *    instance_data, void *    initialisation_data )    GATRequestCPI_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 144 of file GATRequestCPI.c. References cpi, GATRequestCPI_S::create_instance, and GATRequestCPI_S::data. Referenced by GATRequest_Create(). void GATRequestCPI_DestroyInstance (  GATRequestCPI    cpi, GATRequestCPI_Instance *    instance_data )    GATRequestCPI_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 159 of file GATRequestCPI.c. References cpi, GATRequestCPI_S::data, and GATRequestCPI_S::destroy_instance. Referenced by GATRequest_Destroy(). GATResult GATRequestCPI_EqualsInstance (  GATRequestCPI    cpi, GATRequestCPI_Instance const *    lhs, GATRequestCPI_Instance const *    rhs, GATBool *    isequal )    GATRequestCPI_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 179 of file GATRequestCPI.c. References cpi, GATRequestCPI_S::data, GATRequestCPI_S::equals_instance, and GATBool. Referenced by GATRequest_Equals(). GATResult GATRequestCPI_CloneInstance (  GATRequestCPI    cpi, GATRequestCPI_Instance const *    instance_data, GATRequestCPI_Instance *    new_instance_data )    GATRequestCPI_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. new_instance_data  The new instance data is to be returned here. Returns: An error code. Definition at line 198 of file GATRequestCPI.c. References GATRequestCPI_S::clone_instance, cpi, and GATRequestCPI_S::data. Referenced by GATRequest_Clone(). GATResult GATRequestCPI_InitRequestNotifier (  GATRequestCPI    cpi, GATRequestCPI_Instance const *    instance_data, GATRequestNotifier_const *    notifier )    GATRequestCPI_InitRequestNotifier. Calls the adaptor to return the associated request notifier. Parameters: this  The CPI object. instance_data  The instance data of the CPI object to ask for the request notifier. notifier  The pointer to a variable, which should receive the returned request notifier. Returns: An error code. Definition at line 218 of file GATRequestCPI.c. References cpi, GATRequestCPI_S::data, GATRequestNotifier_const, and GATRequestCPI_S::init_notifier. Referenced by GATRequest_GetRequestNotifier().