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

advertservice.c File Reference Source file for the GATAdvertServiceCPI provider class for the request adaptor. More... #include <stdio.h> #include <stdlib.h> #include <string.h> #include "GATCPI.h" #include "GATMemoryStream.h" #include "GATUtil.h" #include "advertservice.h" #include "advertservice_database.h" Include dependency graph for advertservice.c: Go to the source code of this file. Compounds struct   GATAdvertServiceCPIInstance_Data Typedefs typedef GATAdvertServiceCPIInstance_Data  GATAdvertServiceCPIInstance_Data Functions void  advertservice_adaptor_GATAdvertServiceCPI_Destroy (void *data) GATAdvertServiceCPIInstance_Data *  GATAdvertServiceCPIInstance_Data_Create (void)   GATAdvertServiceCPIInstance_Data_Create. void  GATAdvertServiceCPIInstance_Data_Destroy (GATAdvertServiceCPIInstance_Data **)   GATAdvertServiceCPIInstance_Data_Destroy. GATResult  GATAdvertServiceCPIInstance_Data_Clone (GATAdvertServiceCPIInstance_Data const *, GATAdvertServiceCPIInstance_Data **)   GATAdvertServiceCPIInstance_Data_Clone. GATResult  GATAdvertServiceCPIInstance_Data_Equals (GATAdvertServiceCPIInstance_Data const *, GATAdvertServiceCPIInstance_Data const *, GATBool *)   GATAdvertServiceCPIInstance_Data_Equals. GATResult  advertservice_adaptor_GATAdvertServiceCPI_ServiceActions (void *data, GATAdvertServiceCPI_Instance *instance_data, GATTimePeriod_const timeout)   advertservice_adaptor_GATAdvertServiceCPI_ServiceActions GATResult  advertservice_adaptor_GATAdvertServiceCPI_CreateInstance (void *data, GATAdvertServiceCPI_Instance *instance_data)   advertservice_adaptor_GATAdvertServiceCPI_CreateInstance Create a new CPI object instance. void  advertservice_adaptor_GATAdvertServiceCPI_DestroyInstance (void *data, GATAdvertServiceCPI_Instance *instance_data)   advertservice_adaptor_GATAdvertServiceCPI_DestroyInstance Destroy a CPI object instance. GATResult  advertservice_adaptor_GATAdvertServiceCPI_CloneInstance (void *data, GATAdvertServiceCPI_Instance const *instance_data, GATAdvertServiceCPI_Instance *new_instance_data)   advertservice_adaptor_GATAdvertServiceCPI_CloneInstance Clone a CPI object instance. GATResult  advertservice_adaptor_GATAdvertServiceCPI_EqualsInstance (void *data, GATAdvertServiceCPI_Instance const *lhs, GATAdvertServiceCPI_Instance const *rhs, GATBool *isequal)   advertservice_adaptor_GATAdvertServiceCPI_EqualsInstance Clone a CPI object instance. GATResult  advertservice_adaptor_GATAdvertServiceCPI_Add (void *, GATAdvertServiceCPI_Instance *, GATObject_const, GATTable_const, GATString_const)   advertservice_adaptor_GATAdvertServiceCPI_Add GATResult  advertservice_adaptor_GATAdvertServiceCPI_Delete (void *, GATAdvertServiceCPI_Instance *, GATString_const)   advertservice_adaptor_GATAdvertServiceCPI_Delete GATResult  advertservice_adaptor_GATAdvertServiceCPI_GetMetaData (void *, GATAdvertServiceCPI_Instance const *, GATString_const, GATTable *)   advertservice_adaptor_GATAdvertServiceCPI_GetMetaData GATResult  advertservice_adaptor_GATAdvertServiceCPI_GetAdvertisable (void *, GATAdvertServiceCPI_Instance const *, GATString_const, GATObject *)   advertservice_adaptor_GATAdvertServiceCPI_GetAdvertisable GATResult  advertservice_adaptor_GATAdvertServiceCPI_Find (void *, GATAdvertServiceCPI_Instance const *, GATTable_const, GATList_String *)   advertservice_adaptor_GATAdvertServiceCPI_Find GATResult  advertservice_adaptor_GATAdvertServiceCPI_GetMetrics (void *data, GATAdvertServiceCPI_Instance const *instance_data, GATList_GATMetric *metrics)   advertservice_adaptor_GATAdvertServiceCPI_GetMetrics GATResult  advertservice_adaptor_GATAdvertServiceCPI_GetMetricEvent (void *data, GATAdvertServiceCPI_Instance const *instance_data, GATMetric metric, GATMetricEvent *event)   advertservice_adaptor_GATAdvertServiceCPI_GetMetricEvent GATResult  advertservice_adapter_resolve_path (GATAdvertServiceCPI_Instance const *instance_data, GATString_const path, char **absolute)   advertservice_adapter_resolve_path GATResult  advertservice_adaptor_Register_GATAdvertServiceCPI (GATContext error_context, GATRegistry registry, GATTable_const system_config, GATTable_const instance_config, void *token) Variables const char *  rcsid = "$Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/adaptors/advertservice_adaptor/advertservice.c,v 1.13 2004/04/26 15:44:59 hartmutkaiser Exp $" Detailed Description Source file for the GATAdvertServiceCPI provider class for the request adaptor. TODO: Fill in the description of the new CPI provider here Date: Thu Mar 18 2004 Version: Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/adaptors/advertservice_adaptor/advertservice.c,v 1.13 2004/04/26 15:44:59 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 advertservice.c. Typedef Documentation typedef struct GATAdvertServiceCPIInstance_Data GATAdvertServiceCPIInstance_Data Function Documentation void advertservice_adaptor_GATAdvertServiceCPI_Destroy (  void *    data )  [static]   Definition at line 207 of file advertservice.c. References data. Referenced by advertservice_adaptor_Register_GATAdvertServiceCPI(). GATAdvertServiceCPIInstance_Data * GATAdvertServiceCPIInstance_Data_Create (  void    )  [static]   GATAdvertServiceCPIInstance_Data_Create. The function GATAdvertServiceCPIInstance_Data_Create creates a new instance of the internal CPI instance data. Returns: The pointer to the newly created and initialised data structure. Definition at line 674 of file advertservice.c. Referenced by advertservice_adaptor_GATAdvertServiceCPI_CreateInstance(). void GATAdvertServiceCPIInstance_Data_Destroy (  GATAdvertServiceCPIInstance_Data **    instance_data )  [static]   GATAdvertServiceCPIInstance_Data_Destroy. The function GATAdvertServiceCPIInstance_Data_Destroy is called to free all the memory associated with the given instance data item. Parameters: instance_data  The pointer to a variable holding the old instance data item, this is set to zero on exit. Definition at line 696 of file advertservice.c. Referenced by advertservice_adaptor_GATAdvertServiceCPI_DestroyInstance(). GATResult GATAdvertServiceCPIInstance_Data_Clone (  GATAdvertServiceCPIInstance_Data const *    instance_data, GATAdvertServiceCPIInstance_Data **    new_instance_data )  [static]   GATAdvertServiceCPIInstance_Data_Clone. The function GATAdvertServiceCPIInstance_Data_Clone is called to make a copy of the given instance data item. Parameters: instance_data  The instance data item to copy. new_instance_Data  The pointer to a variable, which receives the newly created copy of the instance data item. Returns: An error code. Definition at line 718 of file advertservice.c. References GAT_INVALID_PARAMETER, GAT_MEMORYFAILURE, GAT_SUCCESS, and GATResult. Referenced by advertservice_adaptor_GATAdvertServiceCPI_CloneInstance(). GATResult GATAdvertServiceCPIInstance_Data_Equals (  GATAdvertServiceCPIInstance_Data const *    lhs, GATAdvertServiceCPIInstance_Data const *    rhs, GATBool *    isequal )  [static]   GATAdvertServiceCPIInstance_Data_Equals. The function GATAdvertServiceCPIInstance_Data_Equals is called, whenever the engine needs to compare for equality two different instance data items. Parameters: lhs  The first instance data item to compare. rhs  The second instance data item to compare. isequal  The pointer to a variable, which receives the result of the compare operation. Returns: An error code. Definition at line 755 of file advertservice.c. References GAT_SUCCESS, GATBool, and GATTrue. Referenced by advertservice_adaptor_GATAdvertServiceCPI_EqualsInstance(). GATResult advertservice_adaptor_GATAdvertServiceCPI_ServiceActions (  void *    data, GATAdvertServiceCPI_Instance *    instance_data, GATTimePeriod_const    timeout )  [static]   advertservice_adaptor_GATAdvertServiceCPI_ServiceActions The function advertservice_adaptor_GATAdvertServiceCPI_ServiceActions is called, whenever the client calls GATContext_ServiceActions. This function is called for every created object. This function should be used to update all instance specific data, which may have been changed asynchronously or to fire pending events. Parameters: data  Adaptor-provided data object. instance_data  The instance data of this CPI object timeout  This may be a 0 timeout to indicate no timeout at all, or a specific time length. Returns: An error code. Definition at line 230 of file advertservice.c. References data, GAT_NOTIMPL, and GATTimePeriod_const. Referenced by advertservice_adaptor_Register_GATAdvertServiceCPI(). GATResult advertservice_adaptor_GATAdvertServiceCPI_CreateInstance (  void *    data, GATAdvertServiceCPI_Instance *    new_instance_data )  [static]   advertservice_adaptor_GATAdvertServiceCPI_CreateInstance Create a new CPI object instance. Adaptor implementation of create instance capability. Parameters: data  Adaptor-provided data object. context  The GATContext for this CPI instance target  The location of the file in question. new_instance_data  The pointer to the variable, where the instance data of this CPI object is to be returned to. Returns: An error code. Definition at line 249 of file advertservice.c. References advertservice_db_close(), advertservice_db_init(), GATAdvertServiceCPI_Instance::context, data, GAT_CREATE_STATUS, GAT_CREATE_STATUS_IF, GAT_INVALID_HANDLE, GAT_MEMORYFAILURE, GAT_RETURN_STATUS, GAT_USES_STATUS, GATAdvertServiceCPIInstance_Data_Create(), and GATAdvertServiceCPI_Instance::instance_data. Referenced by advertservice_adaptor_Register_GATAdvertServiceCPI(). void advertservice_adaptor_GATAdvertServiceCPI_DestroyInstance (  void *    data, GATAdvertServiceCPI_Instance *    instance_data )  [static]   advertservice_adaptor_GATAdvertServiceCPI_DestroyInstance Destroy a CPI object instance. Adaptor implementation of destroy instance capability. Parameters: data  Adaptor-provided data object. instance_data  The instance data of the CPI object to destroy. Definition at line 283 of file advertservice.c. References data, GATAdvertServiceCPIInstance_Data_Destroy(), and GATAdvertServiceCPI_Instance::instance_data. Referenced by advertservice_adaptor_Register_GATAdvertServiceCPI(). GATResult advertservice_adaptor_GATAdvertServiceCPI_CloneInstance (  void *    data, GATAdvertServiceCPI_Instance const *    instance_data, GATAdvertServiceCPI_Instance *    new_instance_data )  [static]   advertservice_adaptor_GATAdvertServiceCPI_CloneInstance Clone a CPI object instance. Adaptor implementation of the clone instance capability. Parameters: data  Adaptor-provided data object. instance_data  The instance data of this CPI object new_instance_data  The pointer to the variable, where the instance data of the cloned CPI object is to be returned to. Returns: An error code. Definition at line 302 of file advertservice.c. References GATAdvertServiceCPI_Instance::context, data, GAT_CREATE_STATUS, GAT_INVALID_HANDLE, GAT_INVALID_PARAMETER, GAT_RETURN_STATUS, GAT_USES_STATUS, GATAdvertServiceCPIInstance_Data_Clone(), and GATAdvertServiceCPI_Instance::instance_data. Referenced by advertservice_adaptor_Register_GATAdvertServiceCPI(). GATResult advertservice_adaptor_GATAdvertServiceCPI_EqualsInstance (  void *    data, GATAdvertServiceCPI_Instance const *    lhs, GATAdvertServiceCPI_Instance const *    rhs, GATBool *    isequal )  [static]   advertservice_adaptor_GATAdvertServiceCPI_EqualsInstance Clone a CPI object instance. Adaptor implementation of the clone instance capability. Parameters: data  Adaptor-provided data object. lhs  The instance data of the left CPI object. lhs  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 339 of file advertservice.c. References GATAdvertServiceCPI_Instance::context, data, GAT_CREATE_STATUS, GAT_INVALID_HANDLE, GAT_RETURN_STATUS, GAT_USES_STATUS, GATAdvertServiceCPIInstance_Data_Equals(), GATBool, and GATAdvertServiceCPI_Instance::instance_data. Referenced by advertservice_adaptor_Register_GATAdvertServiceCPI(). GATResult advertservice_adaptor_GATAdvertServiceCPI_Add (  void *    data, GATAdvertServiceCPI_Instance *    instance_data, GATObject_const    advertisable, GATTable_const    metadata, GATString_const    path )  [static]   advertservice_adaptor_GATAdvertServiceCPI_Add Add a new entry to the advert service. Parameters: data  The adaptor instance data. 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 376 of file advertservice.c. References advertservice_adapter_resolve_path(), advertservice_db_close(), advertservice_db_init(), advertservice_db_write_advert_data(), GATAdvertServiceCPI_Instance::context, data, GAT_CREATE_STATUS, GAT_CREATE_STATUS_IF, GAT_INVALID_HANDLE, GAT_MEMORYFAILURE, GAT_RETURN_STATUS, GAT_USES_STATUS, GATFalse, GATMemoryStream, GATMemoryStream_Create(), GATMemoryStream_Destroy(), GATMemoryStream_GetBuffer(), GATObject_const, GATSerialisable_Serialise(), GATString_const, GATTable_const, and GATuint32. Referenced by advertservice_adaptor_Register_GATAdvertServiceCPI(). GATResult advertservice_adaptor_GATAdvertServiceCPI_Delete (  void *    data, GATAdvertServiceCPI_Instance *    instance_data, GATString_const    path )  [static]   advertservice_adaptor_GATAdvertServiceCPI_Delete Delete an entry from the advert service. Parameters: data  The adaptor instance data. 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 431 of file advertservice.c. References advertservice_adapter_resolve_path(), advertservice_db_close(), advertservice_db_delete_advert_data(), advertservice_db_init(), GATAdvertServiceCPI_Instance::context, data, GAT_CREATE_STATUS, GAT_INVALID_HANDLE, GAT_RETURN_STATUS, GAT_USES_STATUS, and GATString_const. Referenced by advertservice_adaptor_Register_GATAdvertServiceCPI(). GATResult advertservice_adaptor_GATAdvertServiceCPI_GetMetaData (  void *    data, GATAdvertServiceCPI_Instance const *    instance_data, GATString_const    path, GATTable *    metadata )  [static]   advertservice_adaptor_GATAdvertServiceCPI_GetMetaData Retrieve the meta data of a given entry in the advert service. Parameters: data  The adaptor instance data. 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 472 of file advertservice.c. References advertservice_adapter_resolve_path(), advertservice_db_close(), advertservice_db_get_metadata(), advertservice_db_init(), GATAdvertServiceCPI_Instance::context, data, GAT_CREATE_STATUS, GAT_INVALID_HANDLE, GAT_RETURN_STATUS, GAT_USES_STATUS, and GATString_const. Referenced by advertservice_adaptor_Register_GATAdvertServiceCPI(). GATResult advertservice_adaptor_GATAdvertServiceCPI_GetAdvertisable (  void *    data, GATAdvertServiceCPI_Instance const *    instance_data, GATString_const    path, GATObject *    advertisable )  [static]   advertservice_adaptor_GATAdvertServiceCPI_GetAdvertisable Retrieve the advertisable object stored in a given entry in the advert service. Parameters: data  The adaptor instance data. 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 515 of file advertservice.c. References advertservice_adapter_resolve_path(), advertservice_db_close(), advertservice_db_get_advert_data(), advertservice_db_init(), GATAdvertServiceCPI_Instance::context, data, GAT_CREATE_STATUS, GAT_CREATE_STATUS_IF, GAT_CREATE_STATUS_UNCOND, GAT_CURRENT_STATUS, GAT_INVALID_HANDLE, GAT_INVALID_PARAMETER, GAT_MEMORYFAILURE, GAT_RETURN_STATUS, GAT_SUCCEEDED, GAT_SUCCESS, GAT_USES_STATUS, GATMemoryStream, GATMemoryStream_Create(), GATMemoryStream_Destroy(), GATObject_Destroy(), GATResult, GATSerialisable_DeSerialise(), GATString_const, and GATTrue. Referenced by advertservice_adaptor_Register_GATAdvertServiceCPI(). GATResult advertservice_adaptor_GATAdvertServiceCPI_Find (  void *    data, GATAdvertServiceCPI_Instance const *    instance_data, GATTable_const    metadata, GATList_String *    paths )  [static]   advertservice_adaptor_GATAdvertServiceCPI_Find Find a list of matching entries in the advert service. Parameters: data  The adaptor instance data. 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 587 of file advertservice.c. References advertservice_db_close(), advertservice_db_find(), advertservice_db_init(), GATAdvertServiceCPI_Instance::context, data, GAT_CREATE_STATUS, GAT_INVALID_HANDLE, GAT_RETURN_STATUS, GAT_USES_STATUS, and GATTable_const. Referenced by advertservice_adaptor_Register_GATAdvertServiceCPI(). GATResult advertservice_adaptor_GATAdvertServiceCPI_GetMetrics (  void *    data, GATAdvertServiceCPI_Instance const *    instance_data, GATList_GATMetric *    metrics )  [static]   advertservice_adaptor_GATAdvertServiceCPI_GetMetrics The function advertservice_adaptor_GATAdvertServiceCPI_GetMetrics should return a list of GATMetric objects supported by this adaptor. I.e. the adaptor is capable to fire GATMetricEvents for the returned metrics. This list should include all the supported metrics, event like and continuous ones. Parameters: data  Adaptor-provided data object. instance_data  Instance data for the CPI provider object. metrics  The pointer to the variable, which receives the returned list of metrics. Returns: An error code. Definition at line 626 of file advertservice.c. References data, and GAT_NOTIMPL. Referenced by advertservice_adaptor_Register_GATAdvertServiceCPI(). GATResult advertservice_adaptor_GATAdvertServiceCPI_GetMetricEvent (  void *    data, GATAdvertServiceCPI_Instance const *    instance_data, GATMetric    metric, GATMetricEvent *    event )  [static]   advertservice_adaptor_GATAdvertServiceCPI_GetMetricEvent The function advertservice_adaptor_GATAdvertServiceCPI_GetMetricEvent should return the GATMetricEvent associated with the given continuous metric. This function gets called for continuous metrics only, since returning the metric event object to the caller is th only way for the client to get access to it. Parameters: data  Adaptor-provided data object. instance_data  Instance data for the CPI provider object. metric  The metric instance describing the metric event to return. This metric should be equivalent to one of the metrics returned by our own GetMetrics CPI function (see above). If this is another (not known to us metric), an error should be returned. event  The pointer to the variable, which receives the metric event to return. Returns: An error code. Definition at line 654 of file advertservice.c. References data, GAT_SUCCESS, GATMetric, and GATResult. Referenced by advertservice_adaptor_Register_GATAdvertServiceCPI(). GATResult advertservice_adapter_resolve_path (  GATAdvertServiceCPI_Instance const *    instance_data, GATString_const    path, char **    absolute_path )  [static]   advertservice_adapter_resolve_path Definition at line 768 of file advertservice.c. References GAT_FAILED, GAT_INVALID_PARAMETER, GAT_MEMORYFAILURE, GAT_SUCCESS, GATResult, GATString_const, GATString_GetBuffer(), GATUtil_appendstring(), GATUtil_strdup(), and GATAdvertServiceCPI_Instance::pwd. Referenced by advertservice_adaptor_GATAdvertServiceCPI_Add(), advertservice_adaptor_GATAdvertServiceCPI_Delete(), advertservice_adaptor_GATAdvertServiceCPI_GetAdvertisable(), and advertservice_adaptor_GATAdvertServiceCPI_GetMetaData(). GATResult advertservice_adaptor_Register_GATAdvertServiceCPI (  GATContext    error_context, GATRegistry    registry, GATTable_const    system_config, GATTable_const    instance_config, void *    token )    Definition at line 131 of file advertservice.c. References GATAdvertServiceCPI_Data::add_entry, advertservice_adaptor_GATAdvertServiceCPI_Add(), advertservice_adaptor_GATAdvertServiceCPI_CloneInstance(), advertservice_adaptor_GATAdvertServiceCPI_CreateInstance(), advertservice_adaptor_GATAdvertServiceCPI_Delete(), advertservice_adaptor_GATAdvertServiceCPI_Destroy(), advertservice_adaptor_GATAdvertServiceCPI_DestroyInstance(), advertservice_adaptor_GATAdvertServiceCPI_EqualsInstance(), advertservice_adaptor_GATAdvertServiceCPI_Find(), advertservice_adaptor_GATAdvertServiceCPI_GetAdvertisable(), advertservice_adaptor_GATAdvertServiceCPI_GetMetaData(), advertservice_adaptor_GATAdvertServiceCPI_GetMetricEvent(), advertservice_adaptor_GATAdvertServiceCPI_GetMetrics(), advertservice_adaptor_GATAdvertServiceCPI_ServiceActions(), GATAdvertServiceCPI_Data::clone_instance, cpi, GATAdvertServiceCPI_Data::create_instance, GATAdvertServiceCPI_Data::data, GATAdvertServiceCPI_Data::delete_entry, GATAdvertServiceCPI_Data::destroy, GATAdvertServiceCPI_Data::destroy_instance, GATAdvertServiceCPI_Data::equals_instance, GATAdvertServiceCPI_Data::find_entries, GAT_CREATE_STATUS, GAT_CURRENT_STATUS, GAT_FAILED, GAT_MEMORYFAILURE, GAT_RETURN_STATUS, GAT_USES_STATUS, GATAdvertServiceCPI_Create(), GATAdvertServiceCPI_Destroy(), GATADVERTSERVICECPI_VERSION, GATPreferences_Add(), GATPreferences_Create(), GATPreferences_Destroy(), GATTable_const, GATAdvertServiceCPI_Data::get_advertisable, GATAdvertServiceCPI_Data::get_metadata, GATAdvertServiceCPI_Data::get_metric_event, GATAdvertServiceCPI_Data::get_metrics, GATAdvertServiceCPI_Data::service_actions, and token. Referenced by advertservice_adaptor_register(). Variable Documentation const char* rcsid = "$Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/adaptors/advertservice_adaptor/advertservice.c,v 1.13 2004/04/26 15:44:59 hartmutkaiser Exp $" [static]   Definition at line 20 of file advertservice.c.