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.c Go to the documentation of this file. /** @file GATEndpointCPI.c * Main .c for the GATEndpointCPI class. * * A GATEndpointCPI encapsulates all the methods that a GATEndpoint capability * provider provides. * * @date $Date: 2004/04/02 12:31:57 $ * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATEndpointCPI.c,v 1.8 2004/04/02 12:31:57 hartmutkaiser Exp $ * * Copyright (C) Kelly Davis * This endpoint is part of the GAT Engine. * Contributed by Kelly Davis <kdavis@aei.mpg.de> and * 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) */ static const char *rcsid = "$Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATEndpointCPI.c,v 1.8 2004/04/02 12:31:57 hartmutkaiser Exp $"; /* System Header Files */ #include <stdio.h> #include <stdlib.h> /* GAT Header Files */ #include "GATEndpointCPI.h" /* Macros */ /* Structures, unions and enums */ struct GATEndpointCPI_S { /* 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; }; /* Static function prototypes */ static GATBool GATEndpointCPI_IsValidData_V1(GATEndpointCPI_Data *data); /* File scope variables */ /* External functions */ /** GATEndpointCPI_Create * The GATEndpointCPI constructor. * This is the constructor for GATEndpointCPI objects. * * @param version Version of the GATEndpointCPI_Data structure * @param data Pointer to adaptor CPI instance data structure. * * @return A new GATEndpointCPI */ GATEndpointCPI GATEndpointCPI_Create(unsigned long int version, GATEndpointCPI_Data *data) { GATEndpointCPI new_cpi = NULL; if (version <= GATENDPOINTCPI_VERSION) { if (version == GATENDPOINTCPI_VERSION && GATTrue == GATEndpointCPI_IsValidData_V1(data)) { new_cpi = (GATEndpointCPI)malloc(sizeof(struct GATEndpointCPI_S)); if(NULL != new_cpi) { new_cpi->data = data->data; new_cpi->destroy = data->destroy; new_cpi->service_actions = data->service_actions; new_cpi->destroy_instance = data->destroy_instance; new_cpi->create_instance = data->create_instance; new_cpi->equals_instance = data->equals_instance; new_cpi->clone_instance = data->clone_instance; new_cpi->serialise = data->serialise; new_cpi->deserialise = data->deserialise; new_cpi->connect = data->connect; new_cpi->listen = data->listen; new_cpi->addPipeListener = data->addPipeListener; new_cpi->get_metrics = data->get_metrics; new_cpi->get_metric_event = data->get_metric_event; } } /* add functionality for newer versions here else if (version == GATENDPOINTCPI_VERSION2 && GATEndpointCPI_IsValidData_V2(data)) { ... } */ else { /* Missing required functions */ /* error_code = GAT_INVALID_PARAMETER; */ } } else { /* unknown version */ /* error_code = GAT_UNKNOWN_VERSION; */ } return new_cpi; } /** GATEndpointCPI_Destroy * @brief The GATEndpointCPI destructor. * * This is the destructor for GATEndpointCPI objects. * * @param this An old GATEndpointCPI */ void GATEndpointCPI_Destroy(GATEndpointCPI *cpi) { if(NULL != cpi && NULL != *cpi) { (*cpi)->destroy((*cpi)->data); free(*cpi); *cpi = NULL; } } /** GATEndpointCPI_CreateInstance * @brief Create a new CPI object instance * * Calls the adaptor to create a new CPI object instance. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * * @return An error code. */ GATResult GATEndpointCPI_CreateInstance(GATEndpointCPI cpi, GATEndpointCPI_Instance *data) { return cpi->create_instance(cpi->data, data); } /** GATEndpointCPI_DestroyInstance * @brief Create a new CPI object instance * * Calls the adaptor to destroy a CPI object instance. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object */ void GATEndpointCPI_DestroyInstance(GATEndpointCPI cpi, GATEndpointCPI_Instance *data) { cpi->destroy_instance(cpi->data, data); } /** GATEndpointCPI_EqualsInstance * @brief Compares two CPI object instances. * * Calls the adaptor to compare two CPI object instances. * * @param this The CPI object. * @param lhs The instance data of the left CPI object * @param rhs The instance data of the right CPI object * @param isequal The pointer to the variable, where the result is to be * returned to. * * @return An error code. */ GATResult GATEndpointCPI_EqualsInstance(GATEndpointCPI cpi, GATEndpointCPI_Instance const *lhs, GATEndpointCPI_Instance const *rhs, GATBool *isequal) { return cpi->equals_instance(cpi->data, lhs, rhs, isequal); } /** GATEndpointCPI_CloneInstance * @brief Clones a CPI object instance. * * Calls the adaptor to clone a CPI object instance. * * @param this The CPI object. * @param instance_data The instance data of the CPI object to clone. * @param rhs The new instance data is to be returned here. * * @return An error code. */ GATResult GATEndpointCPI_CloneInstance(GATEndpointCPI cpi, GATEndpointCPI_Instance const *data, GATEndpointCPI_Instance *new_data) { return cpi->clone_instance(cpi->data, data, new_data); } /** GATEndpointCPI_Serialise * @brief Serialise the instance data. * * Calls the adaptor to serialise the instance data. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * @param stream The stream to use be used for serialisation. * @param clear_dirty If the clear_dirty parameter is set to GATTrue, the * internal dirty flag of this object is to be reset. * * @return An error code. */ GATResult GATEndpointCPI_Serialise(GATEndpointCPI cpi, GATEndpointCPI_Instance const *data, GATObject stream, GATBool clear_dirty) { return cpi->serialise(cpi->data, data, stream, clear_dirty); } /** GATEndpointCPI_DeSerialise * @brief De-serialise the instance data * * Call the adaptor to de-serialise the instance data. * * @param context The GAT context to be used for object construction. * @param stream The stream interface to use for the serialisation. * @param instance_data The pointer to a variable, which contains the client * data of the new object. The member instance data of this object * may receive the pointer to the new instance data of the CPI object. * * @return An error code. */ GATResult GATEndpointCPI_DeSerialise(GATEndpointCPI cpi, GATObject stream, GATEndpointCPI_Instance *data) { return cpi->deserialise(cpi->data, stream, data); } /** GATEndpointCPI_Connect * @brief Connect a client's endpoint. * * Calls the adaptor to connect a client's endpoint. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * @param peep The connected GATPipe * * @return An error code. */ GATResult GATEndpointCPI_Connect(GATEndpointCPI cpi, GATEndpointCPI_Instance const *data, GATPipe *peep) { return cpi->connect(cpi->data, data, peep); } /** GATEndpointCPI_Listen * @brief Connect a server's endpoint. * * Calls the adaptor to connect a server's endpoint. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * @param peep The connected GATPipe * * @return An error code. */ GATResult GATEndpointCPI_Listen(GATEndpointCPI cpi, GATEndpointCPI_Instance const *data, GATPipe *peep) { return cpi->listen(cpi->data, data, peep); } /** GATEndpointCPI_AddGATPipeListener * @brief Add a GATPipeListener to this endpoint. * * Calls the adaptor to add a GATPipeListener to this endpoint. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * @param pipeListener The to be added GATPipeListener * @param listenerData Callback data * * @return An error code. */ GATResult GATEndpointCPI_AddGATPipeListener(GATEndpointCPI cpi, GATEndpointCPI_Instance const *data, GATPipeListener pipeListener, void *listenerData) { return cpi->addPipeListener(cpi->data, data, pipeListener, listenerData); } /** GATEndpointCPI_GetMetrics * * The function GATEndpointCPI_GetMetrics returns the list of metrics supported * by this adaptor. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * @param The pointer to the variable, which receives the resulting list of * metrics. * * @return An error code. */ GATResult GATEndpointCPI_GetMetrics(GATEndpointCPI cpi, GATEndpointCPI_Instance const *data, GATList_GATMetric *metrics) { return cpi->get_metrics(cpi->data, data, metrics); } /** GATEndpointCPI_GetMetricEvent * * The function GATEndpointCPI_GetMetricEvent returns the metric event, which is * associated with the given metric. * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * @param metric The continuous metric, for which the metric event is to be * returned. * @param event The pointer to the variable, which receives the resulting * metric event. * * @return An error code. */ GATResult GATEndpointCPI_GetMetricEvent(GATEndpointCPI cpi, GATEndpointCPI_Instance const *data, GATMetric metric, GATMetricEvent *event) { return cpi->get_metric_event(cpi->data, data, metric, event); } /* Local functions */ static GATBool GATEndpointCPI_IsValidData_V1(GATEndpointCPI_Data *data) { return ( NULL != data->destroy && // NULL != data->service_actions && NULL != data->destroy_instance && NULL != data->create_instance && NULL != data->clone_instance && NULL != data->equals_instance && NULL != data->serialise && NULL != data->deserialise && NULL != data->connect && NULL != data->listen && NULL != data->addPipeListener && NULL != data->get_metrics && NULL != data->get_metric_event ) ? GATTrue : GATFalse; }