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

GATLogicalFile.h Go to the documentation of this file. /** @file GATLogicalFile.h * Header file for the GATLogicalFile class. * * @date Thu Oct 16 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATLogicalFile.h,v 1.18 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(_GATLOGICALFILE_H_) #define _GATLOGICALFILE_H_ #include "GATType.h" #include "GATList.h" #include "GATMonitorable.h" #ifdef __cplusplus extern "C" { #endif /* GATList_GATLogicalFile */ GATLIST_DECLARE_QUALIFIED(extern, GATFile, GATList_GATFile); /* Declare the converters to/from GATObject */ GATOBJECT_DECLARE_CONVERTERS(GATLogicalFile); /** GATLogicalFile_Create * The GATLogicalFile constructor. * This is the constructor for GATLogicalFile objects. * * @return A new GATLogicalFile */ GATLogicalFile GATLogicalFile_Create(GATContext context, GATLocation location, GATLogicalFileMode mode, GATPreferences_const preferences); /** GATLogicalFile_Destroy * The GATLogicalFile destructor. * This is the destructor for GATLogicalFile objects. * * @param this An old GATLogicalFile */ void GATLogicalFile_Destroy(GATLogicalFile *listhandle); /** int GATLogicalFile_Equals(GATLogicalFile_const lhs, GATLogicalFile_const rhs, GATBool *isequal) * @brief Compares two GATLogicalFile objects * * The function @c GATLogicalFile_Equals compares two file objects of type * @c #GATLogicalFile. * * @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 GATLogicalFile_Equals(GATLogicalFile_const lhs, GATLogicalFile_const rhs, GATBool *isequal); /** int GATLogicalFile_GetType(GATLogicalFile_const file) * @brief Return the type of the GATLogicalFile * * The function @c GATLogicalFile_GetType always returns GATType_GATLogicalFile. * * @param object The object to inspect * * @return returns always @c #GATType_GATLogicalFile. */ GATType GATLogicalFile_GetType(GATLogicalFile_const logfile); /** int GATLogicalFile_Clone(GATLogicalFile_const filehandle, GATLogicalFile *new_file) * @brief Clone the given GATLogicalFile * * The function @c GATLogicalFile_Clone generates a (deep) copy of the given * GATLogicalFile. * * @param filehandle The object to clone * @param new_file The pointer, through which the result is to be * returned. * * @return An error type. */ GATResult GATLogicalFile_Clone(GATLogicalFile_const logfile, GATLogicalFile *new_list); /** int GATLogicalFile_GetInterface(GATLogicalFile_const file, GATInterface iftype, void const **ifp) * @brief Get an interface supported by a GATLogicalFile * * The function GATLogicalFile_GetInterface allows to get a pointer to an * additional interface supported by this GATLogicalFile. * * @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 GATLogicalFile_GetInterface(GATLogicalFile_const file, GATInterface iftype, void const **ifp); /** int GATLogicalFile_AddFile(GATLogicalFile filehandle, GATFile target) * @brief Add a file to the logical file store. * * The function @c GATLogicalFile_AddFile adds the passed GATFile instance to * the set of physical files represented by this GATLogicalFile instance. * * @param filehandle The logfile to which the physical should be added. * @param target The physical file to be added to the logical file store. * * @return An error code. */ GATResult GATLogicalFile_AddFile(GATLogicalFile logfile, GATFile_const target); /** int GATLogicalFile_RemoveFile(GATLogicalFile filehandle, GATFile target) * @brief Remove a file from the logical file store * * The functions @c GATLogicalFile_RemoveFile removes the passed GATFile * instance from the set of physical files represented by this GATLogicalFile * instance. * * @param filehandle The logfile from which the physical should be removed. * @param target The physical file to be removed from the logical file store. * * @return An error code. */ GATResult GATLogicalFile_RemoveFile(GATLogicalFile logfile, GATFile_const target); /** int GATLogicalFile_Replicate(GATLogicalFile_const filehandle, GATLocation_const target) * @brief Replicate the logical file store * * The functions GATLogicalFile_Replicate replicates the logical file * represented by this instance to the physical file specified by the passed * GATLocation. * * @param filehandle The logfile from which the physical should be removed. * @param target The physical file to replicate the logical file store to. * * @return An error code. */ GATResult GATLogicalFile_Replicate(GATLogicalFile_const logfile, GATLocation_const target); /** int GATLogicalFile_GetFiles(GATLogicalFile_const logfile, GATList_GATFile *files) * @brief Get the list of files of a logical file store. * * The function GATLogicalFile_GetFiles returns a List of GATFile instances * each of which is a GATFile corresponding to a physical file represented by * this GATLogicalFile instance. * * @param filehandle The logfile from which the physical should be removed. * @param files The pointer to the variable, where the list of files is to be * returned to. * * @return An error code. */ GATResult GATLogicalFile_GetFiles(GATLogicalFile_const logfile, GATList_GATFile *files); /** int GATLogicalFile_Remove(GATLogicalFile filehandle) * @brief Removes the logical file store * * The functions @c GATLogicalFile_Remove removes the set of physical files * represented by this GATLogicalFile instance. All references to physical * files contained in this set are removed too. * * @param filehandle The logfile, which should be removed. * * @return An error code. */ GATResult GATLogicalFile_Remove(GATLogicalFile logfile); /* GATMonitorable API */ /** GATLogicalFile_AddMetricListener * * The function GATLogicalFile_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 file The GATLogicalFile 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 GATLogicalFile_AddMetricListener(GATLogicalFile file, GATMetricListener listener, void *listener_data, GATMetric metric, GATuint32 *cookie); /** GATLogicalFile_RegisterPolling * * The function GATLogicalFile_RegisterPolling registers a continuous * metric with the given GATFile instance. * * @param file The GATLogicalFile 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 GATLogicalFile. * * @return An error code. */ GATResult GATLogicalFile_RegisterPolling(GATLogicalFile file, GATMetric metric, GATMetricEvent *event, GATuint32 *cookie); /** GATLogicalFile_RemoveRegisteredMetric * * The function GATLogicalFile_RemoveRegisteredMetric removes a GATMetricListener, * which was previously registered with GATLogicalFile_AddMetricListener. * * @param file The GATLogicalFile instance to remove the GATMetricListener from. * @param listener The GTAMetricListener 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 GATLogicalFile_RemoveRegisteredMetric(GATLogicalFile file, GATMetric metric, GATuint32 cookie); /** GATLogicalFile_GetMetrics * * The function GATLogicalFile_GetMetrics returns a list of metrics supported * by this GATLogicalFile. * * @param file The GATLogicalFile 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 GATLogicalFile_GetMetrics(GATLogicalFile_const file, GATList_GATMetric *metrics); /* GATAdvertiseable API */ #define GATLOGICALFILE_VERSION1 0x0100 #define GATLOGICALFILE_LASTVERSION GATLOGICALFILE_VERSION1 #define GATLOGICALFILE_MINOR_MASK 0x00ff /** int GATLogicalFile_Serialise(GATLogicalFile file, GATObject stream, GATBool clear_dirty) * @brief Serialise a GATLogicalFile object * * The function GATLogicalFile_Serialise serialises the given GATLogicalFile * object into the given stream. * * @param file The GATLogicalFile object to serialise. * @param stream The stream interface to use for the serialisation. * @param clear_dirty If the clear_dirty parameter is set to GATTrue, the * internal dirty flag of this object is to be reset (no used here) * * @return An error code. */ GATResult GATLogicalFile_Serialise(GATLogicalFile file, GATObject stream, GATBool clear_dirty); /** GATLogicalFile GATLogicalFile_DeSerialise(GATContext context, GATObject stream, GATBool clear_dirty) * @brief De-serialise a GATLogicalFile object * * The function GATLogicalFile_DeSerialise de-serialises a streamed * GATLogicalFile object from the given stream It constructs a new instance * of the de-serialised object. * * @param context The GAT context to be used for object construction. * @param stream The stream interface to use for the serialisation. * @param result The pointer to a variable, which receives the status code of * the operation. * * @return The newly constructed GATLogicalFile object. */ GATLogicalFile GATLogicalFile_DeSerialise(GATContext context, GATObject stream, GATResult *result); /** GATLogicalFile_GetIsDirty * * The function GATLogicalFile_GetIsDirty retrieves the status of the dirty * flag of this GATLogicalFile object. * * @param file The GATLogicalFile object to inspect for its dirty status. * @param isdirty The pointer to a variable, which receives the dirty status. * * @return An error code. */ GATResult GATLogicalFile_GetIsDirty(GATLogicalFile_const file, GATBool *isdirty); #ifdef __cplusplus } #endif #endif /* !defined(_GATLOGICALFILE_H_) */