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

GATResourceBroker.h Go to the documentation of this file. /** @file GATResourceBroker.h * Header file for the GATResourceBroker class. * * An instance of this class is used to broker Resources. A resource can * either be a node or a component. * * @date Thu Oct 23 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATResourceBroker.h,v 1.12 2004/03/24 19:30:58 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(_GATRESOURCEBROKER_H_) #define _GATRESOURCEBROKER_H_ /* GAT Header Files */ #include "GATObject.h" #include "GATType.h" #include "GATTime.h" #include "GATList.h" #include "GATTimePeriod.h" #include "GATJob.h" #include "GATJobDescription.h" #include "GATResourceDescription.h" /* Structures, unions and enums */ #ifdef __cplusplus extern "C" { #endif /* Declare the needed GATList_GATResource */ GATLIST_DECLARE_QUALIFIED(extern, GATResource, GATList_GATResource); /* Declare the converters to/from GATObject */ GATOBJECT_DECLARE_CONVERTERS(GATResourceBroker); /** GATResourceBroker_Create * @brief Create a new GATResourceBroker object * * The function @c GATResourceBroker_Create creates a new * GATResourceBroker 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. * @param vo_name The name of the virtual organisation to use. * * @return Returns a handle to the newly created GATResourceBroker object. * Returns 0 (zero) if an error occurs. */ GATResourceBroker GATResourceBroker_Create(GATContext context, GATPreferences_const preferences, GATString vo_name); /** void GATResourceBroker_Destroy(GATResourceBroker *resource) * * The function GATResourceBroker_Destroy is the destructor used to * free all the memory allocated by an GATResourceBroker instance. * * @param description The pointer to the GATResourceBroker to destroy */ void GATResourceBroker_Destroy(GATResourceBroker *object); /** GATResourceBroker_Equals * @brief Compare two GATResourceBroker objects * * The function @c GATResourceBroker_Equals compares two objects of the * @c GATResourceBroker 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 GATResourceBroker_Equals(GATResourceBroker_const lhs, GATResourceBroker_const rhs, GATBool *isequal); /** GATResourceBroker_Clone * @brief Clone the given GATResourceBroker * * The function @c GATResourceBroker_Clone generates a (deep) copy of * the given GATResourceBroker. * * @param description The object to clone * @param new_object The pointer, through which the result is to be * returned. * * @return An error type. */ GATResult GATResourceBroker_Clone(GATResourceBroker_const object, GATResourceBroker *new_object); /** GATType GATResourceBroker_GetType(GATResourceBroker_const resource) * @brief Return the type of the GATResourceBroker * * The function @c GATResourceBroker_GetType always returns * @c #GATType_GATResourceBroker. * * @param object The object to inspect * * @return Returns always @c #GATType_GATResourceBroker. */ GATType GATResourceBroker_GetType(GATResourceBroker_const object); /** int GATResourceBroker_GetInterface(GATResourceBroker_const file, GATInterface iftype, void const **ifp) * @brief Get an interface supported by a GATObject * * The function GATResourceBroker_GetInterface allows to get a pointer to an * additional interface supported by this GATResourceBroker. * * @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 GATResourceBroker_GetInterface(GATResourceBroker_const object, GATInterface iftype, void const **ifp); /** GATResourceBroker_ReserveResource_Description * @brief reserve a resource matching the description * * The function @c GATResourceBroker_ReserveResource_Description tries to find * a resource, which matches the provided description and returns a * reservation for this resource. * * @param broker The resource broker to use for this operation. * @param description The resource description needed for selecting the * required resource. * @param time The (optional) time, when the reservation has to start. * @param duration The (optional) time period for which to reserve the * resource. * @param reservation The pointer to the GATReservation variable to use to * return the resulting reservation. * * @return An error code. */ GATResult GATResourceBroker_ReserveResource_Description(GATResourceBroker broker, GATResourceDescription_const description, GATTime_const zeit, GATTimePeriod_const duration, GATReservation *reservation); /** GATResourceBroker_ReserveResource * @brief Reserve a given resource. * * The function @c GATResourceBroker_ReserveResource tries to reserve * the given resource and returns a reservation for this resource. * * @param broker The resource broker to use for this operation. * @param context The associated GAT context. * @param resource The resource to reserve. * @param time The (optional) time, when the reservation has to start. * @param duration The (optional) time period for which to reserve the * resource. * @param reservation The pointer to the GATReservation variable to use to * return the resulting reservation. * * @return An error value. */ GATResult GATResourceBroker_ReserveResource(GATResourceBroker broker, GATResource_const resource, GATTime_const zeit, GATTimePeriod_const duration, GATReservation *reservation); /** GATResourceBroker_FindResources * @brief Find a list of matching resources. * * The function GATResourceBroker_FindResources tries to find all resources * matching the given description and returns the found resources as a list. * * @param broker The resource broker to use for this operation. * @param description The description to match while searching for resources. * @param resources The pointer to a variable receiving the resulting list of * matching resources. * * @return An error value. */ GATResult GATResourceBroker_FindResources(GATResourceBroker broker, GATResourceDescription_const description, GATList_GATResource *resources); /** GATResourceBroker_SubmitJob * @brief Submit a new job. * * The function GATResourceBroker_SubmitJob submits a new job to the resource * described by the given job description. * * @param broker The resource broker to use for this operation. * @param description The job description containing the information about the * job iteslf and the resource to use. * @param job The pointer to a variable receiving the resulting GATJob object * handle. * * @return An error value. */ GATResult GATResourceBroker_SubmitJob(GATResourceBroker broker, GATJobDescription_const description, GATJob *job); #ifdef __cplusplus } /* extern "C" */ #endif #endif /* !defined(_GATRESOURCEBROKER_H_) */