/*
 * Copyright (c) 2017-2019 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file configuration.h
 * @brief hicn-light configuration, such as in-band commands or CLI
 *
 * Manages all user configuration of the system, such as from the CLI or web
 * interface It remembers the user commands and will be able to write out a
 * config file.
 *
 */

#ifndef configuration_h
#define configuration_h

#include <src/utils/commands.h>
#include <src/core/logger.h>

struct configuration;
typedef struct configuration Configuration;

struct forwarder;
typedef struct forwarder Forwarder;

/**
 * <#One Line Description#>
 *
 * <#Paragraphs Of Explanation#>
 *
 * @param [<#in out in,out#>] <#name#> <#description#>
 *
 * @retval <#value#> <#explanation#>
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
Configuration *configuration_Create(Forwarder *forwarder);

/**
 * <#One Line Description#>
 *
 * <#Paragraphs Of Explanation#>
 *
 * @param [<#in out in,out#>] <#name#> <#description#>
 *
 * @retval <#value#> <#explanation#>
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
void configuration_Destroy(Configuration **configPtr);

void configuration_SetupAllListeners(Configuration *config, uint16_t port,
                                     const char *localPath);

void configuration_ReceiveCommand(Configuration *config, command_id command,
                                  struct iovec *request, unsigned ingressId);

/**
 * Returns the configured size of the content store
 *
 * <#Paragraphs Of Explanation#>
 *
 * @param [<#in out in,out#>] <#name#> <#description#>
 *
 * @retval <#value#> <#explanation#>
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
size_t configuration_GetObjectStoreSize(Configuration *config);

/**
 * Sets the size of the content store (in objects, not bytes)
 *
 * Must be set before starting the forwarder
 *
 * @param [<#in out in,out#>] <#name#> <#description#>
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
void configuration_SetObjectStoreSize(Configuration *config,
                                      size_t maximumContentObjectCount);

strategy_type configuration_GetForwardingStrategy(Configuration *config,
                                                  const char *prefix);

/**
 * Returns the Forwarder that owns the Configuration
 *
 * Returns the hicn-light Forwarder.  Used primarily by associated classes in
 * the configuration group.
 *
 * @param [in] config An allocated Configuration
 *
 * @return non-null The owning Forwarder
 * @return null An error
 *
 * Example:
 * @code
 * {
 *     <#example#>
 * }
 * @endcode
 */
Forwarder *configuration_GetForwarder(const Configuration *config);

/**
 * Returns the logger used by the Configuration subsystem
 *
 * Returns the logger specified when the Configuration was created.
 *
 * @param [in] config An allocated Configuration
 *
 * @retval non-null The logger
 * @retval null An error
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
Logger *configuration_GetLogger(const Configuration *config);

struct iovec *configuration_DispatchCommand(Configuration *config,
                                            command_id command,
                                            struct iovec *control,
                                            unsigned ingressId);

#endif  // configuration_h