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

GATType.h Go to the documentation of this file. /** @file GATType.h * Header file defining an enum for the GATTypes. * * We need to distinguish between the types of various GAT objects * or primitive types at various points. This header file defines * an enum which can be used. * * @date Tue Sep 23 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATType.h,v 1.53 2004/04/28 10:50:10 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 _GATTYPE_H_ #define _GATTYPE_H_ 1 #include "xds.h" /* the GAT equivalent to a normal boolean type */ typedef enum { GATFalse = 0, GATTrue = 1 } GATBool; /* GAT Primitive Types */ typedef xds_int8_t GATint8; typedef xds_uint8_t GATuint8; typedef xds_int16_t GATint16; typedef xds_uint16_t GATuint16; typedef xds_int32_t GATint32; typedef xds_uint32_t GATuint32; typedef xds_float_t GATfloat32; typedef xds_double_t GATdouble64; /* 64bit Integral GAT Primitive Types */ #ifdef XDS_HAVE_64_BIT_SUPPORT typedef xds_int64_t GATint64; typedef xds_uint64_t GATuint64; #endif /* The error/result code type */ typedef GATint32 GATResult; /* forward declaration of all interface types */ /* GATObject handle */ typedef struct GATObject_S *GATObject; typedef struct GATObject_S const *GATObject_const; /* GATSerialise handle */ typedef struct GATSerialise_S *GATSerialise; typedef struct GATSerialise_S const *GATSerialise_const; /* GATStreamable handle */ typedef struct GATStreamable_S *GATStreamable; typedef struct GATStreamable_S const *GATStreamable_const; /* GATResource handle */ typedef struct GATResource_S *GATResource; typedef struct GATResource_S const *GATResource_const; /* GATMonitorable handle */ typedef struct GATMonitorable_S *GATMonitorable; typedef struct GATMonitorable_S const *GATMonitorable_const; /* GATMetricEvent handle */ typedef struct GATMetricEvent_S *GATMetricEvent; typedef struct GATMetricEvent_S const *GATMetricEvent_const; /* The GATObject_ISerialisable_vtable_S needs to be forward declared too */ struct GATObject_ISerialisable_vtable_S; /* forward declaration of all GATObject derived types */ /* GATRegistry handle */ typedef struct GATRegistry_S *GATRegistry; typedef struct GATRegistry_S const *GATRegistry_const; /* GATConfig handle */ typedef struct GATConfig_S *GATConfig; typedef struct GATConfig_S const *GATConfig_const; /* GATContext handle */ typedef struct GATContext_S *GATContext; typedef struct GATContext_S const *GATContext_const; /* GATAdvertService handle */ typedef struct GATAdvertService_S *GATAdvertService; typedef struct GATAdvertService_S const *GATAdvertService_const; /* GATFile handle */ typedef struct GATFile_S *GATFile; typedef struct GATFile_S const *GATFile_const; /* GATJob handle */ typedef struct GATJob_S *GATJob; typedef struct GATJob_S const *GATJob_const; /* GATJobDescription handle */ typedef struct GATJobDescription_S *GATJobDescription; typedef struct GATJobDescription_S const *GATJobDescription_const; /* GATLocation handle */ typedef struct GATLocation_S *GATLocation; typedef struct GATLocation_S const *GATLocation_const; /* GATLogicalFile handle */ typedef struct GATLogicalFile_S *GATLogicalFile; typedef struct GATLogicalFile_S const *GATLogicalFile_const; /* GATMemoryStream handle */ typedef struct GATMemoryStream_S *GATMemoryStream; typedef struct GATMemoryStream_S const *GATMemoryStream_const; /* GATMetric handle */ typedef struct GATMetric_S *GATMetric; typedef struct GATMetric_S const *GATMetric_const; /* GATPreferences handle */ typedef struct GATPreferences_S *GATPreferences; typedef struct GATPreferences_S const *GATPreferences_const; /* GATReservation handle */ typedef struct GATReservation_S *GATReservation; typedef struct GATReservation_S const *GATReservation_const; /* GATResourceBroker handle */ typedef struct GATResourceBroker_S *GATResourceBroker; typedef struct GATResourceBroker_S const *GATResourceBroker_const; /* GATResourceDescription handle */ typedef struct GATResourceDescription_S *GATResourceDescription; typedef struct GATResourceDescription_S const *GATResourceDescription_const; /* GATSoftwareResourceDescription handle */ /* No multiple decs typedef struct GATSoftwareResourceDescription_S * GATSoftwareResourceDescription; typedef struct GATSoftwareResourceDescription_S const * GATSoftwareResourceDescription_const; */ /* GATHardwareResourceDescription handle */ /* No multiple decs typedef struct GATHardwareResourceDescription_S * GATHardwareResourceDescription; typedef struct GATHardwareResourceDescription_S const * GATHardwareResourceDescription_const; */ /* GATSoftwareDescription handle */ typedef struct GATSoftwareDescription_S *GATSoftwareDescription; typedef struct GATSoftwareDescription_S const *GATSoftwareDescription_const; /* GATSoftwareResource handle */ typedef struct GATSoftwareResource_S *GATSoftwareResource; typedef struct GATSoftwareResource_S const *GATSoftwareResource_const; /* GATHardwareResource handle */ typedef struct GATHardwareResource_S *GATHardwareResource; typedef struct GATHardwareResource_S const *GATHardwareResource_const; /* GATStatus handle */ typedef struct GATStatus_S *GATStatus; typedef struct GATStatus_S const *GATStatus_const; /* GATString handle */ typedef struct GATString_S *GATString; typedef struct GATString_S const *GATString_const; /* GATTime handle */ typedef struct GATTime_S *GATTime; typedef struct GATTime_S const *GATTime_const; /* GATTable handle */ typedef struct GATTable_S *GATTable; typedef struct GATTable_S const *GATTable_const; /* GATTimePeriod handle */ typedef struct GATTimePeriod_S *GATTimePeriod; typedef struct GATTimePeriod_S const *GATTimePeriod_const; /* GATEndpoint handle */ typedef struct GATEndpoint_S *GATEndpoint; typedef struct GATEndpoint_S const *GATEndpoint_const; /* GATPipe handle */ typedef struct GATPipe_S *GATPipe; typedef struct GATPipe_S const *GATPipe_const; /* GATFileStream handle */ typedef struct GATFileStream_S *GATFileStream; typedef struct GATFileStream_S const *GATFileStream_const; /* The jobId uniquely identifies a concrete job */ typedef GATString GATJobID; typedef GATString_const GATJobID_const; /* GATSelf handle */ typedef struct GATSelf_S *GATSelf; typedef struct GATSelf_S const *GATSelf_const; /* GATRequest handle */ typedef struct GATRequest_S *GATRequest; typedef struct GATRequest_S const *GATRequest_const; /* GATRequestNotifier handle */ typedef struct GATRequestNotifier_S *GATRequestNotifier; typedef struct GATRequestNotifier_S const *GATRequestNotifier_const; /* GATSecurityContext handle */ typedef struct GATSecurityContext_S *GATSecurityContext; typedef struct GATSecurityContext_S const *GATSecurityContext_const; /* * Handle definitions for the GATList and GATListIterator */ typedef struct GATList_S *GATList; typedef struct GATList_S const *GATList_const; typedef struct GATListNode_S *GATListIterator; typedef struct GATListNode_S const *GATListIterator_const; /* GATMetricListener */ typedef GATResult (*GATMetricListener)(void *, GATMetricEvent); /* GATRequestListener */ typedef GATResult (*GATRequestListener)(void *, GATRequest_const); /* GATPipeListener */ typedef GATResult (*GATPipeListener)(void *, GATPipe); /** ErrorMessageHandler * * The ErrorMessageHandler function prototype is used for callbacks, which have * to be registered with the GATSelf_AddErrorMessageHandler. These callbacks * are called to get the textual representation of a specific error code (error * messages). * The engine decides, which callback function to call based on the facility * code (bits 16...27 of the error code value). This way every single adaptor * may define its own range of error values and can return the error message * corresponding to a 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. */ typedef GATResult (*GATErrorMessageHandler)(GATResult err_code, char *buffer, GATuint32 length, GATuint32 *written); /* the GATType enum holds all the different GAT types */ typedef enum { GATType_GATint16 = 1, GATType_GATint32 = 2, GATType_GATuint16 = 3, GATType_GATuint32 = 4, GATType_GATfloat32 = 5, GATType_GATdouble64 = 6, GATType_String = 7, GATType_PlainOldData = 8, GATType_GATObject = 0x00010000, /* this is actually a flag */ GATType_GATStatus = 0x00010020, GATType_GATList = 0x00010021, GATType_GATTable = 0x00010022, GATType_GATResourceDescription = 0x00010023, GATType_GATSoftwareResourceDescription = 0x00010024, GATType_GATHardwareResourceDescription = 0x00010025, GATType_GATFile = 0x00010026, GATType_GATLogicalFile = 0x00010027, GATType_GATLocation = 0x00010028, GATType_GATTime = 0x00010029, GATType_GATTimePeriod = 0x0001002A, GATType_GATSoftwareDescription = 0x0001002B, GATType_GATPreferences = 0x0001002C, GATType_GATString = 0x0001002D, GATType_GATResourceBroker = 0x0001002E, GATType_GATResource = 0x0001002F, GATType_GATSoftwareResource = 0x00010030, GATType_GATHardwareResource = 0x00010031, GATType_GATReservation = 0x00010032, GATType_GATJob = 0x00010033, GATType_GATJobDescription = 0x00010034, GATType_GATMemoryStream = 0x00010035, GATType_GATMetric = 0x00010036, GATType_GATMetricEvent = 0x00010037, GATType_GATMonitorable_Impl = 0x00010038, GATType_GATEndpoint = 0x00010039, GATType_GATPipe = 0x0001003A, GATType_GATFileStream = 0x0001003B, GATType_GATSelf = 0x0001003C, GATType_GATRequest = 0x0001003D, GATType_GATRequestNotifier = 0x0001003E, GATType_GATContext = 0x0001003F, GATType_GATErrorContext = 0x00010040, GATType_GATSecurityContext = 0x00010041, GATType_GATAdvertService = 0x00010042, GATType_GATRegistry = 0x00010043, GATType_NoType = ~0x0 } GATType; /* The GATInterface enum holds all the different interfaces GATObjects may support */ typedef enum { GATInterface_ISerialisable = 1, GATInterface_IResource = 2, GATInterface_IAdvertisable = 3, GATInterface_IStreamable = 4, GATInterface_IAsyncStreamable = 5, /* derived from IStreamable */ GATInterface_IMonitorable = 6, GATInterface_IMetricListener = 7 } GATInterface; /* The GATOrigin enum holds the origin from which to calculate the new seek-pointer location for the GATStreamable_Seek functionality */ typedef enum { GATOrigin_Set = 0, /* relative to the beginning of the stream. */ GATOrigin_Current = 1, /* relative to the current seek pointer location */ GATOrigin_End = 2 /* offset relative to the end of the stream */ } GATOrigin; /* Measurement type of the value associated with a GATMetric */ typedef enum { GATMeasurementType_Unknown = 0, GATMeasurementType_Continuous = 1, /* data is always available */ GATMeasurementType_EventLike = 2 /* data only becomes available when some external event happens */ } GATMeasurementType; /* Mode for creating a GATLogicalFile */ typedef enum { GATLogicalFileMode_Open = 0, /* open, if log file exists */ GATLogicalFileMode_Create = 1, /* create new, if log file does not exist */ GATLogicalFileMode_Truncate = 2, /* create new, if log file exists */ } GATLogicalFileMode; /* Mode for opening a GATFileStream */ typedef enum { GATFileStreamMode_Read = 0, /* Open file for reading. The stream is positioned at the beginning of the file. */ GATFileStreamMode_Write = 1, /* Open file for writing. The stream is positioned at the beginning of the file. */ GATFileStreamMode_Append = 2, /* Open file for appending. The stream is positioned at the end of the file. */ GATFileStreamMode_ReadWrite = 3 /* Open or create file for reading and writing. The stream is positioned at the beginning of the file. */ } GATFileStreamMode; /* Mode for copy and move operations on a GATFile */ typedef enum { GATFileMode_FailIfExists = 0, /* fail operation, if destination exists */ GATFileMode_Overwrite = 1, /* overwrite, if file exists */ } GATFileMode; /* The possible states of a GATJob */ typedef enum { GATJobState_Unknown = 0, GATJobState_Initial = 1, /* The GATJob instance has been submitted to an underlying resource management service but has not yet been submitted to a specific resource. */ GATJobState_Scheduled = 2, /* The GATJob instance has been submitted by an underlying resource management service to a resource, and the GATJob is scheduled to run. */ GATJobState_SubmissionError = 3, /* An error occurred when trying to submit this job, either to an underlying resource management service, or when such a service tried to submit to a queuing system or otherwise dispatch the job. A description of the error SHOULD be available from a GATStatus instance available by invoking the GetStatus operation. */ GATJobState_Running = 4, /* The process represented by the GATJob instance is being executed. */ GATJobState_Stopped = 5 /* The GATJob instance was running but is not currently running. That state can be reached by a successful call to the operation Stop, or due to the GATJob completing, or crashing. */ } GATJobState; /* The possible types of a GAT request */ typedef enum { GATRequestType_Command = 0, /* A GAT application specifies that it can perform some operation */ GATRequestType_Information = 1 /* A GAT application specifies that it can provide some information */ } GATRequestType; /* Possible GATSecurityContext types */ typedef enum { GATSecurityContextType_Password, GATSecurityContextType_Certificate, GATSecurityContextType_Remote } GATSecurityContextType; /* Function prototypes */ /** GATType_GetName * * The function GATType_GetName returns a string containing the readable * representation of the given GATType. * * @param type The type, for which the readble name should be returned. * * @return The readable name of the given GATType or NULL if the type * parameter doesn't refer to a known GATType. */ char const *GATType_GetName(GATType type); #endif /* _GATTYPE_H_ */