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

GATFileStream.h Go to the documentation of this file. /** @file GATFileStream.h * Header file for the GATFileStream class. * * An GATFileStream 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/GATFileStream.h,v 1.5 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 _GATFILESTREAM_H_ #define _GATFILESTREAM_H_ 1 #include "GATType.h" #include "GATObject.h" #ifdef __cplusplus extern "C" { #endif /* Declare the converters to/from GATObject */ GATOBJECT_DECLARE_CONVERTERS(GATFileStream); /* GATObject API */ /** GATFileStream_Destroy * The GATFileStream destructor. * This is the destructor for GATFileStream objects. * * @param this An old GATFileStream */ void GATFileStream_Destroy(GATFileStream *strm); /** int GATFileStream_GetType(GATFileStream_const fileStream) * @brief Return the type of the GATFileStream * * The function @c GATFileStream_GetType always returns GATType_GATFileStream. * * @param object The object to inspect * * @return returns always @c #GATType_GATFileStream. */ GATType GATFileStream_GetType(GATFileStream_const fileStream); /** int GATFileStream_Clone(GATFileStream_const fileStream, GATFileStream *new_fileStream) * @brief Clone the given GATFileStream * * The function @c GATFileStream_Clone generates a (deep) copy of the given * GATFileStream. * * @param fileStream The object to clone * @param new_fileStream The pointer, through which the result is to be * returned. * * @return An error type. */ GATResult GATFileStream_Clone(GATFileStream_const fileStream, GATFileStream *new_fileStream); /** int GATFileStream_Equals(GATFileStream_const lhs, GATFileStream_const rhs, GATBool *isequal) * @brief Compares two GATFileStream objects * * The function @c GATFileStream_Equals compares two fileStream objects of type * @c #GATFileStream. * * @param lhs The first fileStream object to compare * @param rhs The second fileStream object to compare * @param isequal The pointer to the GATBool variable, which should receive * the result if the comparision * * @return An error code. */ GATResult GATFileStream_Equals(GATFileStream_const lhs, GATFileStream_const rhs, GATBool *isequal); /** int GATFileStream_GetInterface(GATFileStream_const fileStream, GATInterface iftype, void const **ifp) * @brief Get an interface supported by a GATFileStream * * The function GATFileStream_GetInterface allows to get a pointer to an * additional interface supported by this GATFileStream. * * @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 GATFileStream_GetInterface(GATFileStream_const fileStream, GATInterface iftype, void const **ifp); /* GATFileStream API */ /** * Constructs an instance of this class. * * @param context Used to broker resources. * @param preferences User preferences for this instance. * @param location The location of the file to open * @param mode The mode in which to open the file (GATLogicalFileMode_Read, * GATLogicalFileMode_Write, GATLogicalFileMode_Append, or GATLogicalFileMode_ReadWrite). */ GATFileStream GATFileStream_Create(GATContext context, GATPreferences_const preferences, GATLocation location, GATFileStreamMode mode); /* GATMonitorable API */ /** GATFileStream_AddMetricListener * * The function GATFileStream_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 fileStream The GATFileStream 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 GATFileStream_AddMetricListener(GATFileStream fileStream, GATMetricListener listener, void *listener_data, GATMetric metric, GATuint32 *cookie); /** GATFileStream_RegisterPolling * * The function GATFileStream_RegisterPolling registers a continuous * metric with the given GATFileStream instance. * * @param fileStream The GATFileStream 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 GATFileStream. * * @return An error code. */ GATResult GATFileStream_RegisterPolling(GATFileStream fileStream, GATMetric metric, GATMetricEvent *event, GATuint32 *cookie); /** GATFileStream_RemoveRegisteredMetric * * The function GATFileStream_RemoveRegisteredMetric removes a GATMetricListener, * which was previously registered with GATFileStream_AddMetricListener. * * @param fileStream The GATFileStream 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 GATFileStream_RemoveRegisteredMetric(GATFileStream fileStream, GATMetric metric, GATuint32 cookie); /** GATFileStream_GetMetrics * * The function GATFileStream_GetMetrics returns a list of metrics supported by this * GATFileStream. * * @param fileStream The GATFileStream 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 GATFileStream_GetMetrics(GATFileStream_const fileStream, GATList_GATMetric *metrics); /* IStreamable implementation */ /* Reads from this GATStreamable into the given buffer */ GATResult GATFileStream_Read(GATFileStream object, void *buffer, GATuint32 size, GATuint32 *read_bytes); /* Writes data from the given Buffer through the GATStreamable */ GATResult GATFileStream_Write(GATFileStream object, void const *buffer, GATuint32 size, GATuint32 *written_bytes); /* Reposition the internal stream position */ GATResult GATFileStream_Seek(GATFileStream object, GATOrigin origin, GATint32 offset, GATuint32 *new_position); /* Closes this GATStreamable instance. */ GATResult GATFileStream_Close(GATFileStream object); #ifdef __cplusplus } #endif #endif /* _GATFILESTREAM_H_ */