AWS IoT Device Client
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Static Private Member Functions | List of all members
Aws::Iot::DeviceClient::Config Class Reference

Public Types

enum  ConfigFileType { DEVICE_CLIENT_ESSENTIAL_CONFIG , FLEET_PROVISIONING_RUNTIME_CONFIG , HTTP_PROXY_CONFIG }
 Enum defining several config file types.
 

Public Member Functions

bool ValidateAndStoreRuntimeConfig ()
 
bool ValidateAndStoreHttpProxyConfig () const
 
bool ParseConfigFile (const std::string &file, ConfigFileType configFileType)
 
bool init (const CliArgs &cliArgs)
 

Static Public Member Functions

static bool CheckTerminalArgs (int argc, char *argv[])
 
static bool ParseCliArgs (int argc, char *argv[], CliArgs &cliArgs)
 
static std::string ExpandDefaultConfigDir (bool removeTrailingSeparator=false)
 Use path expansion to return absolute path to device client default configuration directory. More...
 

Public Attributes

PlainConfig config
 

Static Public Attributes

static constexpr char TAG [] = "Config.cpp"
 
static constexpr char DEFAULT_CONFIG_DIR [] = "~/.aws-iot-device-client/"
 
static constexpr char DEFAULT_KEY_DIR [] = "~/.aws-iot-device-client/keys/"
 
static constexpr char DEFAULT_CONFIG_FILE [] = "~/.aws-iot-device-client/aws-iot-device-client.conf"
 
static constexpr char DEFAULT_FLEET_PROVISIONING_RUNTIME_CONFIG_FILE []
 
static constexpr char DEFAULT_HTTP_PROXY_CONFIG_FILE [] = "~/.aws-iot-device-client/http-proxy.conf"
 
static constexpr char DEFAULT_SAMPLE_SHADOW_OUTPUT_DIR [] = "~/.aws-iot-device-client/sample-shadow/"
 
static constexpr char DEFAULT_SAMPLE_SHADOW_DOCUMENT_FILE [] = "default-sample-shadow-document"
 
static constexpr char CLI_HELP [] = "--help"
 
static constexpr char CLI_VERSION [] = "--version"
 
static constexpr char CLI_EXPORT_DEFAULT_SETTINGS [] = "--export-default-settings"
 
static constexpr char CLI_CONFIG_FILE [] = "--config-file"
 
static constexpr size_t MAX_CONFIG_SIZE = 5000
 Maximum accepted size for the config file.
 
static constexpr char PATH_DIRECTORY_SEPARATOR = '/'
 Separator between directories in path.
 

Static Private Member Functions

static void PrintHelpMessage ()
 
static void PrintVersion ()
 
static bool ExportDefaultSetting (const std::string &file)
 

Member Function Documentation

◆ ExpandDefaultConfigDir()

string Config::ExpandDefaultConfigDir ( bool  removeTrailingSeparator = false)
static

Use path expansion to return absolute path to device client default configuration directory.

Returns

Member Data Documentation

◆ DEFAULT_FLEET_PROVISIONING_RUNTIME_CONFIG_FILE

constexpr char Config::DEFAULT_FLEET_PROVISIONING_RUNTIME_CONFIG_FILE
staticconstexpr
Initial value:
=
"~/.aws-iot-device-client/aws-iot-device-client-runtime.conf"

The documentation for this class was generated from the following files: