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

GATAdvertServiceCPI.c File Reference Source file for the GATAdvertServiceCPI class. More... #include <stdio.h> #include <stdlib.h> #include "GATErrors.h" #include "GATAdvertServiceCPI.h" Include dependency graph for GATAdvertServiceCPI.c: Go to the source code of this file. Compounds struct   GATAdvertServiceCPI_S Functions GATBool  GATAdvertServiceCPI_IsValidData_V1 (GATAdvertServiceCPI_Data *data) GATAdvertServiceCPI  GATAdvertServiceCPI_Create (unsigned long int version, GATAdvertServiceCPI_Data *data)   GATAdvertServiceCPI_Create The GATAdvertServiceCPI constructor. void  GATAdvertServiceCPI_Destroy (GATAdvertServiceCPI *object)   GATAdvertServiceCPI_Destroy The GATAdvertServiceCPI destructor. GATResult  GATAdvertServiceCPI_CreateInstance (GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance *instance_data)   GATAdvertServiceCPI_CreateInstance Create a new CPI object instance. void  GATAdvertServiceCPI_DestroyInstance (GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance *instance_data)   GATAdvertServiceCPI_DestroyInstance Create a new CPI object instance. GATResult  GATAdvertServiceCPI_EqualsInstance (GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance const *lhs, GATAdvertServiceCPI_Instance const *rhs, GATBool *isequal)   GATAdvertServiceCPI_EqualsInstance Compares two CPI object instances. GATResult  GATAdvertServiceCPI_CloneInstance (GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance const *instance_data, GATAdvertServiceCPI_Instance *new_instance_data)   GATAdvertServiceCPI_CloneInstance Clones a CPI object instance. GATResult  GATAdvertServiceCPI_GetMetrics (GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance const *data, GATList_GATMetric *metrics)   GATAdvertServiceCPI_GetMetrics. GATResult  GATAdvertServiceCPI_GetMetricEvent (GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance const *data, GATMetric metric, GATMetricEvent *event)   GATAdvertServiceCPI_GetMetricEvent. GATResult  GATAdvertServiceCPI_Add (GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance *instance_data, GATObject_const advertisable, GATTable_const metadata, GATString_const path)   GATAdvertServiceCPI_Add. GATResult  GATAdvertServiceCPI_Delete (GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance *instance_data, GATString_const path)   GATAdvertServiceCPI_Delete. GATResult  GATAdvertServiceCPI_GetMetaData (GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance const *instance_data, GATString_const path, GATTable *metadata)   GATAdvertServiceCPI_GetMetaData. GATResult  GATAdvertServiceCPI_GetAdvertisable (GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance const *instance_data, GATString_const path, GATObject *advertisable)   GATAdvertServiceCPI_GetAdvertisable. GATResult  GATAdvertServiceCPI_Find (GATAdvertServiceCPI cpi, GATAdvertServiceCPI_Instance const *instance_data, GATTable_const metadata, GATList_String *paths)   GATAdvertServiceCPI_Find. Variables const char *  rcsid = "$Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATAdvertServiceCPI.c,v 1.5 2004/04/02 12:31:57 hartmutkaiser Exp $" Detailed Description Source file for the GATAdvertServiceCPI class. Date: Fri Feb 13 2004 Version: Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATAdvertServiceCPI.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) Definition in file GATAdvertServiceCPI.c. Function Documentation GATBool GATAdvertServiceCPI_IsValidData_V1 (  GATAdvertServiceCPI_Data *    data )  [static]   Definition at line 370 of file GATAdvertServiceCPI.c. References GATAdvertServiceCPI_Data::add_entry, GATAdvertServiceCPI_Data::clone_instance, GATAdvertServiceCPI_Data::create_instance, data, GATAdvertServiceCPI_Data::delete_entry, GATAdvertServiceCPI_Data::destroy, GATAdvertServiceCPI_Data::destroy_instance, GATAdvertServiceCPI_Data::equals_instance, GATAdvertServiceCPI_Data::find_entries, GATFalse, GATTrue, GATAdvertServiceCPI_Data::get_advertisable, GATAdvertServiceCPI_Data::get_metadata, GATAdvertServiceCPI_Data::get_metric_event, and GATAdvertServiceCPI_Data::get_metrics. Referenced by GATAdvertServiceCPI_Create(). GATAdvertServiceCPI GATAdvertServiceCPI_Create (  unsigned long int    version, GATAdvertServiceCPI_Data *    data )    GATAdvertServiceCPI_Create The GATAdvertServiceCPI constructor. new_cpi is the constructor for GATAdvertServiceCPI objects. Parameters: version  Version of the GATAdvertServiceCPI_Data structure data  Pointer to adaptor CPI instance data structure. Returns: A new GATAdvertServiceCPI Definition at line 72 of file GATAdvertServiceCPI.c. References GATAdvertServiceCPI_S::add_entry, GATAdvertServiceCPI_Data::add_entry, GATAdvertServiceCPI_S::clone_instance, GATAdvertServiceCPI_Data::clone_instance, GATAdvertServiceCPI_S::create_instance, GATAdvertServiceCPI_Data::create_instance, data, GATAdvertServiceCPI_S::data, GATAdvertServiceCPI_Data::data, GATAdvertServiceCPI_S::delete_entry, GATAdvertServiceCPI_Data::delete_entry, GATAdvertServiceCPI_S::destroy, GATAdvertServiceCPI_Data::destroy, GATAdvertServiceCPI_S::destroy_instance, GATAdvertServiceCPI_Data::destroy_instance, GATAdvertServiceCPI_S::equals_instance, GATAdvertServiceCPI_Data::equals_instance, GATAdvertServiceCPI_S::find_entries, GATAdvertServiceCPI_Data::find_entries, GATAdvertServiceCPI_IsValidData_V1(), GATADVERTSERVICECPI_VERSION, GATTrue, GATAdvertServiceCPI_S::get_advertisable, GATAdvertServiceCPI_Data::get_advertisable, GATAdvertServiceCPI_S::get_metadata, GATAdvertServiceCPI_Data::get_metadata, GATAdvertServiceCPI_S::get_metric_event, GATAdvertServiceCPI_Data::get_metric_event, GATAdvertServiceCPI_S::get_metrics, GATAdvertServiceCPI_Data::get_metrics, GATAdvertServiceCPI_S::service_actions, and GATAdvertServiceCPI_Data::service_actions. Referenced by advertservice_adaptor_Register_GATAdvertServiceCPI(). void GATAdvertServiceCPI_Destroy (  GATAdvertServiceCPI *    object )    GATAdvertServiceCPI_Destroy The GATAdvertServiceCPI destructor. This is the destructor for GATAdvertServiceCPI objects. Parameters: this  An old GATAdvertServiceCPI Definition at line 134 of file GATAdvertServiceCPI.c. Referenced by advertservice_adaptor_Register_GATAdvertServiceCPI(). GATResult GATAdvertServiceCPI_CreateInstance (  GATAdvertServiceCPI    cpi, GATAdvertServiceCPI_Instance *    instance_data )    GATAdvertServiceCPI_CreateInstance Create a new CPI object instance. Calls the adaptor to create a new CPI object instance. Parameters: this  The CPI object. context  a GATContext instance_data  The instance data of the attached CPI object Returns: An error code. Definition at line 157 of file GATAdvertServiceCPI.c. References cpi, GATAdvertServiceCPI_S::create_instance, and GATAdvertServiceCPI_S::data. Referenced by GATAdvertService_Create(). void GATAdvertServiceCPI_DestroyInstance (  GATAdvertServiceCPI    cpi, GATAdvertServiceCPI_Instance *    instance_data )    GATAdvertServiceCPI_DestroyInstance Create a new CPI object instance. Calls the adaptor to destroy a CPI object instance. Parameters: this  The CPI object. instance_data  The instance data of the attached CPI object Definition at line 172 of file GATAdvertServiceCPI.c. References cpi, GATAdvertServiceCPI_S::data, and GATAdvertServiceCPI_S::destroy_instance. Referenced by GATAdvertService_Destroy(). GATResult GATAdvertServiceCPI_EqualsInstance (  GATAdvertServiceCPI    cpi, GATAdvertServiceCPI_Instance const *    lhs, GATAdvertServiceCPI_Instance const *    rhs, GATBool *    isequal )    GATAdvertServiceCPI_EqualsInstance Compares two CPI object instances. Calls the adaptor to compare two CPI object instances. Parameters: this  The CPI object. lhs  The instance data of the left CPI object rhs  The instance data of the right CPI object isequal  The pointer to the variable, where the result is to be returned to. Returns: An error code. Definition at line 192 of file GATAdvertServiceCPI.c. References cpi, GATAdvertServiceCPI_S::data, GATAdvertServiceCPI_S::equals_instance, and GATBool. Referenced by GATAdvertService_Equals(). GATResult GATAdvertServiceCPI_CloneInstance (  GATAdvertServiceCPI    cpi, GATAdvertServiceCPI_Instance const *    instance_data, GATAdvertServiceCPI_Instance *    new_instance_data )    GATAdvertServiceCPI_CloneInstance Clones a CPI object instance. Calls the adaptor to clone a CPI object instance. Parameters: this  The CPI object. instance_data  The instance data of the CPI object to clone. new_instance_data  The new instance data is to be returned here. Returns: An error code. Definition at line 211 of file GATAdvertServiceCPI.c. References GATAdvertServiceCPI_S::clone_instance, cpi, and GATAdvertServiceCPI_S::data. Referenced by GATAdvertService_Clone(). GATResult GATAdvertServiceCPI_GetMetrics (  GATAdvertServiceCPI    cpi, GATAdvertServiceCPI_Instance const *    data, GATList_GATMetric *    metrics )    GATAdvertServiceCPI_GetMetrics. The function GATAdvertServiceCPI_GetMetrics returns the list of metrics supported by this adaptor. Parameters: cpi  The CPI object. instance_data  The instance data of the attached CPI object The  pointer to the variable, which receives the resulting list of metrics. Returns: An error code. Definition at line 232 of file GATAdvertServiceCPI.c. References cpi, data, GATAdvertServiceCPI_S::data, and GATAdvertServiceCPI_S::get_metrics. Referenced by GATAdvertService_Create(). GATResult GATAdvertServiceCPI_GetMetricEvent (  GATAdvertServiceCPI    cpi, GATAdvertServiceCPI_Instance const *    data, GATMetric    metric, GATMetricEvent *    event )    GATAdvertServiceCPI_GetMetricEvent. The function GATAdvertServiceCPI_GetMetricEvent returns the metric event, which is associated with the given metric. Parameters: cpi  The CPI object. instance_data  The instance data of the attached CPI object metric  The continuous metric, for which the metric event is to be returned. event  The pointer to the variable, which receives the resulting metric event. Returns: An error code. Definition at line 253 of file GATAdvertServiceCPI.c. References cpi, data, GATAdvertServiceCPI_S::data, GATMetric, and GATAdvertServiceCPI_S::get_metric_event. Referenced by GATAdvertService_RegisterPolling(). GATResult GATAdvertServiceCPI_Add (  GATAdvertServiceCPI    cpi, GATAdvertServiceCPI_Instance *    instance_data, GATObject_const    advertisable, GATTable_const    metadata, GATString_const    path )    GATAdvertServiceCPI_Add. Calls the adaptor to add a new entry to the advert service. Parameters: this  The CPI object. instance_data  The instance data of the CPI object to add the entry to. advertisable  The advertisable object, which should be stored in the given advertservice. metadata  The meta data to rassociate with the newly created entry. path  The path inside the advert service, where the newly created entry is to be stored. Returns: An error code. Definition at line 276 of file GATAdvertServiceCPI.c. References GATAdvertServiceCPI_S::add_entry, cpi, GATAdvertServiceCPI_S::data, GATObject_const, GATString_const, and GATTable_const. Referenced by GATAdvertService_Add(). GATResult GATAdvertServiceCPI_Delete (  GATAdvertServiceCPI    cpi, GATAdvertServiceCPI_Instance *    instance_data, GATString_const    path )    GATAdvertServiceCPI_Delete. Calls the adaptor to delete an entry from the advert service. Parameters: this  The CPI object. instance_data  The instance data of the CPI object to delete the entry from. path  The path of the entry to delete from the given advert service. Returns: An error code. Definition at line 295 of file GATAdvertServiceCPI.c. References cpi, GATAdvertServiceCPI_S::data, GATAdvertServiceCPI_S::delete_entry, and GATString_const. Referenced by GATAdvertService_Delete(). GATResult GATAdvertServiceCPI_GetMetaData (  GATAdvertServiceCPI    cpi, GATAdvertServiceCPI_Instance const *    instance_data, GATString_const    path, GATTable *    metadata )    GATAdvertServiceCPI_GetMetaData. Calls the adaptor to retrieve the meta data of a given entry in the advert service. Parameters: this  The CPI object. instance_data  The instance data of the CPI object to get the meta data for a certain entry from. path  The path of the entry, for which the meta data should be retrieved. The  pointer to a variable, which receives the requested meta data. Returns: An error code. Definition at line 316 of file GATAdvertServiceCPI.c. References cpi, GATAdvertServiceCPI_S::data, GATString_const, and GATAdvertServiceCPI_S::get_metadata. Referenced by GATAdvertService_GetMetaData(). GATResult GATAdvertServiceCPI_GetAdvertisable (  GATAdvertServiceCPI    cpi, GATAdvertServiceCPI_Instance const *    instance_data, GATString_const    path, GATObject *    advertisable )    GATAdvertServiceCPI_GetAdvertisable. Calls the adaptor to retrieve the advertisable object stored in a given entry in the advert service. Parameters: this  The CPI object. instance_data  The instance data of the CPI object to get the advertised object for a certain entry from. path  The path of the entry, for which the stroed advertisable should be retrieved. advertisable  The pointer to a variable, which should receive the requested advertisable object. Returns: An error code. Definition at line 339 of file GATAdvertServiceCPI.c. References cpi, GATAdvertServiceCPI_S::data, GATString_const, and GATAdvertServiceCPI_S::get_advertisable. Referenced by GATAdvertService_GetAdvertisable(). GATResult GATAdvertServiceCPI_Find (  GATAdvertServiceCPI    cpi, GATAdvertServiceCPI_Instance const *    instance_data, GATTable_const    metadata, GATList_String *    paths )    GATAdvertServiceCPI_Find. Calls the adaptor to find a list of matching entries in the advert service. Parameters: this  The CPI object. instance_data  The instance data of the CPI object, where to find the matching entries. metadata  The meta data search criteria to use for the query. paths  The pointer to a variable, which should receive the list of paths pointing to matching entries inside the given advert service. Returns: An error code. Definition at line 360 of file GATAdvertServiceCPI.c. References cpi, GATAdvertServiceCPI_S::data, GATAdvertServiceCPI_S::find_entries, and GATTable_const. Referenced by GATAdvertService_Find(). Variable Documentation const char* rcsid = "$Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATAdvertServiceCPI.c,v 1.5 2004/04/02 12:31:57 hartmutkaiser Exp $" [static]   Definition at line 17 of file GATAdvertServiceCPI.c.