ark::main::MainOnboardConfiguration

Defined in header “ark/main/main_onboard.hh”.


Configuration for the main functions (the entrance point).

Variables

  • core::ArgumentParser argument_parser
    An argument parser to start with. This allows you to add custom command line options to your pipeline.

  • std::filesystem::path pipeline_config_path
    If specified, this will be the path to the configuration file that should be loaded by default. If not specified, no configuration file is loaded.

  • uint64_t preallocate_megabytes= 0
    The number of bytes to preallocate. This is useful to ensure that you allocate a large enough heap on startup such that you don’t have to go back to the operating system for memory.

    Set to zero to disable.

  • bool add_tracer_stage= true
    Set to true to add in a tracer stage with a default configuration.

  • ArgumentsParsedCallback arguments_parsed_callback
    A callback that will be invoked during initialization. It gives you a chance to modify the pipeline based on what is contained within the command line arguments. This will be invoked before the log_opened_callback.

  • std::chrono::nanoseconds execution_duration= std::chrono::nanoseconds::max()
    Maximum amount of time to execute; by default, infinite.