module.h

Go to the documentation of this file.

// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

#ifndef MODULE_H
#define MODULE_H

typedef struct MODULE_TAG MODULE;

typedef void* MODULE_HANDLE;

typedef struct MODULE_API_TAG MODULE_API;

#include "azure_c_shared_utility/macro_utils.h"
#include "broker.h"
#include "message.h"


#ifdef __cplusplus
extern "C"
{
#endif

    struct MODULE_TAG
    {
        const MODULE_API* module_apis;
        MODULE_HANDLE module_handle;
    };

    typedef void*(*pfModule_ParseConfigurationFromJson)(const char* configuration);

    typedef void(*pfModule_FreeConfiguration)(void* configuration);

    typedef MODULE_HANDLE(*pfModule_Create)(BROKER_HANDLE broker, const void* configuration);

    typedef void(*pfModule_Destroy)(MODULE_HANDLE moduleHandle);

    typedef void(*pfModule_Receive)(MODULE_HANDLE moduleHandle, MESSAGE_HANDLE messageHandle);

    typedef void(*pfModule_Start)(MODULE_HANDLE moduleHandle);

    typedef enum MODULE_API_VERSION_TAG
    {
        MODULE_API_VERSION_1
    } MODULE_API_VERSION;

    static const MODULE_API_VERSION Module_ApiGatewayVersion = MODULE_API_VERSION_1;

    struct MODULE_API_TAG
    {
        MODULE_API_VERSION version;
    };

    typedef struct MODULE_API_1_TAG
    {
        MODULE_API base;

        pfModule_ParseConfigurationFromJson Module_ParseConfigurationFromJson;

        pfModule_FreeConfiguration Module_FreeConfiguration;

        pfModule_Create Module_Create;

        pfModule_Destroy Module_Destroy;

        pfModule_Receive Module_Receive;

        pfModule_Start Module_Start;
    } MODULE_API_1;

    typedef const MODULE_API* (*pfModule_GetApi)(MODULE_API_VERSION gateway_api_version);

#define MODULE_GETAPI_NAME ("Module_GetApi")

#ifdef _WIN32
#define MODULE_EXPORT __declspec(dllexport)
#else
#define MODULE_EXPORT
#endif // _WIN32

#define MODULE_STATIC_GETAPI(MODULE_NAME) C2(Module_GetApi_, MODULE_NAME)

MODULE_EXPORT const MODULE_API* Module_GetApi(MODULE_API_VERSION gateway_api_version);

#ifdef __cplusplus
}
#endif

#endif // MODULE_H