Defined in carb/StartupUtils.h

inline void carb::startupFramework(const StartupFrameworkDesc &params)

Starts/Configures the framework given a slew of input parameters.

First see carb::StartupFrameworkDesc for an idea of the type of data this function accepts.

At a high-level this function:

  • Calls loadFrameworkConfiguration(), which:

  • Determines application path from CLI args and env vars (see carb::extras::getAppPathAndName()).

  • Sets application path as filesystem root

  • Loads plugins for settings: carb.settings.plugin, carb.dictionary.plugin, carb.tokens.plugins and any serializer plugin.

  • Searches for config file, loads it and applies CLI args overrides.

  • Calls configureFramework(), which:

  • Configures logging with config file

  • Loads plugins according to config file

  • Configures default plugins according to config file

  • Starts the default profiler (if loaded)

Rather than this function, consider using OMNI_CORE_INIT(), which handles both starting and shutting down the framework for you in your application.