gateway.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 GATEWAY_H
#define GATEWAY_H

#include "azure_c_shared_utility/macro_utils.h"
#include "azure_c_shared_utility/vector.h"

#include "nanomsg/nn.h"

#include "module.h"
#include "module_loader.h"
#include "gateway_export.h"

#ifdef __cplusplus
extern "C"
{
#endif

#define GATEWAY_CONNECTION_ID_MAX           NN_SOCKADDR_MAX
#define GATEWAY_MESSAGE_VERSION_1           0x01
#define GATEWAY_MESSAGE_VERSION_CURRENT     GATEWAY_MESSAGE_VERSION_1

#define GATEWAY_ADD_LINK_RESULT_VALUES \
    GATEWAY_ADD_LINK_SUCCESS, \
    GATEWAY_ADD_LINK_ERROR, \
    GATEWAY_ADD_LINK_INVALID_ARG

DEFINE_ENUM(GATEWAY_ADD_LINK_RESULT, GATEWAY_ADD_LINK_RESULT_VALUES);

#define GATEWAY_START_RESULT_VALUES \
    GATEWAY_START_SUCCESS, \
    GATEWAY_START_INVALID_ARGS

DEFINE_ENUM(GATEWAY_START_RESULT, GATEWAY_START_RESULT_VALUES);

#define GATEWAY_UPDATE_FROM_JSON_RESULT_VALUES \
    GATEWAY_UPDATE_FROM_JSON_SUCCESS, \
    GATEWAY_UPDATE_FROM_JSON_ERROR, \
    GATEWAY_UPDATE_FROM_JSON_INVALID_ARG, \
    GATEWAY_UPDATE_FROM_JSON_MEMORY

DEFINE_ENUM(GATEWAY_UPDATE_FROM_JSON_RESULT, GATEWAY_UPDATE_FROM_JSON_RESULT_VALUES);


typedef struct GATEWAY_LINK_ENTRY_TAG
{
    const char* module_source;

    const char* module_sink;
} GATEWAY_LINK_ENTRY;

typedef struct GATEWAY_HANDLE_DATA_TAG* GATEWAY_HANDLE;

typedef struct GATEWAY_MODULE_LOADER_INFO_TAG
{
    const MODULE_LOADER* loader;

    void* entrypoint;
} GATEWAY_MODULE_LOADER_INFO;

typedef struct GATEWAY_MODULES_ENTRY_TAG
{
    const char* module_name;

    GATEWAY_MODULE_LOADER_INFO module_loader_info;

    const void* module_configuration;
} GATEWAY_MODULES_ENTRY;

typedef struct GATEWAY_PROPERTIES_DATA_TAG
{
    VECTOR_HANDLE gateway_modules;

    VECTOR_HANDLE gateway_links;
} GATEWAY_PROPERTIES;

GATEWAY_EXPORT GATEWAY_HANDLE Gateway_CreateFromJson(const char* file_path);



GATEWAY_EXPORT GATEWAY_UPDATE_FROM_JSON_RESULT Gateway_UpdateFromJson(GATEWAY_HANDLE gw, const char* json_content);

GATEWAY_EXPORT GATEWAY_HANDLE Gateway_Create(const GATEWAY_PROPERTIES* properties);

GATEWAY_EXPORT GATEWAY_START_RESULT Gateway_Start(GATEWAY_HANDLE gw);

GATEWAY_EXPORT void Gateway_Destroy(GATEWAY_HANDLE gw);

GATEWAY_EXPORT MODULE_HANDLE Gateway_AddModule(GATEWAY_HANDLE gw, const GATEWAY_MODULES_ENTRY* entry);

GATEWAY_EXPORT void Gateway_StartModule(GATEWAY_HANDLE gw, MODULE_HANDLE module);


GATEWAY_EXPORT void Gateway_RemoveModule(GATEWAY_HANDLE gw, MODULE_HANDLE module);

GATEWAY_EXPORT int Gateway_RemoveModuleByName(GATEWAY_HANDLE gw, const char *module_name);

GATEWAY_EXPORT GATEWAY_ADD_LINK_RESULT Gateway_AddLink(GATEWAY_HANDLE gw, const GATEWAY_LINK_ENTRY* entryLink);

GATEWAY_EXPORT void Gateway_RemoveLink(GATEWAY_HANDLE gw, const GATEWAY_LINK_ENTRY* entryLink);

#ifdef __cplusplus
}
#endif

#endif // GATEWAY_H