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

GATPipe.h Go to the documentation of this file. /** @file GATPipe.h * Header file for the GATPipe class. * * An GATPipe represents a connection to another process. * * @date $Date: 2004/03/24 19:30:58 $ * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATPipe.h,v 1.8 2004/03/24 19:30:58 hartmutkaiser Exp $ * * Copyright (C) Kelly Davis * This file is part of the GAT Engine. * Contributed by Kelly Davis <kdavis@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 _GATPIPE_H_ #define _GATPIPE_H_ 1 #include "GATType.h" #include "GATObject.h" #ifdef __cplusplus extern "C" { #endif /* Declare the converters to/from GATObject */ GATOBJECT_DECLARE_CONVERTERS(GATPipe); /* GATObject API */ /** GATPipe_Destroy * The GATPipe destructor. * This is the destructor for GATPipe objects. * * @param this An old GATPipe */ void GATPipe_Destroy(GATPipe *peep); /** int GATPipe_GetType(GATPipe_const peep) * @brief Return the type of the GATPipe * * The function @c GATPipe_GetType always returns GATType_GATPipe. * * @param object The object to inspect * * @return returns always @c #GATType_GATPipe. */ GATType GATPipe_GetType(GATPipe_const peep); /** int GATPipe_Clone(GATPipe_const peep, GATPipe *new_peep) * @brief Clone the given GATPipe * * The function @c GATPipe_Clone generates a (deep) copy of the given * GATPipe. * * @param peep The object to clone * @param new_peep The pointer, through which the result is to be * returned. * * @return An error type. */ GATResult GATPipe_Clone(GATPipe_const peep, GATPipe *new_peep); /** int GATPipe_Equals(GATPipe_const lhs, GATPipe_const rhs, GATBool *isequal) * @brief Compares two GATPipe objects * * The function @c GATPipe_Equals compares two peep objects of type * @c #GATPipe. * * @param lhs The first peep object to compare * @param rhs The second peep object to compare * @param isequal The pointer to the GATBool variable, which should receive * the result if the comparision * * @return An error code. */ GATResult GATPipe_Equals(GATPipe_const lhs, GATPipe_const rhs, GATBool *isequal); /** int GATPipe_GetInterface(GATPipe_const peep, GATInterface iftype, void const **ifp) * @brief Get an interface supported by a GATPipe * * The function GATPipe_GetInterface allows to get a pointer to an * additional interface supported by this GATPipe. * * @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 GATPipe_GetInterface(GATPipe_const peep, GATInterface iftype, void const **ifp); /* GATPipe API */ /** GATPipe_Create * Constructs an instance of this class. * * @param context Used to broker resources. * @param preferences User preferences for this instance. * @param information Other information required to construct a GATPipe. */ GATPipe GATPipe_Create(GATContext context, GATPreferences_const preferences, void *information); /* GATMonitorable API */ /** GATPipe_AddMetricListener * * The function GATPipe_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 peep The GATPipe 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 GATPipe_AddMetricListener(GATPipe peep, GATMetricListener listener, void *listener_data, GATMetric metric, GATuint32 *cookie); /** GATPipe_RegisterPolling * * The function GATPipe_RegisterPolling registers a continuous * metric with the given GATPipe instance. * * @param peep The GATPipe 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 GATPipe. * * @return An error code. */ GATResult GATPipe_RegisterPolling(GATPipe peep, GATMetric metric, GATMetricEvent *event, GATuint32 *cookie); /** GATPipe_RemoveRegisteredMetric * * The function GATPipe_RemoveRegisteredMetric removes a GATMetricListener, * which was previously registered with GATPipe_AddMetricListener. * * @param peep The GATPipe instance to remove the GATMetricListener 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 GATPipe_RemoveRegisteredMetric(GATPipe peep, GATMetric metric, GATuint32 cookie); /** GATPipe_GetMetrics * * The function GATPipe_GetMetrics returns a list of metrics supported by this * GATPipe. * * @param peep The GATPipe 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 GATPipe_GetMetrics(GATPipe_const peep, GATList_GATMetric *metrics); /* IStreamable implementation */ /* Reads from this GATStreamable into the given buffer */ GATResult GATPipe_Read(GATPipe object, void *buffer, GATuint32 size, GATuint32 *read_bytes); /* Writes data from the given Buffer through the GATStreamable */ GATResult GATPipe_Write(GATPipe object, void const *buffer, GATuint32 size, GATuint32 *written_bytes); /* reposition the internal stream position */ GATResult GATPipe_Seek(GATPipe object, GATOrigin origin, GATint32 offset, GATuint32 *new_position); /* Closes this GATStreamable instance. */ GATResult GATPipe_Close(GATPipe object); #ifdef __cplusplus } #endif #endif /* _GATPIPE_H_ */