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

GATSelfCPI.c Go to the documentation of this file. /** @file GATSelfCPI.c * Source file for the GATSelfCPI class. * * @date Fri Jan 23 2004 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATSelfCPI.c,v 1.6 2004/04/05 11:49:44 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) */ static const char *rcsid = "$Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATSelfCPI.c,v 1.6 2004/04/05 11:49:44 hartmutkaiser Exp $"; /* System Header Files */ #include <stdio.h> #include <stdlib.h> /* GAT Header Files */ #include "GATErrors.h" #include "GATSelfCPI.h" /* Macros */ /* Structures, unions and enums */ struct GATSelfCPI_S { /* CPI data (type local data) */ void *data; GATSelfCPI_Adaptor_Destroy destroy; /* CPI instance data */ GATSelfCPI_Adaptor_ServiceActions service_actions; GATSelfCPI_Adaptor_CreateInstance create_instance; GATSelfCPI_Adaptor_DestroyInstance destroy_instance; /* CPI functionality */ GATSelfCPI_Adaptor_GetJob get_selfjob; GATSelfCPI_Adaptor_CreateRequestForListener create_requestforlistener; GATSelfCPI_Adaptor_DestroyRequestForListener destroy_requestforlistener; }; /* Static function prototypes */ static GATBool GATSelfCPI_IsValidData_V1(GATSelfCPI_Data *data); /* File scope variables */ /* External functions */ /** GATSelfCPI_Create * The GATSelfCPI constructor. * new_cpi is the constructor for GATSelfCPI objects. * * @param version Version of the GATSelfCPI_Data structure * @param data Pointer to adaptor CPI instance data structure. * * @return A new GATSelfCPI */ GATSelfCPI GATSelfCPI_Create(unsigned long int version, GATSelfCPI_Data *data) { GATSelfCPI new_cpi = NULL; if (version <= GATSELFCPI_VERSION) { if (version == GATSELFCPI_VERSION && GATTrue == GATSelfCPI_IsValidData_V1(data)) { new_cpi = (GATSelfCPI)malloc(sizeof(*new_cpi)); 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->get_selfjob = data->get_selfjob; new_cpi->create_requestforlistener = data->create_requestforlistener; new_cpi->destroy_requestforlistener = data->destroy_requestforlistener; } } /* add functionality for newer versions here else if (version == GATSELFCPI_VERSION2 && GATSelfCPI_IsValidData_V2(data)) { ... } */ else { /* Missing required functions */ /* error_code = GAT_INVALID_PARAMETER; */ new_cpi = NULL; } } else { /* unknown version */ /* error_code = GAT_UNKNOWN_VERSION; */ new_cpi = NULL; } return new_cpi; } /** GATSelfCPI_Destroy * @brief The GATSelfCPI destructor. * * This is the destructor for GATSelfCPI objects. * * @param this An old GATSelfCPI */ void GATSelfCPI_Destroy(GATSelfCPI *object) { if(NULL != object && NULL != *object) { /* call the adapter supplied destroy function */ (*object)->destroy((*object)->data); free(*object); *object = NULL; } } /* Instance specific functions */ /** GATSelfCPI_CreateInstance * @brief Create a new CPI object instance * * Calls the adaptor to create a new CPI object instance. * * @param this The CPI object. * @param context a GATContext * @param instance_data The instance data of the attached CPI object * * @return An error code. */ GATResult GATSelfCPI_CreateInstance(GATSelfCPI cpi, GATSelfCPI_Instance *instance_data) { return cpi->create_instance(cpi->data, instance_data); } /** GATSelfCPI_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 GATSelfCPI_DestroyInstance(GATSelfCPI cpi, GATSelfCPI_Instance *instance_data) { cpi->destroy_instance(cpi->data, instance_data); } /* CPI specific API */ /** GATSelfCPI_GetJob * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * * @return An error code. */ GATResult GATSelfCPI_GetJob(GATSelfCPI cpi, GATSelfCPI_Instance *instance_data, GATContext context, GATJob *job) { return cpi->get_selfjob(cpi->data, instance_data, context, job); } /** GATSelfCPI_CreateRequestForListener * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * * @return An error code. */ GATResult GATSelfCPI_CreateRequestForListener(GATSelfCPI cpi, GATSelfCPI_Instance *instance_data, GATContext context, GATRequestListener listener, void *data, GATRequestType type, GATTable_const parameters, const char *name, GATRequest *request) { return cpi->create_requestforlistener(cpi->data, instance_data, context, listener, data, type, parameters, name, request); } /** GATSelfCPI_DestroyRequestForListener * * @param this The CPI object. * @param instance_data The instance data of the attached CPI object * * @return An error code. */ GATResult GATSelfCPI_DestroyRequestForListener(GATSelfCPI cpi, GATSelfCPI_Instance *instance_data, GATContext context, GATRequest *request) { return cpi->destroy_requestforlistener(cpi->data, instance_data, context, request); } /* Local functions */ static GATBool GATSelfCPI_IsValidData_V1(GATSelfCPI_Data *data) { return ( NULL != data->destroy && NULL != data->create_instance && NULL != data->destroy_instance && NULL != data->get_selfjob && NULL != data->create_requestforlistener && NULL != data->destroy_requestforlistener ) ? GATTrue : GATFalse; }