GridLab
Grid Application Toolkit

A simple API for Grid Applications
GAT

Menu



Main Page   Alphabetical List   Compound List   File List   Compound Members   File Members  

GATRequestNotifier.c File Reference

Source file for the GATRequestNotifier class. More...

#include <stdlib.h>
#include <string.h>
#include "GAT.h"
#include "GATInternal.h"
#include "GATRequestNotifier.h"

Include dependency graph for GATRequestNotifier.c:

Include dependency graph

Go to the source code of this file.

Functions

 GATOBJECT_DEFINE_VTABLE (GATRequestNotifier)
 GATOBJECT_DEFINE_CONVERTERS (GATRequestNotifier) struct GATRequestNotifier_S
GATRequestNotifier GATRequestNotifier_Create (void *adaptor_data, GATRequestCPI_Instance const *instance_data, GATRequestNotifierListener listener, void *context_data)
 GATRequestNotifier_Create Create a new GATRequestNotifier object.

void GATRequestNotifier_Destroy (GATRequestNotifier *object)
 void GATRequestNotifier_Destroy(GATRequestNotifier *resource)

GATResult GATRequestNotifier_Equals (GATRequestNotifier_const lhs, GATRequestNotifier_const rhs, GATBool *isequal)
 GATRequestNotifier_Equals Compare two GATRequestNotifier objects.

GATResult GATRequestNotifier_Clone (GATRequestNotifier_const handle, GATRequestNotifier *new_handle)
 GATRequestNotifier_Clone Clone the given GATRequestNotifier.

GATType GATRequestNotifier_GetType (GATRequestNotifier_const object)
 GATType GATRequestNotifier_GetType(GATRequestNotifier_const resource) Return the type of the GATRequestNotifier.

GATResult GATRequestNotifier_GetInterface (GATRequestNotifier_const object, GATInterface iftype, void const **ifp)
 GATResult GATRequestNotifier_GetInterface(GATRequestNotifier_const file, GATInterface iftype, void const **ifp) Get an interface supported by a GATObject.

GATResult GATRequestNotifier_Respond (GATRequestNotifier_const notifier, GATTable table)
 GATRequestNotifier_Respond.


Variables

const char * rcsid = "$Header"
GATRequestNotifier_vtable GATRequestNotifier__vtable


Detailed Description

Source file for the GATRequestNotifier class.

TODO: Fill in the description of the new GAT object here

Date:
Fri Jan 30 2004
Version:
Header:
/export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATRequestNotifier.c,v 1.6 2004/04/02 12:31:58 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 GATRequestNotifier.c.


Function Documentation

GATOBJECT_DEFINE_VTABLE GATRequestNotifier   
 

GATOBJECT_DEFINE_CONVERTERS GATRequestNotifier   
 

Definition at line 34 of file GATRequestNotifier.c.

References GATRequestNotifier, and GATRequestNotifierListener.

GATRequestNotifier GATRequestNotifier_Create void *    adaptor_data,
GATRequestCPI_Instance const *    instance_data,
GATRequestNotifierListener    listener,
void *    context_data
 

GATRequestNotifier_Create Create a new GATRequestNotifier object.

The function GATRequestNotifier_Create creates a new GATRequestNotifier object

Parameters:
context  The GAT context to use while the initialisation of the new object.
preferences  The preferences to use while selecting the adaptor for the corresponding CPI.
Returns:
Returns a handle to the newly created GATRequestNotifier object. Returns 0 (zero) if an error occurs.

Definition at line 81 of file GATRequestNotifier.c.

References GAT_FAILED, GAT_MEMORYFAILURE, GAT_SUCCESS, GATRequestNotifier, GATRequestNotifier__vtable, GATRequestNotifier_Destroy(), GATRequestNotifierListener, and GATResult.

void GATRequestNotifier_Destroy GATRequestNotifier   object
 

void GATRequestNotifier_Destroy(GATRequestNotifier *resource)

The function GATRequestNotifier_Destroy is the destructor used to free all the memory allocated by an GATRequestNotifier instance.

Parameters:
description  The pointer to the GATRequestNotifier to destroy

Definition at line 119 of file GATRequestNotifier.c.

References GATRequestNotifier.

Referenced by GATRequest_Destroy(), GATRequest_GetRequestNotifier(), GATRequestNotifier_Create(), and resourcebroker_adaptor_GATRequestCPI_InitRequestNotifier().

GATResult GATRequestNotifier_Equals GATRequestNotifier_const    lhs,
GATRequestNotifier_const    rhs,
GATBool   isequal
 

GATRequestNotifier_Equals Compare two GATRequestNotifier objects.

The function GATRequestNotifier_Equals compares two objects of the GATRequestNotifier type.

Parameters:
lhs  The first list to compare
rhs  The second list to compare
isequal  The pointer to the GATBool variable, which should receive the result if the comparision
Returns:
An error code.

Definition at line 142 of file GATRequestNotifier.c.

References GAT_INVALID_HANDLE, GAT_INVALID_PARAMETER, GAT_SUCCESS, GATBool, GATFalse, GATRequestNotifier_const, and GATResult.

GATResult GATRequestNotifier_Clone GATRequestNotifier_const    handle,
GATRequestNotifier   new_handle
 

GATRequestNotifier_Clone Clone the given GATRequestNotifier.

The function GATRequestNotifier_Clone generates a (deep) copy of the given GATRequestNotifier.

Parameters:
description  The object to clone
new_object  The pointer, through which the result is to be returned.
Returns:
An error type.

Definition at line 172 of file GATRequestNotifier.c.

References GAT_INVALID_HANDLE, GAT_INVALID_PARAMETER, GAT_MEMORYFAILURE, GATRequestNotifier, GATRequestNotifier__vtable, GATRequestNotifier_const, GATResult, and handle.

GATType GATRequestNotifier_GetType GATRequestNotifier_const    object
 

GATType GATRequestNotifier_GetType(GATRequestNotifier_const resource) Return the type of the GATRequestNotifier.

The function GATRequestNotifier_GetType always returns #GATType_GATRequestNotifier.

Parameters:
object  The object to inspect
Returns:
Returns always #GATType_GATRequestNotifier.

Definition at line 219 of file GATRequestNotifier.c.

References GAT_UNUSED_PARAMETER, GATRequestNotifier_const, and GATType_GATRequestNotifier.

GATResult GATRequestNotifier_GetInterface GATRequestNotifier_const    object,
GATInterface    iftype,
void const **    ifp
 

GATResult GATRequestNotifier_GetInterface(GATRequestNotifier_const file, GATInterface iftype, void const **ifp) Get an interface supported by a GATObject.

The function GATRequestNotifier_GetInterface allows to get a pointer to an additional interface supported by this GATRequestNotifier.

Parameters:
object  The object to be asked for the new interface.
iftype  The interface the object is to be asked for.
ifp  The pointer, through which the result is to be returned.
Returns:
An error type.

Definition at line 238 of file GATRequestNotifier.c.

References GAT_INVALID_PARAMETER, GAT_NO_INTERFACE, GATInterface, GATRequestNotifier_const, and GATResult.

GATResult GATRequestNotifier_Respond GATRequestNotifier_const    notifier,
GATTable    table
 

GATRequestNotifier_Respond.

The function GATRequestNotifier_Respond finalises a GATRequest, passing any response information back to the invoker.

Parameters:
notifier  The request notifier associated with the request object to finalize.
table  Return Data containing any response data.
Returns:
An error code.

Definition at line 265 of file GATRequestNotifier.c.

References GAT_INVALID_HANDLE, GATRequestNotifier_const, and GATResult.

Referenced by on_checkpoint_issued_1().


Variable Documentation

const char* rcsid = "$Header" [static]
 

Definition at line 19 of file GATRequestNotifier.c.

GATRequestNotifier_vtable GATRequestNotifier__vtable
 

Initial value:

 {
  GATRequestNotifier_GetType,
  GATRequestNotifier_Destroy,
  GATRequestNotifier_Equals,
  GATRequestNotifier_Clone,
  GATRequestNotifier_GetInterface,
  0   
}

Definition at line 55 of file GATRequestNotifier.c.

Referenced by GATRequestNotifier_Clone(), and GATRequestNotifier_Create().