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 Go to the documentation of this file. /** @file GATRequestCPI.h * 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) */ #if !defined(_GATREQUESTCPI_H_) #define _GATREQUESTCPI_H_ typedef struct GATRequestCPI_S *GATRequestCPI; #include "GATContext.h" #include "GATPreferences.h" #include "GATRequest.h" /* Versioning constants for the GATRequestCPI_Data struct */ #define GATREQUESTCPI_VERSION1 1 /* the newest version we know of */ #define GATREQUESTCPI_VERSION GATREQUESTCPI_VERSION1 /** * The @c #GATRequestCPI_Instance structure holds all data items supplied * by the client during the construction of the corresponding GAT object. */ typedef struct GATRequestCPI_Instance_S { GATContext context; /* the GAT context to use for all GATFile operations */ GATRequestType type; /* the type of the request */ char *request_name; /* the name of the request */ GATRequestListener listener; /* the request listener to call */ void *client_contextdata; /* the data to give to the request listener */ GATTable parameters; /* the parameters given at construction time */ GATRequest_const source; /* the object this CPI is associated with */ GATRequestNotifier_const notifier; /* the request notifier to use */ void *instance_data; /* eventually supplied CPI provider instance data */ } GATRequestCPI_Instance; /* prototypes for the adapter callback functions */ typedef void (*GATRequestCPI_Adaptor_Destroy)(void *); typedef GATResult (*GATRequestCPI_Adaptor_ServiceActions)(void *, GATRequestCPI_Instance *, GATTimePeriod_const); /* instance specific functions */ 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 *); /* CPI specific API */ typedef GATResult (*GATRequestCPI_Adaptor_InitRequestNotifier)(void *, GATRequestCPI_Instance const *, GATRequestNotifier_const *); /* CPI data passed from the adaptor while registering the CPI */ typedef struct { /* CPI data (type local data) */ void *data; GATRequestCPI_Adaptor_Destroy destroy; /* CPI instance data */ GATRequestCPI_Adaptor_ServiceActions service_actions; GATRequestCPI_Adaptor_CreateInstance create_instance; GATRequestCPI_Adaptor_DestroyInstance destroy_instance; GATRequestCPI_Adaptor_CloneInstance clone_instance; GATRequestCPI_Adaptor_EqualsInstance equals_instance; /* CPI functionality */ GATRequestCPI_Adaptor_InitRequestNotifier init_notifier; } GATRequestCPI_Data; #ifdef __cplusplus extern "C" { #endif /* Adaptor API */ /** GATRequestCPI_Create * The GATRequestCPI constructor. * new_cpi is the constructor for GATRequestCPI objects. * * @param version Version of the GATRequestCPI_Data structure * @param data Pointer to adaptor CPI instance data structure. * * @return A new GATRequestCPI */ GATRequestCPI GATRequestCPI_Create(unsigned long int version, GATRequestCPI_Data *data); /* API internal to the GAT engine */ /** GATRequestCPI_Destroy * @brief The GATRequestCPI destructor. * * This is the destructor for GATRequestCPI objects. * * @param this An old GATRequestCPI */ void GATRequestCPI_Destroy(GATRequestCPI *cpi); /* CPI instance specific functions */ /** GATRequestCPI_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 GATRequestCPI_CreateInstance(GATRequestCPI cpi, GATRequestCPI_Instance *instance_data, void *initialisation_data); /** GATRequestCPI_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 GATRequestCPI_DestroyInstance(GATRequestCPI cpi, GATRequestCPI_Instance *instance_data); /** GATRequestCPI_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 GATRequestCPI_EqualsInstance(GATRequestCPI cpi, GATRequestCPI_Instance const *lhs, GATRequestCPI_Instance const *rhs, GATBool *isequal); /** GATRequestCPI_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 GATRequestCPI_CloneInstance(GATRequestCPI cpi, GATRequestCPI_Instance const *instance_data, GATRequestCPI_Instance *new_instance_data); /* CPI specific API */ /** GATRequestCPI_InitRequestNotifier * * Calls the adaptor to return the associated request notifier. * * @param this The CPI object. * @param instance_data The instance data of the CPI object to ask for the * request notifier. * @param notifier The pointer to a variable, which should receive the * returned request notifier. * * @return An error code. */ GATResult GATRequestCPI_InitRequestNotifier(GATRequestCPI cpi, GATRequestCPI_Instance const *instance_data, GATRequestNotifier_const *notifier); #ifdef __cplusplus } /* extern "C" */ #endif #endif /* !defined(_GATREQUESTCPI_H_) */