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

GATSelfCPI.h File Reference Header file for the GATSelfCPI class. More... #include "GATContext.h" #include "GATPreferences.h" Include dependency graph for GATSelfCPI.h: This graph shows which files directly or indirectly include this file: Go to the source code of this file. Compounds struct   GATSelfCPI_Instance   The #GATSelfCPI_Instance structure holds all data items supplied by the client during the construction of the corresponding GAT object. More... struct   GATSelfCPI_Data Defines #define  _GATSELFCPI_H_ #define  GATSELFCPI_VERSION1   1 #define  GATSELFCPI_VERSION   GATSELFCPI_VERSION1 Typedefs typedef void(*  GATSelfCPI_Adaptor_Destroy )(void *) typedef GATResult(*  GATSelfCPI_Adaptor_ServiceActions )(void *, GATSelfCPI_Instance *, GATTimePeriod_const) typedef GATResult(*  GATSelfCPI_Adaptor_CreateInstance )(void *, GATSelfCPI_Instance *) typedef void(*  GATSelfCPI_Adaptor_DestroyInstance )(void *, GATSelfCPI_Instance *) typedef GATResult(*  GATSelfCPI_Adaptor_GetJob )(void *, GATSelfCPI_Instance *, GATContext, GATJob *) typedef GATResult(*  GATSelfCPI_Adaptor_CreateRequestForListener )(void *, GATSelfCPI_Instance *, GATContext, GATRequestListener, void *, GATRequestType, GATTable_const, const char *, GATRequest *) typedef GATResult(*  GATSelfCPI_Adaptor_DestroyRequestForListener )(void *, GATSelfCPI_Instance *, GATContext, GATRequest *) Functions GATSelfCPI  GATSelfCPI_Create (unsigned long int version, GATSelfCPI_Data *data)   GATSelfCPI_Create The GATSelfCPI constructor. void  GATSelfCPI_Destroy (GATSelfCPI *cpi)   GATSelfCPI_Destroy The GATSelfCPI destructor. GATResult  GATSelfCPI_CreateInstance (GATSelfCPI cpi, GATSelfCPI_Instance *instance_data)   GATSelfCPI_CreateInstance Create a new CPI object instance. void  GATSelfCPI_DestroyInstance (GATSelfCPI cpi, GATSelfCPI_Instance *instance_data)   GATSelfCPI_DestroyInstance Create a new CPI object instance. GATResult  GATSelfCPI_GetJob (GATSelfCPI cpi, GATSelfCPI_Instance *instance_data, GATContext context, GATJob *job)   GATSelfCPI_GetJob. GATResult  GATSelfCPI_CreateRequestForListener (GATSelfCPI cpi, GATSelfCPI_Instance *instance_data, GATContext context, GATRequestListener listener, void *data, GATRequestType type, GATTable_const parameters, const char *name, GATRequest *request)   GATSelfCPI_CreateRequestForListener. GATResult  GATSelfCPI_DestroyRequestForListener (GATSelfCPI cpi, GATSelfCPI_Instance *instance_data, GATContext context, GATRequest *request)   GATSelfCPI_DestroyRequestForListener. Detailed Description Header file for the GATSelfCPI class. Date: Fri Jan 23 2004 Version: Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATSelfCPI.h,v 1.8 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 GATSelfCPI.h. Define Documentation #define _GATSELFCPI_H_   Definition at line 18 of file GATSelfCPI.h. #define GATSELFCPI_VERSION1   1   Definition at line 24 of file GATSelfCPI.h. #define GATSELFCPI_VERSION   GATSELFCPI_VERSION1   Definition at line 27 of file GATSelfCPI.h. Referenced by GATSelfCPI_Create(), and resourcebroker_adaptor_Register_GATSelfCPI(). Typedef Documentation typedef void(* GATSelfCPI_Adaptor_Destroy)(void *)   Definition at line 40 of file GATSelfCPI.h. typedef GATResult(* GATSelfCPI_Adaptor_ServiceActions)(void *, GATSelfCPI_Instance *, GATTimePeriod_const)   Definition at line 43 of file GATSelfCPI.h. typedef GATResult(* GATSelfCPI_Adaptor_CreateInstance)(void *, GATSelfCPI_Instance *)   Definition at line 46 of file GATSelfCPI.h. typedef void(* GATSelfCPI_Adaptor_DestroyInstance)(void *, GATSelfCPI_Instance *)   Definition at line 49 of file GATSelfCPI.h. typedef GATResult(* GATSelfCPI_Adaptor_GetJob)(void *, GATSelfCPI_Instance *, GATContext, GATJob *)   Definition at line 53 of file GATSelfCPI.h. typedef GATResult(* GATSelfCPI_Adaptor_CreateRequestForListener)(void *, GATSelfCPI_Instance *, GATContext, GATRequestListener, void *, GATRequestType, GATTable_const, const char *, GATRequest *)   Definition at line 56 of file GATSelfCPI.h. typedef GATResult(* GATSelfCPI_Adaptor_DestroyRequestForListener)(void *, GATSelfCPI_Instance *, GATContext, GATRequest *)   Definition at line 60 of file GATSelfCPI.h. Function Documentation GATSelfCPI GATSelfCPI_Create (  unsigned long int    version, GATSelfCPI_Data *    data )    GATSelfCPI_Create The GATSelfCPI constructor. new_cpi is the constructor for GATSelfCPI objects. Parameters: version  Version of the GATSelfCPI_Data structure data  Pointer to adaptor CPI instance data structure. Returns: A new GATSelfCPI Definition at line 64 of file GATSelfCPI.c. References GATSelfCPI_Data::create_instance, GATSelfCPI_S::create_instance, GATSelfCPI_Data::create_requestforlistener, GATSelfCPI_S::create_requestforlistener, GATSelfCPI_Data::data, GATSelfCPI_S::data, data, GATSelfCPI_Data::destroy, GATSelfCPI_S::destroy, GATSelfCPI_Data::destroy_instance, GATSelfCPI_S::destroy_instance, GATSelfCPI_Data::destroy_requestforlistener, GATSelfCPI_S::destroy_requestforlistener, GATSelfCPI_IsValidData_V1(), GATSELFCPI_VERSION, GATTrue, GATSelfCPI_Data::get_selfjob, GATSelfCPI_S::get_selfjob, GATSelfCPI_Data::service_actions, and GATSelfCPI_S::service_actions. Referenced by resourcebroker_adaptor_Register_GATSelfCPI(). void GATSelfCPI_Destroy (  GATSelfCPI *    object )    GATSelfCPI_Destroy The GATSelfCPI destructor. This is the destructor for GATSelfCPI objects. Parameters: this  An old GATSelfCPI Definition at line 119 of file GATSelfCPI.c. Referenced by resourcebroker_adaptor_Register_GATSelfCPI(). GATResult GATSelfCPI_CreateInstance (  GATSelfCPI    cpi, GATSelfCPI_Instance *    instance_data )    GATSelfCPI_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 GATSelfCPI.c. References cpi, GATSelfCPI_S::create_instance, and GATSelfCPI_S::data. Referenced by GATSelf_Create(). void GATSelfCPI_DestroyInstance (  GATSelfCPI    cpi, GATSelfCPI_Instance *    instance_data )    GATSelfCPI_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 GATSelfCPI.c. References cpi, GATSelfCPI_S::data, and GATSelfCPI_S::destroy_instance. GATResult GATSelfCPI_GetJob (  GATSelfCPI    cpi, GATSelfCPI_Instance *    instance_data, GATContext    context, GATJob *    job )    GATSelfCPI_GetJob. Parameters: this  The CPI object. instance_data  The instance data of the attached CPI object Returns: An error code. Definition at line 175 of file GATSelfCPI.c. References cpi, GATSelfCPI_S::data, GATJob, and GATSelfCPI_S::get_selfjob. Referenced by GATSelf_GetJob(). GATResult GATSelfCPI_CreateRequestForListener (  GATSelfCPI    cpi, GATSelfCPI_Instance *    instance_data, GATContext    context, GATRequestListener    listener, void *    data, GATRequestType    type, GATTable_const    parameters, const char *    name, GATRequest *    request )    GATSelfCPI_CreateRequestForListener. Parameters: this  The CPI object. instance_data  The instance data of the attached CPI object Returns: An error code. Definition at line 189 of file GATSelfCPI.c. References cpi, GATSelfCPI_S::create_requestforlistener, GATSelfCPI_S::data, data, GATRequest, GATRequestListener, GATRequestType, GATTable_const, and name. Referenced by GATSelf_AddRequestListener(). GATResult GATSelfCPI_DestroyRequestForListener (  GATSelfCPI    cpi, GATSelfCPI_Instance *    instance_data, GATContext    context, GATRequest *    request )    GATSelfCPI_DestroyRequestForListener. Parameters: this  The CPI object. instance_data  The instance data of the attached CPI object Returns: An error code. Definition at line 206 of file GATSelfCPI.c. References cpi, GATSelfCPI_S::data, GATSelfCPI_S::destroy_requestforlistener, and GATRequest. Referenced by GATSelf_RemoveRequestListener().