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

GATRegistry.h Go to the documentation of this file. /** @file GATRegistry.h * Header file for the GATRegistry class. * * The Registry keeps track of all capabilities and their providers. * * @date Thu Sep 18 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATRegistry.h,v 1.21 2004/04/18 18:35:10 hartmutkaiser Exp $ * * Copyright (C) Tom Goodale * This file is part of the GAT Engine. * Contributed by Tom Goodale <goodale@aei.mpg.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) */ #ifndef _GATREGISTRY_H_ #define _GATREGISTRY_H_ 1 #include "GATPreferences.h" /* typedef's */ typedef struct CPIRegistryList_S *CPIRegistryList; typedef struct CPIRegistryList_S const *CPIRegistryList_const; typedef GATResult (*GATCPICallback)(CPIRegistryList_const, void *); /* Define a macro so it is easy to add more CPI types. * Macro takes one argument, which is the base name of the CPI, * i.e. no GAT prefix. * * Defines four functions which need to be implemented in GATRegistry.c, * schematically * int GATRegistry_Add<type>(arguments) * List<type> = GATRegistry_Find<type>(preferences) * List<type>_Destroy(List<type>) * List<type> = GATRegistry_CloneList<type>(list<type>) * * where List<type> is a single-linked list with a next member to the next * one in the list, and a cpi member which contains the current object */ #define CPI(object) \ int GATRegistry_AddGAT ## object ## CPI(GATRegistry registry, \ GAT ## object ## CPI cpi, \ void *token, \ GATPreferences_const preferences); \ \ struct GAT ## object ## CPIList_S \ { \ struct GAT ## object ## CPIList_S *next; \ GAT ## object ## CPI cpi; \ }; \ \ typedef struct GAT ## object ## CPIList_S *GAT ## object ## CPIList; \ typedef struct GAT ## object ## CPIList_S const * \ GAT ## object ## CPIList_const; \ \ GAT ## object ## CPIList GATRegistry_FindGAT ## object ## CPI( \ GATRegistry_const reg, GATPreferences_const preferences); \ \ void GAT ## object ## CPIList_Destroy(GAT ## object ## CPIList list); \ \ GAT ## object ## CPIList GATRegistry_CloneGAT ## object ## CPIList( \ GAT ## object ## CPIList_const list); \ \ typedef GATResult (*GAT ## object ## CPICallback)(GAT ## object ## CPI, \ void *); \ \ GATResult GATRegistry_WalkGAT ## object ## CPIList(GATRegistry_const registry,\ GATCPICallback, void *data); \ \ GATResult GATRegistry_AddGAT ## object ## ToCPIList(GATContext ctx, \ GAT ## object ## CPI cpi, GAT ## object obj); \ \ GATResult GATRegistry_RemoveGAT ## object ## FromCPIList( \ GATContext ctx, GAT ## object ## CPI cpi, \ GAT ## object obj) \ /**/ /* Now include all CPI header files */ #include "GATFileStreamCPI.h" #include "GATPipeCPI.h" #include "GATEndpointCPI.h" #include "GATFileCPI.h" #include "GATLogicalFileCPI.h" #include "GATResourceBrokerCPI.h" #include "GATReservationCPI.h" #include "GATResourceCPI.h" #include "GATJobCPI.h" #include "GATSelfCPI.h" #include "GATRequestCPI.h" #include "GATAdvertServiceCPI.h" #ifdef __cplusplus extern "C" { #endif /* generic registry API */ GATRegistry GATRegistry_Create(void); void GATRegistry_Destroy(GATRegistry *registry); int GATRegistry_RemoveByToken(GATRegistry registry, void *token); /* GATRegistry_internal_ServiceAction * * The ServiceActions call is used to allow the GAT Engine to service * asynchronous actions, such as GATRequests and GATMetricEvents. In a * single-threaded application it is likely that a timeout would be supplied, * in a multi-threaded application one thread may be used for the GAT by using * this call and no timeout. * * @param timeout This may be a 0 timeout to indicate no timeout at all, or * a specific time length. * * @return An error code. */ GATResult GATRegistry_internal_ServiceActions(GATRegistry_const registry, GATContext context, GATTimePeriod_const timeout); /* declare the concrete CPI API functions */ CPI(FileStream); CPI(Pipe); CPI(Endpoint); CPI(File); CPI(LogicalFile); CPI(ResourceBroker); CPI(Reservation); CPI(Resource); CPI(Job); CPI(Self); CPI(Request); CPI(AdvertService); #ifdef __cplusplus } #endif /* Undefine macro to alleviate namespace conflicts */ #undef CPI #endif /* _GATREGISTRY_H_ */