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

GATRequest.h Go to the documentation of this file. /** @file GATRequest.h * Header file for the GATRequest class. * * A GATRequest represents 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/GATRequest.h,v 1.12 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(_GATREQUEST_H_) #define _GATREQUEST_H_ /* GAT Header Files */ #include "GATObject.h" #include "GATRequestNotifier.h" /* Structures, unions and enums */ #ifdef __cplusplus extern "C" { #endif /* Declare the converters to/from GATObject */ GATOBJECT_DECLARE_CONVERTERS(GATRequest); /** GATRequest_Create * @brief Create a new GATRequest object * * The function @c GATRequest_internal_Create creates a new * GATRequest object * * @param context The GAT context to use while thie initialisation of the * new object. * @param preferences The preferences to use wile selecting the adaptor for * the corresponding CPI. * * @return Returns a handle to the newly created GATRequest object. * Returns 0 (zero) if an error occurs. */ GATRequest GATRequest_Create(GATContext context, GATPreferences_const preferences, GATRequestListener listener, void *client_contextdata, GATRequestType type, GATTable_const parameters, char const *request_name, void *initialisation_data); /** void GATRequest_Destroy(GATRequest *resource) * * The function GATRequest_Destroy is the destructor used to * free all the memory allocated by an GATRequest instance. * * @param object The pointer to the GATRequest to destroy */ void GATRequest_Destroy(GATRequest *object); /** GATRequest_Equals * @brief Compare two GATRequest objects * * The function @c GATRequest_Equals compares two objects of the * @c GATRequest type. * * @param lhs The first list to compare * @param rhs The second list to compare * @param isequal The pointer to the location, where the outcome of the * function has to be stored. * * @return An error code. */ GATResult GATRequest_Equals(GATRequest_const lhs, GATRequest_const rhs, GATBool *isequal); /** GATRequest_Clone * @brief Clone the given GATRequest * * The function @c GATRequest_Clone generates a (deep) copy of * the given GATRequest. * * @param description The object to clone * @param new_object The pointer, through which the result is to be * returned. * * @return An error type. */ GATResult GATRequest_Clone(GATRequest_const object, GATRequest *new_object); /** GATType GATRequest_GetType(GATRequest_const resource) * @brief Return the type of the GATRequest * * The function @c GATRequest_GetType always returns * @c #GATType_GATRequest. * * @param object The object to inspect * * @return Returns always @c #GATType_GATRequest. */ GATType GATRequest_GetType(GATRequest_const object); /** GATResult GATRequest_GetInterface(GATRequest_const file, GATInterface iftype, void const **ifp) * @brief Get an interface supported by a GATObject * * The function GATRequest_GetInterface allows to get a pointer to an * additional interface supported by this GATRequest. * * @param object The object to be asked for the new interface. * @param iftype The interface the object is to be asked for. * @param ifp The pointer, through which the result is to be returned. * * @return An error type. */ GATResult GATRequest_GetInterface(GATRequest_const object, GATInterface iftype, void const **ifp); /** GATRequest_GetRequestNotifier * * The functions GATRequest_GetRequestNotifier gets the GATRequestNotifier * associated with this GATRequest. * * @param request The GATRequest object to query for its request name. * @param The pointer to a variable, which should receive the returned * request notifier associated with this GATRequest object. * * @return An error code. */ GATResult GATRequest_GetRequestNotifier(GATRequest_const request, GATRequestNotifier_const *notifier); /** GATRequest_GetRequestName * * The functions GATRequest_GetRequestName gets the GATRequest name associated * with this GATRequest. * * @param request The GATRequest object to query for its request name. * * @return The request name or 0 (zero) if an error occurs. */ char const * GATRequest_GetRequestName(GATRequest_const request); /** GATRequest_IssueCommand * * The function GATRequest_IssueCommand is to be called by an adaptor to issue * the command or query for the information, which corresponds to this * GATRequest. * * @param request The request object, for which the command should be issued * or the information is to be queried. * * @return An error code. */ GATResult GATRequest_IssueCommand(GATRequest_const request); #ifdef __cplusplus } /* extern "C" */ #endif #endif /* !defined(_GATREQUEST_H_) */