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

GATResourceCPIInstanceData.c Go to the documentation of this file. /** @file GATResourceCPIInstanceData.c * Source file for the GATResourceCPIInstance_Data class, which represents the * internal data stored by the ResourceCPI provider for the resource broker * adaptor. * * @date Thu Nov 27 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/adaptors/resourcebroker/GATResourceCPIInstanceData.c,v 1.5 2004/04/02 12:31:57 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/adaptors/resourcebroker/GATResourceCPIInstanceData.c,v 1.5 2004/04/02 12:31:57 hartmutkaiser Exp $"; /* System Header objects */ #include <string.h> /* GAT Header objects */ #include "GATResourceCPIInstanceData.h" /* Macros */ /* Structures, unions and enums */ /* Static function prototypes */ /* file scope variables */ /* External functions */ /** GATResourceCPIInstance_Data_Create * * The function GATResourceCPIInstance_Data_Create creates a new instance of * the internal GATResource data. * * @param rd The description of the GATResource to create. * * @return The pointer to the newly created and initialised data structure. */ GATResourceCPIInstance_Data * GATResourceCPIInstance_Data_Create(GATResourceDescription_const rd) { GATResult retval = GAT_SUCCESS; GATResourceCPIInstance_Data *result = (GATResourceCPIInstance_Data *)malloc(sizeof(struct GATResourceCPIInstance_Data)); if (NULL != result) { GATType type = GATResourceDescription_GetType(rd); memset(result, 0, sizeof(struct GATResourceCPIInstance_Data)); retval = GATResourceDescription_Clone(type, rd, &result->rd); if (GAT_FAILED(retval)) { free(result); result = NULL; } } return result; } /** GATResourceCPIInstance_Data_Destroy * * The function GATResourceCPIInstance_Data_Destroy is called to free all the * memory associated with the given instance data item. * * @param instance_data The pointer to a variable holding the old instance * data item, this is set to zero on exit. */ void GATResourceCPIInstance_Data_Destroy( GATResourceCPIInstance_Data **instance_data) { if (NULL != instance_data && NULL != *instance_data) { GATResourceDescription_Destroy(&(*instance_data)->rd); free(*instance_data); *instance_data = NULL; } } /** GATResourceCPIInstance_Data_Clone * * The function GATResourceCPIInstance_Data_Clone is called to make a copy of * the given instance data item. * * @param instance_data The instance data item to copy. * @param new_instance_Data The pointer to a variable, which receives the * newly created copy of the instance data item. * * @return An error code. */ GATResult GATResourceCPIInstance_Data_Clone( GATResourceCPIInstance_Data const *instance_data, GATResourceCPIInstance_Data **new_instance_data) { GATResult retval = GAT_INVALID_PARAMETER; if (NULL != new_instance_data) { GATResourceCPIInstance_Data *new_data = (GATResourceCPIInstance_Data *)malloc(sizeof(struct GATResourceCPIInstance_Data)); if (NULL != new_data) { GATType type = GATResourceDescription_GetType(instance_data->rd); retval = GATResourceDescription_Clone(type, instance_data->rd, &new_data->rd); if (GAT_FAILED(retval)) { free(new_data); } else { *new_instance_data = new_data; } } else { retval = GAT_MEMORYFAILURE; } } return retval; } /** GATResourceCPIInstance_Data_Equals * * The function GATResourceCPIInstance_Data_Equals is called, whenever the * engine needs to compare for equality two different instance data items. * * @param lhs The first instance data item to compare. * @param rhs The second instance data item to compare. * @param isequal The pointer to a variable, which receives the result of the * compare operation. * * @result An error code. */ GATResult GATResourceCPIInstance_Data_Equals( GATResourceCPIInstance_Data const *lhs, GATResourceCPIInstance_Data const *rhs, GATBool *isequal) { GATResult retval = GAT_INVALID_HANDLE; if (NULL != lhs && NULL != rhs) { retval = GATResourceDescription_Equals(lhs->rd, rhs->rd, isequal); } return retval; } /** GATResourceCPIInstance_Data_GetResourceDescription * * The function GATResourceCPIInstance_Data_GetResourceDescription may be used * to access the associated resource description of the target resource. * * @param instance_data The instance data item, for which the resource * description is to be retrieved. * @param description The pointer to a variable, which receives the resulting * resource description. * * @return An error code. */ GATResult GATResourceCPIInstance_Data_GetResourceDescription( GATResourceCPIInstance_Data const *instance_data, GATResourceDescription_const *description) { GATResult retval = GAT_INVALID_HANDLE; if (NULL != instance_data) { if (NULL != description) { *description = instance_data->rd; retval = GAT_SUCCESS; } else { retval = GAT_INVALID_PARAMETER; } } return retval; } /** GATResourceCPIInstance_Data_Serialize * * The function GATResourceCPIInstance_Data_Serialize is called by the engine, * whenever the instance specific data has to be serialised. The function * should serialise into the given stream all the instance specific data of * the object. * * @param instance_data The instance data item to serialise. * @param stream The stream to be used for serialisation of the instance data. * @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 GATResourceCPIInstance_Data_Serialize( GATResourceCPIInstance_Data const *instance_data, GATObject stream, GATBool clear_dirty) { GATResult retval = GAT_INVALID_HANDLE; if (NULL != instance_data) { retval = GATResourceDescription_Serialise(instance_data->rd, stream, clear_dirty); } return retval; } /** GATResourceCPIInstance_Data_DeSerialize * * The function GATResourceCPIInstance_Data_DeSerialize is called by the engine, * whenever the client requested a DeSerialise operation for * a corresponding object. The function should deserialise all the instance * specific data of the object from the given stream. * * @param context The GATContext to use to instantiate new GAT objects. * @param stream The stream to use to get the serialised data from. * @param instance_data The pointer to a variable, which receives the new * instance data deserialised from the given steam. * * @return An error code. */ GATResult GATResourceCPIInstance_Data_DeSerialize(GATContext context, GATObject stream, GATResourceCPIInstance_Data **instance_data) { GATResult retval = GAT_INVALID_HANDLE; if (NULL != instance_data) { GATResourceCPIInstance_Data *new_data = (GATResourceCPIInstance_Data *)malloc(sizeof(struct GATResourceCPIInstance_Data)); if (NULL != new_data) { memset(new_data, 0, sizeof(struct GATResourceCPIInstance_Data)); new_data->rd = GATResourceDescription_DeSerialise(context, stream, &retval); if (GAT_SUCCEEDED(retval)) { *instance_data = new_data; } else { GATResourceCPIInstance_Data_Destroy(&new_data); *instance_data = NULL; } } else { retval = GAT_MEMORYFAILURE; } } return retval; }