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

GATAdvertService.h Go to the documentation of this file. /** @file GATAdvertService.h * Header file for the GATAdvertService class. * * @date Fri Feb 13 2004 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATAdvertService.h,v 1.6 2004/04/03 10:49:47 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(_GATADVERTSERVICE_H_) #define _GATADVERTSERVICE_H_ /* GAT Header Files */ #include "GATObject.h" #include "GATType.h" /* Structures, unions and enums */ #ifdef __cplusplus extern "C" { #endif /* Declare the converters to/from GATObject */ GATOBJECT_DECLARE_CONVERTERS(GATAdvertService); /** GATAdvertService_Create * @brief Create a new GATAdvertService object * * The function @c GATAdvertService_Create creates a new * GATAdvertService 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 GATAdvertService object. * Returns 0 (zero) if an error occurs. */ GATAdvertService GATAdvertService_Create(GATContext context, GATPreferences_const preferences); /** void GATAdvertService_Destroy(GATAdvertService *resource) * * The function GATAdvertService_Destroy is the destructor used to * free all the memory allocated by an GATAdvertService instance. * * @param object The pointer to the GATAdvertService to destroy */ void GATAdvertService_Destroy(GATAdvertService *object); /** GATAdvertService_Equals * @brief Compare two GATAdvertService objects * * The function @c GATAdvertService_Equals compares two objects of the * @c GATAdvertService 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 GATAdvertService_Equals(GATAdvertService_const lhs, GATAdvertService_const rhs, GATBool *isequal); /** GATAdvertService_Clone * @brief Clone the given GATAdvertService * * The function @c GATAdvertService_Clone generates a (deep) copy of * the given GATAdvertService. * * @param description The object to clone * @param new_object The pointer, through which the result is to be * returned. * * @return An error type. */ GATResult GATAdvertService_Clone(GATAdvertService_const object, GATAdvertService *new_object); /** GATType GATAdvertService_GetType(GATAdvertService_const resource) * @brief Return the type of the GATAdvertService * * The function @c GATAdvertService_GetType always returns * @c #GATType_GATAdvertService. * * @param object The object to inspect * * @return Returns always @c #GATType_GATAdvertService. */ GATType GATAdvertService_GetType(GATAdvertService_const object); /** GATResult GATAdvertService_GetInterface(GATAdvertService_const file, GATInterface iftype, void const **ifp) * @brief Get an interface supported by a GATObject * * The function GATAdvertService_GetInterface allows to get a pointer to an * additional interface supported by this GATAdvertService. * * @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 GATAdvertService_GetInterface(GATAdvertService_const object, GATInterface iftype, void const **ifp); /* GATMonitorable API */ /** GATAdvertService_AddMetricListener * * The function GATAdvertService_AddMetricListener adds the passed instance of a * GATMetricListener to the list of GATMetricListeners which are notified of * fired GATMetricEvents of the type described by the provided GATMetric * instance. * * @param object The GATAdvertService instance to add the GATMetricListener to. * @param listener The GTAMetricListener to call, when the corresponding * GATMetricEvent is fired. * @param listener_data The client supplied data, which will be passed through * to the GATMetricListener. * @param metric The GATMetric instance describing the GATMetricEvent to pass * to the GATMetricListener. * @param cookie The returned value should be used to remove the * GATMetricListener from this GATMonitorable. * * @return An error code. */ GATResult GATAdvertService_AddMetricListener(GATAdvertService object, GATMetricListener listener, void *listener_data, GATMetric metric, GATuint32 *cookie); /** GATAdvertService_RegisterPolling * * The function GATAdvertService_RegisterPolling registers a continuous * metric with the given GATAdvertService instance. * * @param object The GATAdvertService instance to register the metric with. * @param metric The GATMetric instance describing the GATMetricEvent to pass * to the GATMetricListener. This metric instance must be of type * GATMeasurementType_Continuous, otherwise an error is returned. * @param event The pointer to a variable, which should receive the resulting * GATMetricEvent. The GATMetricEvent instance should be freed by the * caller when it isn't used anymore. * @param cookie The returned value should be used to remove the * GATMetricListener from this GATAdvertService. * * @return An error code. */ GATResult GATAdvertService_RegisterPolling(GATAdvertService object, GATMetric metric, GATMetricEvent *event, GATuint32 *cookie); /** GATAdvertService_RemoveRegisteredMetric * * The function GATAdvertService_RemoveRegisteredMetric removes a GATMetricListener, * which was previously registered with GATAdvertService_AddMetricListener. * * @param object The GATAdvertService instance to remove the GATMetricListener from. * @param listener The GATMetricListener to call, when the corresponding * GATMetricEvent is fired. * @param metric The GATMetric instance describing the GATMetricEvent to pass * to the GATMetricListener. * @param cookie This value identifies the GATMetricListener to remove, it * was returned from the corresponding GATMonitorable_AddMetricListener * or GATMonitorable_MetricRegisterPolling functions. * * @return An error code. */ GATResult GATAdvertService_RemoveRegisteredMetric(GATAdvertService object, GATMetric metric, GATuint32 cookie); /** GATAdvertService_GetMetrics * * The function GATAdvertService_GetMetrics returns a list of metrics supported * by this GATAdvertService. * * @param object The GATAdvertService instance, for which the supported metrics * should be returned. * @param metrics The pointer to the variable, which receives the resulting * list of metrics. * * @return An error code. */ GATResult GATAdvertService_GetMetrics(GATAdvertService_const object, GATList_GATMetric *metrics); /** GATAdvertService_Add * * The function GATAdvertService_Add adds an Advertizable instance and related * meta data to the GATAdvertService, at path (absolute or relative to PWD). * If an GATAdvertService entry exists at the specified path, that entry gets * overwritten. * * @param object The GATAdvertService instance, to which the advertisable * should be added. * @param advertisable The advertisable object, which should be stored in the * given advertservice. * @param metadata The meta data to rassociate with the newly created entry. * @param path The path inside the advert service, where the newly created * entry is to be stored. * * @return An error code. */ GATResult GATAdvertService_Add(GATAdvertService object, GATObject_const advertisable, GATTable metadata, GATString_const path); /** GATAdvertService_Delete * * The function GATAdvertService_Delete deletes the specified entry from the * GATAdvertService. * * @param object The GATAdvertService instance, from which the given path * should be deleted. * @param path The path of the entry to delete from the given advert service. * * @return An error code. */ GATResult GATAdvertService_Delete(GATAdvertService object, GATString_const path); /** GATAdvertService_GetMetaData * * The function GATAdvertService_GetMetaData gets the meta data for the * specified AD entry. * * @param object The GATAdvertService instance, from which the metadata of the * given path should be returned. * @param path The path of the entry, for which the meta data should be * retrieved. * @param The pointer to a variable, which receives the requested meta data * (the returned GATTable object should be free'd by the user of this * function). * * @return An error code. */ GATResult GATAdvertService_GetMetaData(GATAdvertService_const object, GATString_const path, GATTable *metadata); /** GATAdvertService_GetAdvertisable * * The function GATAdvertService_GetAdvertisable gets the Advertisable instance * for the specified GATAdvertService entry. * * @param object The GATAdvertService instance, from which the advertisable of * the given path should be returned. * @param path The path of the entry, for which the stroed advertisable should * be retrieved. * @param advertisable The pointer to a variable, which should receive the * requested advertisable object (the returned GATObject should be * free'd by the user of this function). * * @return An error code. */ GATResult GATAdvertService_GetAdvertisable(GATAdvertService_const object, GATString_const path, GATObject *advertisable); /** GATAdvertService_Find * * The function GATAdvertService_Find queries the GATAdvertService for entries * matching the specified set of meta data. * * @param object The GATAdvertService instance, inside which the query should * be executed. * @param metadata The meta data search criteria to use for the query. * @param paths The pointer to a variable, which should receive the list of * paths pointing to matching entries inside the given advert service * (the returned list of strings should be free'd by the user of this * function). * * @return An error code. */ GATResult GATAdvertService_Find(GATAdvertService_const object, GATTable_const metadata, GATList_String *paths); /** GATAdvertService_SetPWD * * The function GATAdvertService_SetPWD specifies the element of the * GATAdvertService namespace to be used as reference for relative paths. * * @param object The GATAdvertService instance, for which the reference should * be set. * @param path The path referencing the namespace element to be used as the * reference for relative paths. * * @return An error code. */ GATResult GATAdvertService_SetPWD(GATAdvertService object, GATString_const path); /** GATAdvertService_GetPWD * * The function GATAdvertService_GetPWD gets the path of the element of the * GATAdvertService namespace, which is used as reference for relative paths. * * @param object The GATAdvertService instance, for which the reference should * be retrieved. * @param path The pointer of the variable, which should receive the path * referencing the namespace element, which is used as the reference for * relative paths. * * @return An error code. */ GATResult GATAdvertService_GetPWD(GATAdvertService object, GATString *path); #ifdef __cplusplus } /* extern "C" */ #endif #endif /* !defined(_GATADVERTSERVICE_H_) */