cfgmgr.h

Go to the documentation of this file.

// Copyright (c) 2021 Intel Corporation.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
 
#include <ctype.h>
#include "eii/config_manager/kv_store_plugin/kv_store_plugin.h"
#include "eii/config_manager/cfgmgr_util.h"
 
#define PUBLISHERS "Publishers"
#define SUBSCRIBERS "Subscribers"
#define SERVERS "Servers"
#define CLIENTS "Clients"
#define SOCKET_FILE "socket_file"
#define ENDPOINT "EndPoint"
#define TOPICS "Topics"
#define NAME "Name"
#define ALLOWED_CLIENTS "AllowedClients"
#define TYPE "Type"
#define PUBLIC_KEYS "/Publickeys/"
#define PRIVATE_KEY "/private_key"
#define ZMQ_RECV_HWM "zmq_recv_hwm"
#define BROKER_APPNAME "BrokerAppName"
#define BROKERED "brokered"
#define PUBLISHER_APPNAME "PublisherAppName"
#define SERVER_APPNAME "ServerAppName"
 
#ifndef _EII_C_CONFIG_MGR_H
#define _EII_C_CONFIG_MGR_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct  {
 
    // Holds the list of /GlobalEnv var
    // to be set in the Go/Py/Cpp bindings
    char* env_var;
 
    // Application config
    config_t* app_config;
 
    // Application interface
    config_t* app_interface;
 
    // Application data store
    config_t* data_store;
 
    // Application AppName
    char* app_name;
 
    // Dev mode variable
    int dev_mode;
 
    // kv_store_client to call kv_store APIs
    kv_store_client_t* kv_store_client;
 
    // kv_store_handle to hold the kv_store object
    void* kv_store_handle;
 
} cfgmgr_ctx_t;
 
typedef struct {
 
    // Holds the interface specific
    // to a CFGMGR_PUBLISHER/CFGMGR_SUBSCRIBER/
    // CFGMGR_SERVER/CFGMGR_CLIENT
    config_value_t* interface;
 
    // Defines the type of interface
    cfgmgr_iface_type_t type;
 
    // Holds the cfgmgr context
    cfgmgr_ctx_t* cfg_mgr;
 
} cfgmgr_interface_t;
 
 
bool cfgmgr_is_dev_mode(cfgmgr_ctx_t* cfgmgr);
 
config_value_t* cfgmgr_get_appname(cfgmgr_ctx_t* cfgmgr);
 
config_t* cfgmgr_get_app_config(cfgmgr_ctx_t* cfgmgr);
 
config_t* cfgmgr_get_app_interface(cfgmgr_ctx_t* cfgmgr);
 
config_value_t* cfgmgr_get_app_config_value(cfgmgr_ctx_t* cfgmgr, const char* key);
 
config_value_t* cfgmgr_get_app_interface_value(cfgmgr_ctx_t* cfgmgr, const char* key);
 
config_t* cfgmgr_get_msgbus_config(cfgmgr_interface_t* ctx);
 
config_value_t* cfgmgr_get_endpoint(cfgmgr_interface_t* ctx);
 
config_value_t* cfgmgr_get_topics(cfgmgr_interface_t* ctx);
 
bool cfgmgr_set_topics(cfgmgr_interface_t* ctx, char const* const* topics_list, int len);
 
config_value_t* cfgmgr_get_allowed_clients(cfgmgr_interface_t* ctx);
 
int cfgmgr_get_num_publishers(cfgmgr_ctx_t* cfgmgr);
 
int cfgmgr_get_num_subscribers(cfgmgr_ctx_t* cfgmgr);
 
int cfgmgr_get_num_servers(cfgmgr_ctx_t* cfgmgr);
 
int cfgmgr_get_num_clients(cfgmgr_ctx_t* cfgmgr);
 
// cfgmgr callback type to be used in watch APIs
typedef kv_store_watch_callback_t cfgmgr_watch_callback_t;
 
void cfgmgr_watch(cfgmgr_ctx_t* cfgmgr, const char* key, cfgmgr_watch_callback_t watch_callback, void* user_data);
 
void cfgmgr_watch_prefix(cfgmgr_ctx_t* cfgmgr, char* prefix, cfgmgr_watch_callback_t watch_callback, void* user_data);
 
config_value_t* cfgmgr_get_interface_value(cfgmgr_interface_t* cfgmgr_interface, const char* key);
 
cfgmgr_interface_t* cfgmgr_get_publisher_by_name(cfgmgr_ctx_t* cfgmgr, const char* name);
 
cfgmgr_interface_t* cfgmgr_get_publisher_by_index(cfgmgr_ctx_t* cfgmgr, int index);
 
cfgmgr_interface_t* cfgmgr_get_subscriber_by_name(cfgmgr_ctx_t* cfgmgr, const char* name);
 
cfgmgr_interface_t* cfgmgr_get_subscriber_by_index(cfgmgr_ctx_t* cfgmgr, int index);
 
cfgmgr_interface_t* cfgmgr_get_server_by_name(cfgmgr_ctx_t* cfgmgr, const char* name);
 
cfgmgr_interface_t* cfgmgr_get_server_by_index(cfgmgr_ctx_t* cfgmgr, int index);
 
cfgmgr_interface_t* cfgmgr_get_client_by_name(cfgmgr_ctx_t* cfgmgr, const char* name);
 
cfgmgr_interface_t* cfgmgr_get_client_by_index(cfgmgr_ctx_t* cfgmgr, int index);
 
cfgmgr_ctx_t* cfgmgr_initialize();
 
void cfgmgr_destroy(cfgmgr_ctx_t *cfg_mgr);
 
cfgmgr_interface_t* cfgmgr_interface_initialize();
 
void cfgmgr_interface_destroy(cfgmgr_interface_t *cfg_mgr_interface);
 
#ifdef __cplusplus
}
#endif
 
#endif