AP_PluginCommon.h

Go to the documentation of this file.

/*
 * AP_PluginCommon.h
 *
 * $Copyright(c) 2002, 2004-2006, 2008-2009, 2012-2013 Progress Software Corporation (PSC). All rights reserved.$
 * $Copyright (c) 2013, 2016-2017, 2022 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.$
 * Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG
 *
 */

#ifndef APAMA_PLUGIN_COMMON_H
#define APAMA_PLUGIN_COMMON_H


#define AP_PLUGIN_MAJOR_VERSION_MASK  0xffff0000
#define AP_PLUGIN_MINOR_VERSION_MASK  0x0000ffff

#define AP_INIT_FUNCTION_NAME InitLibrary

#define AP_SHUTDOWN_FUNCTION_NAME ShutdownLibrary

#define AP_LIBRARY_VERSION_FUNCTION_NAME LibraryVersion

#define AP_PLUGIN_VERSION_FUNCTION_NAME PluginVersion
/* @deprecated
 * The name of the capabilities function which must be exported from a plugin library.
 * optional - implement if plugins need to be able to describe their capabilities
 */
#define AP_PLUGIN_GET_CAPABILITIES_FUNCTION_NAME PluginGetCapabilities 
/* @deprecated
 * The name of the thread ended function which must be exported from a plugin library.
 * optional - implement if need to free thread local storage. Not called on shutdown and called on thread that is ending
 */
#define AP_THREAD_ENDED_FUNCTION_NAME ThreadEnded

typedef enum {
        AP_NULL_TYPE,                   
        AP_CHUNK_TYPE,
        AP_INTEGER_TYPE,
        AP_FLOAT_TYPE,
        AP_BOOLEAN_TYPE,
        AP_STRING_TYPE,
        AP_SEQUENCE_TYPE,
        AP_DECIMAL_TYPE
} AP_TypeDiscriminator;


typedef enum {
        AP_NO_ERROR,
        AP_UNKNOWN_ERROR,
        AP_VERSION_MISMATCH_ERROR,
        AP_SERIALISATION_ERROR          // Chunk (de)serialisation failed
} AP_ErrorCode;



typedef enum {
        AP_CAPABILITIES_NONE = 0,
        AP_CAPABILITIES_NON_BLOCKING = 4
} AP_Capabilities;


#endif /* APAMA_PLUGIN_COMMON_H */