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

GATMonitorable.h Go to the documentation of this file. /** @file GATMonitorable.h * Header file for the GATMonitorable class. * * This declaration of the GATMonitorable interface, which is meant as a * generic helper class, which may be used by other GATObjects to implement * its GATMonitorable interface. * * The GATMonitorable_Impl class is essentially a table of lists, where the * GATMetric is used as the key type for the table and the list contains the * GATMetricListener's for the GATMetric used as the key. * * @date Mon Nov 3 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATMonitorable.h,v 1.7 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) */ #ifndef _GATMONITORABLE_H_ #define _GATMONITORABLE_H_ 1 #include "GATType.h" #include "GATList.h" /* typedefs */ typedef struct GATMonitorable_Impl_S *GATMonitorable_Impl; typedef struct GATMonitorable_Impl_S const *GATMonitorable_Impl_const; #ifdef __cplusplus extern "C" { #endif /* Declare the converters to/from GATObject */ GATOBJECT_DECLARE_CONVERTERS(GATMonitorable_Impl); /* Declare the GATList_GATMetric list. */ GATLIST_DECLARE_QUALIFIED(extern, GATMetric, GATList_GATMetric); /** GATMonitorable_Impl_Create * * Create a new instance of the GATMonitorable_Impl class. * * @param metrics The list of metrics, which should be supported by this * instance of an GATMonitorable_Impl. * * @return The newly constructed instance. */ GATMonitorable_Impl GATMonitorable_Impl_Create(GATList_GATMetric metrics); /** GATMonitorable_Impl_Destroy * The GATMonitorable_Impl destructor. * This is the destructor for GATMonitorable_Impl objects. * * @param monitorable An old GATMonitorable_Impl */ void GATMonitorable_Impl_Destroy(GATMonitorable_Impl *monitorable); /** int GATMonitorable_Impl_Equals(GATMonitorable_Impl_const lhs, GATMonitorable_Impl_const rhs, GATBool *isequal) * @brief Compares two GATMonitorable_Impl objects * * The function @c GATMonitorable_Impl_Equals compares two file objects of type * @c #GATMonitorable_Impl. * * @param lhs The first file object to compare * @param rhs The second file object to compare * @param isequal The pointer to the GATBool variable, which should receive * the result if the comparision * * @return An error code. */ GATResult GATMonitorable_Impl_Equals(GATMonitorable_Impl_const lhs, GATMonitorable_Impl_const rhs, GATBool *isequal); /** int GATMonitorable_Impl_Clone(GATMonitorable_Impl_const filehandle, GATMonitorable_Impl *new_file) * @brief Clone the given GATMonitorable_Impl * * The function @c GATMonitorable_Impl_Clone generates a (deep) copy of the given * GATMonitorable_Impl. * * @param filehandle The object to clone * @param new_file The pointer, through which the result is to be * returned. * * @return An error type. */ GATResult GATMonitorable_Impl_Clone(GATMonitorable_Impl_const monitorable, GATMonitorable_Impl *new_object); /** GATMonitorable_Impl_AddMetricListener * * The function GATMonitorable_Impl_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 monitorable The GATMonitorable instance to add the GATMetricListener * to. * @param listener The GATMetricListener 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. This metric instance must be of type * GATMeasurementType_EventLike, otherwise an error is returned. * @param cookie The returned value should be used to remove the * GATMetricListener from this GATMonitorable. * * @return An error code. */ GATResult GATMonitorable_Impl_AddMetricListener(GATMonitorable_Impl monitorable, GATMetricListener listener, void *listener_data, GATMetric metric, GATuint32 *cookie); /** GATMonitorable_Impl_RegisterPolling * * The function GATMonitorable_Impl_RegisterPolling registers a continuous * metric with the given GATMonitorable instance. * * @param monitorable The GATMonitorable 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 (this parameter is ignored for this function). * @param cookie The returned value should be used to remove the * GATMetricListener from this GATMonitorable. * * @return An error code. */ GATResult GATMonitorable_Impl_RegisterPolling(GATMonitorable_Impl monitorable, GATMetric metric, GATMetricEvent *event, GATuint32 *cookie); /** GATMonitorable_Impl_RemoveRegisteredMetric * * The function GATMonitorable_Impl_RemoveRegisteredMetric removes a * GATMetricListener, which was previously registered with * GATMonitorable_AddMetricListener. * * @param monitorable The GATMonitorable instance to remove the metric from. * @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 GATMonitorable_Impl_RemoveRegisteredMetric(GATMonitorable_Impl monitorable, GATMetric metric, GATuint32 cookie); /** GATMonitorable_Impl_GetMetrics * * The function GATMonitorable_Impl_GetMetrics returns a list of metrics supported * by this GATMonitorable. * * @param monitorable The GATMonitorable 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 GATMonitorable_Impl_GetMetrics(GATMonitorable_Impl_const monitorable, GATList_GATMetric *metrics); /** GATMonitorable_Impl_FireEvent * * The function GATMonitorable_Impl_FireEvent may be used by an adaptor to * raise a specific event. * * @param monitorable The GATMonitorable instance, through which the given * metric event should be raised. * @param metric Describes the type of the event to be raised. * @param event The event to be raised. * * @return An error code. */ GATResult GATMonitorable_Impl_FireEvent(GATMonitorable_Impl_const monitorable, GATMetric metric, GATMetricEvent event); #ifdef __cplusplus } #endif #endif /* _GATMONITORABLE_H_ */