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 Go to the documentation of this file. /** @file GATSelfCPI.h * 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) */ #if !defined(_GATSELFCPI_H_) #define _GATSELFCPI_H_ #include "GATContext.h" #include "GATPreferences.h" /* Versioning constants for the GATSelfCPI_Data struct */ #define GATSELFCPI_VERSION1 1 /* the newest version we know of */ #define GATSELFCPI_VERSION GATSELFCPI_VERSION1 /** * The @c #GATSelfCPI_Instance structure holds all data items supplied * by the client during the construction of the corresponding GAT object. */ typedef struct { void *instance_data; /* eventually supplied CPI provider instance data */ } GATSelfCPI_Instance; /* prototypes for the adapter callback functions */ typedef void (*GATSelfCPI_Adaptor_Destroy)(void *); /* instance specific functions */ 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 *); /* CPI specific API */ 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 *); /* CPI data passed from the adaptor while registering the CPI */ typedef struct { /* CPI data (type local data) */ void *data; GATSelfCPI_Adaptor_Destroy destroy; /* CPI instance data */ GATSelfCPI_Adaptor_ServiceActions service_actions; GATSelfCPI_Adaptor_CreateInstance create_instance; GATSelfCPI_Adaptor_DestroyInstance destroy_instance; /* CPI functionality */ GATSelfCPI_Adaptor_GetJob get_selfjob; GATSelfCPI_Adaptor_CreateRequestForListener create_requestforlistener; GATSelfCPI_Adaptor_DestroyRequestForListener destroy_requestforlistener; } GATSelfCPI_Data; #ifdef __cplusplus extern "C" { #endif /* Adaptor API */ /** GATSelfCPI_Create * The GATSelfCPI constructor. * new_cpi is the constructor for GATSelfCPI objects. * * @param version Version of the GATSelfCPI_Data structure * @param data Pointer to adaptor CPI instance data structure. * * @return A new GATSelfCPI */ GATSelfCPI GATSelfCPI_Create(unsigned long int version, GATSelfCPI_Data *data); /* API internal to the GAT engine */ /** GATSelfCPI_Destroy * @brief The GATSelfCPI destructor. * * This is the destructor for GATSelfCPI objects. * * @param this An old GATSelfCPI */ void GATSelfCPI_Destroy(GATSelfCPI *cpi); /* CPI instance specific functions */ /** GATSelfCPI_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 GATSelfCPI_CreateInstance(GATSelfCPI cpi, GATSelfCPI_Instance *instance_data); /** GATSelfCPI_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 GATSelfCPI_DestroyInstance(GATSelfCPI cpi, GATSelfCPI_Instance *instance_data); /* CPI specific API */ /** GATSelfCPI_GetJob * * * @return An error code. */ GATResult GATSelfCPI_GetJob(GATSelfCPI cpi, GATSelfCPI_Instance *instance_data, GATContext context, GATJob *job); /** GATSelfCPI_CreateRequestForListener * * * @return An error code. */ 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_DestroyRequestForListener * * * @return An error code. */ GATResult GATSelfCPI_DestroyRequestForListener(GATSelfCPI cpi, GATSelfCPI_Instance *instance_data, GATContext context, GATRequest *request); #ifdef __cplusplus } /* extern "C" */ #endif #endif /* !defined(_GATSELFCPI_H_) */