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

GATFileStreamCPI.h Go to the documentation of this file. /** @file GATFileStreamCPI.h * Header for the GATFileStreamCPI class. * * A GATFileStreamCPI encapsulates all the methods that a GATFileStream capability * provider provides. * * @date $Date: 2004/04/01 17:21:28 $ * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATFileStreamCPI.h,v 1.6 2004/04/01 17:21:28 hartmutkaiser Exp $ * * Copyright (C) Kelly Davis * This 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 _GATFILESTREAMCPI_H_ #define _GATFILESTREAMCPI_H_ 1 typedef struct GATFileStreamCPI_S *GATFileStreamCPI; #include "GATType.h" #include "GATContext.h" #include "GATPreferences.h" #include "GATLocation.h" #include "GATMetricEvent.h" #include "GATMetric.h" #include "GATTime.h" #include "GATFileStream.h" #include "GATMonitorable.h" /* Versioning constants for the GATFileStreamCPI_Data struct */ #define GATFILESTREAMCPI_VERSION1 1 /* the newest version we know of */ #define GATFILESTREAMCPI_VERSION GATFILESTREAMCPI_VERSION1 /** * The @c #GATFileStreamCPI_Instance structure holds all data items supplied by the * client during the construction of the GATFileStream object. */ typedef struct { GATContext context; /* the GAT context to use for all GATFileStream operations */ GATLocation location; /* the location of the fileStream */ GATFileStreamMode mode; /* the mode in which to open the fileStream */ GATMonitorable_Impl monitorable; /* monitoring support */ GATObject_const source; /* the object this CPI is associated with */ void *instance_data; /* eventually supplied CPI provider instance data */ } GATFileStreamCPI_Instance; /* prototypes for the adapter callback functions */ typedef void (*GATFileStreamCPI_Adaptor_Destroy)(void *); typedef GATResult (*GATFileStreamCPI_Adaptor_ServiceActions)(void *, GATFileStreamCPI_Instance *, GATTimePeriod_const); /* instance specific functions */ typedef void (*GATFileStreamCPI_Adaptor_DestroyInstance)(void *, GATFileStreamCPI_Instance *); typedef GATResult (*GATFileStreamCPI_Adaptor_CreateInstance)(void *, GATFileStreamCPI_Instance *); typedef GATResult (*GATFileStreamCPI_Adaptor_CloneInstance)(void *, GATFileStreamCPI_Instance const *, GATFileStreamCPI_Instance *); typedef GATResult (*GATFileStreamCPI_Adaptor_EqualsInstance)(void *, GATFileStreamCPI_Instance const *, GATFileStreamCPI_Instance const *, GATBool *); /* CPI specific API */ typedef GATResult (*GATFileStreamCPI_Adaptor_Read)(void *, GATFileStreamCPI_Instance const *, void *, GATuint32, GATuint32 *); typedef GATResult (*GATFileStreamCPI_Adaptor_Write)(void *, GATFileStreamCPI_Instance const *, void const *, GATuint32, GATuint32 *); typedef GATResult (*GATFileStreamCPI_Adaptor_Seek)(void *, GATFileStreamCPI_Instance const *, GATOrigin, GATint32, GATuint32 *); typedef GATResult (*GATFileStreamCPI_Adaptor_Close)(void *, GATFileStreamCPI_Instance *); /* callback function prototypes for the GATMonitorable interface support */ typedef GATResult (* GATFileStreamCPI_Adaptor_GetMetrics)(void *, GATFileStreamCPI_Instance const *, GATList_GATMetric *); typedef GATResult (* GATFileStreamCPI_Adaptor_GetMetricEvent)(void *, GATFileStreamCPI_Instance const *, GATMetric, GATMetricEvent *); typedef struct { /* CPI data (type local data) */ void *data; GATFileStreamCPI_Adaptor_Destroy destroy; GATFileStreamCPI_Adaptor_ServiceActions service_actions; /* CPI instance data */ GATFileStreamCPI_Adaptor_CreateInstance create_instance; GATFileStreamCPI_Adaptor_DestroyInstance destroy_instance; GATFileStreamCPI_Adaptor_CloneInstance clone_instance; GATFileStreamCPI_Adaptor_EqualsInstance equals_instance; /* CPI functionality */ GATFileStreamCPI_Adaptor_Read read; GATFileStreamCPI_Adaptor_Write write; GATFileStreamCPI_Adaptor_Seek seek; GATFileStreamCPI_Adaptor_Close close; /* CPI monitoring support */ GATFileStreamCPI_Adaptor_GetMetrics get_metrics; GATFileStreamCPI_Adaptor_GetMetricEvent get_metric_event; } GATFileStreamCPI_Data; #ifdef __cplusplus extern "C" { #endif /* Adaptor API */ GATFileStreamCPI GATFileStreamCPI_Create(unsigned long int version, GATFileStreamCPI_Data *data); /* API internal to the GAT engine */ void GATFileStreamCPI_Destroy(GATFileStreamCPI *cpi); /* CPI instance specific functions */ GATResult GATFileStreamCPI_CreateInstance(GATFileStreamCPI cpi, GATFileStreamCPI_Instance *instance_data); void GATFileStreamCPI_DestroyInstance(GATFileStreamCPI cpi, GATFileStreamCPI_Instance *instance_data); GATResult GATFileStreamCPI_CloneInstance(GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *instance_data, GATFileStreamCPI_Instance *new_instance_data); GATResult GATFileStreamCPI_EqualsInstance(GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *lhs, GATFileStreamCPI_Instance const *rhs, GATBool *isequal); /* CPI specific API functions */ GATResult GATFileStreamCPI_Read(GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *data, void *buffer, GATuint32 size, GATuint32 *read_bytes); GATResult GATFileStreamCPI_Write(GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *data, void const *buffer, GATuint32 size, GATuint32 *written_bytes); GATResult GATFileStreamCPI_Seek(GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *data, GATOrigin origin, GATint32 offset, GATuint32 *new_position); GATResult GATFileStreamCPI_Close(GATFileStreamCPI cpi, GATFileStreamCPI_Instance *data ); /* GATMonitorable */ GATResult GATFileStreamCPI_GetMetrics(GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *data, GATList_GATMetric *metrics); GATResult GATFileStreamCPI_GetMetricEvent(GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *data, GATMetric metric, GATMetricEvent *event); #ifdef __cplusplus } #endif #endif /* _GATFILESTREAMCPI_H_ */