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

GATEndpointCPI.h Go to the documentation of this file. /** @file GATEndpointCPI.h * Header for the GATEndpointCPI class. * * A GATEndpointCPI encapsulates all the methods that a GATEndpoint capability * provider provides. * * @date $Date: 2004/03/24 19:30:58 $ * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATEndpointCPI.h,v 1.8 2004/03/24 19:30:58 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 _GATENDPOINTCPI_H_ #define _GATENDPOINTCPI_H_ 1 typedef struct GATEndpointCPI_S *GATEndpointCPI; #include "GATContext.h" #include "GATPreferences.h" #include "GATMetricEvent.h" #include "GATMetric.h" #include "GATTime.h" #include "GATEndpoint.h" #include "GATMonitorable.h" /* Versioning constants for the GATEndpointCPI_Data struct */ #define GATENDPOINTCPI_VERSION1 1 /* the newest version we know of */ #define GATENDPOINTCPI_VERSION GATENDPOINTCPI_VERSION1 /** * The @c #GATEndpointCPI_Instance structure holds all data items supplied by the * client during the construction of the GATEndpoint object. */ typedef struct { GATContext context; /* the GAT context to use for all GATEndpoint operations */ GATBool isdirty; /* dirty status for the whole object */ char *nodename; /* node name of this computer */ GATMonitorable_Impl monitorable; /* monitoring support */ GATObject_const source; /* the object this CPI is associated with */ void *instance_data; /* eventually supplied CPI provider instance data */ } GATEndpointCPI_Instance; /* prototypes for the adapter callback functions */ typedef void (*GATEndpointCPI_Adaptor_Destroy)(void *); typedef GATResult (*GATEndPointCPI_Adaptor_ServiceActions)(void *, GATEndpointCPI_Instance *, GATTimePeriod_const); /* instance specific functions */ typedef void (*GATEndpointCPI_Adaptor_DestroyInstance)(void *, GATEndpointCPI_Instance *); typedef GATResult (*GATEndpointCPI_Adaptor_CreateInstance)(void *, GATEndpointCPI_Instance *); typedef GATResult (*GATEndpointCPI_Adaptor_CloneInstance)(void *, GATEndpointCPI_Instance const *, GATEndpointCPI_Instance *); typedef GATResult (*GATEndpointCPI_Adaptor_EqualsInstance)(void *, GATEndpointCPI_Instance const *, GATEndpointCPI_Instance const *, GATBool *); /* Serialisation API */ typedef GATResult (*GATEndpointCPI_Adaptor_Serialise)(void *, GATEndpointCPI_Instance const *, GATObject, GATBool); typedef GATResult (*GATEndpointCPI_Adaptor_DeSerialise)(void *, GATObject, GATEndpointCPI_Instance *); /* CPI specific API */ typedef GATResult (*GATEndpointCPI_Adaptor_Connect)(void *, GATEndpointCPI_Instance const *, GATPipe *); typedef GATResult (*GATEndpointCPI_Adaptor_Listen)(void *, GATEndpointCPI_Instance const *, GATPipe *); typedef GATResult (*GATEndpointCPI_Adaptor_AddGATPipeListener)(void *, GATEndpointCPI_Instance const *, GATPipeListener, void *); /* callback function prototypes for the GATMonitorable interface support */ typedef GATResult (* GATEndpointCPI_Adaptor_GetMetrics)(void *, GATEndpointCPI_Instance const *, GATList_GATMetric *); typedef GATResult (* GATEndpointCPI_Adaptor_GetMetricEvent)(void *, GATEndpointCPI_Instance const *, GATMetric, GATMetricEvent *); typedef struct { /* CPI data (type local data) */ void *data; GATEndpointCPI_Adaptor_Destroy destroy; GATEndPointCPI_Adaptor_ServiceActions service_actions; /* CPI instance data */ GATEndpointCPI_Adaptor_CreateInstance create_instance; GATEndpointCPI_Adaptor_DestroyInstance destroy_instance; GATEndpointCPI_Adaptor_CloneInstance clone_instance; GATEndpointCPI_Adaptor_EqualsInstance equals_instance; /* CPI serialisation */ GATEndpointCPI_Adaptor_Serialise serialise; GATEndpointCPI_Adaptor_DeSerialise deserialise; /* CPI functionality */ GATEndpointCPI_Adaptor_Connect connect; GATEndpointCPI_Adaptor_Listen listen; GATEndpointCPI_Adaptor_AddGATPipeListener addPipeListener; /* CPI monitoring support */ GATEndpointCPI_Adaptor_GetMetrics get_metrics; GATEndpointCPI_Adaptor_GetMetricEvent get_metric_event; } GATEndpointCPI_Data; #ifdef __cplusplus extern "C" { #endif /* Adaptor API */ GATEndpointCPI GATEndpointCPI_Create(unsigned long int version, GATEndpointCPI_Data *data); /* API internal to the GAT engine */ void GATEndpointCPI_Destroy(GATEndpointCPI *cpi); /* CPI instance specific functions */ int GATEndpointCPI_CreateInstance(GATEndpointCPI cpi, GATEndpointCPI_Instance *instance_data); void GATEndpointCPI_DestroyInstance(GATEndpointCPI cpi, GATEndpointCPI_Instance *instance_data); GATResult GATEndpointCPI_CloneInstance(GATEndpointCPI cpi, GATEndpointCPI_Instance const *instance_data, GATEndpointCPI_Instance *new_instance_data); GATResult GATEndpointCPI_EqualsInstance(GATEndpointCPI cpi, GATEndpointCPI_Instance const *lhs, GATEndpointCPI_Instance const *rhs, GATBool *isequal); /* Serialisation API */ GATResult GATEndpointCPI_Serialise(GATEndpointCPI cpi, GATEndpointCPI_Instance const *data, GATObject stream, GATBool clear_dirty); GATResult GATEndpointCPI_DeSerialise(GATEndpointCPI cpi, GATObject stream, GATEndpointCPI_Instance *data); /* CPI specific API functions */ GATResult GATEndpointCPI_Connect(GATEndpointCPI cpi, GATEndpointCPI_Instance const *data, GATPipe *peep); GATResult GATEndpointCPI_Listen(GATEndpointCPI cpi, GATEndpointCPI_Instance const *data, GATPipe *peep); GATResult GATEndpointCPI_AddGATPipeListener(GATEndpointCPI cpi, GATEndpointCPI_Instance const *data, GATPipeListener pipeListener, void *listenerData); /* GATMonitorable */ GATResult GATEndpointCPI_GetMetrics(GATEndpointCPI cpi, GATEndpointCPI_Instance const *data, GATList_GATMetric *metrics); GATResult GATEndpointCPI_GetMetricEvent(GATEndpointCPI cpi, GATEndpointCPI_Instance const *data, GATMetric metric, GATMetricEvent *event); #ifdef __cplusplus } #endif #endif /* _GATENDPOINTCPI_H_ */