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

GATSelf.h Go to the documentation of this file. /** @file GATSelf.h * Header file for the GATSelf class. * * The GATSelf class corresponds to the current GAT job. There is * only ever one instance of this class, which is * obtained by the GetInstance method. This object can be used to * change various properties of this job, such as whether it is * checkpointable or not, and what metrics or events it can report. It * can also provide the GATJob instance associated with this * job, which may then be advertised. * * @date Tue Sep 2 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATSelf.h,v 1.15 2004/05/12 18:56:01 hartmutkaiser Exp $ * * Copyright (C) Tom Goodale * This file is part of the GAT Engine. * Contributed by Tom Goodale <goodale@aei.mpg.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) */ #ifndef _GATSELF_H_ #define _GATSELF_H_ 1 #include "GATContext.h" #include "GATJob.h" #include "GATRequest.h" #include "GATRegistry.h" #ifdef __cplusplus extern "C" { #endif /* Declare the converters to/from GATObject */ GATOBJECT_DECLARE_CONVERTERS(GATSelf); /** GATSelf_GetInstance * */ GATSelf_const GATSelf_GetInstance(GATContext context); /** GATSelf_AddRequestListener * */ GATResult GATSelf_AddRequestListener(GATContext context, GATRequestListener listener, void *data, GATRequestType type, GATTable_const parameters, const char *name, GATuint32 *cookie); /** GATSelf_RemoveRequestListener * */ GATResult GATSelf_RemoveRequestListener(GATContext context, GATuint32 cookie); /** GATSelf_GetJob * */ GATResult GATSelf_GetJob(GATContext context, GATJob *job); /** GATSelf_AddErrorMessageHandler * * The GATSelf_AddErrorMessageHandler function registeres the given callback * function with the engine. This callback function is used by the engine to * get the error message corresponding to a given error code. The callback * function is called for error codes belonging to the given facility (the * facility code is contained in the error code, namely bits 16...27). * * @param facility The facility code, for which this callback function has to * be called. * @param callback The callback function to call to get the error messages for * error codes belon ing to the given facility. * @param cookie The pointer to a variable, which receives a unique cookie * representing the registered function, which should be used to remove * the registration of this function later on. * * @return An error code. */ GATResult GATSelf_AddErrorMessageHandler(GATuint32 facility, GATErrorMessageHandler handler, GATuint32 *cookie); /** GATSelf_RemoveErrorMessageHandler * * The GATSelf_RemoveErrorMessageHandler function removes the registration of * the error message handler associated with the given cookie. */ GATResult GATSelf_RemoveErrorMessageHandler(GATuint32 *cookie); /** GATSelf_ResolveErrorMessage * * The function GATSelf_ResolveErrorMessage returns an error message * associated with the given error code. * * @param err_code The error code, for which the system needs to get the error * message. * @param buffer The buffer, where to return the resulting error message. * @param length The size of the given buffer. If this size is insufficient for * the error message to return, the error callback function should return * the required length in the written output parameter and it should * additionally return the GAT_BUFFER_TOO_SMALL return value to the * caller. * @param written The pointer to a variable, which should receive the real * size of the generated error message. * * @return An error code. */ GATResult GATSelf_ResolveErrorMessage(GATResult err_code, char *buffer, GATuint32 length, GATuint32 *written); #ifdef __cplusplus } #endif #endif /* _GATSELF_H_ */