struct EngineJSONConfigConst

Overview

#include <engine_json_config.h>

struct EngineJSONConfigConst {
    // fields

    static constexpr short MaxAddrBindTries = 1024;
    static constexpr std::string_view EngineServerAddrArg = "serverurl";
    static constexpr std::string_view EngineRegistrationServerAddrArg = "regservurl";
    static constexpr std::string_view EngineNameArg = "engine";
    static constexpr std::string_view EngineServerGetDataPacksRoute = "/get_datapacks";
    static constexpr std::string_view EngineServerSetDataPacksRoute = "/set_datapacks";
    static constexpr std::string_view EngineServerRunLoopStepRoute = "/run_loop";
    static constexpr std::string_view EngineServerInitializeRoute = "/initialize";
    static constexpr std::string_view EngineServerResetRoute = "/reset";
    static constexpr std::string_view EngineServerShutdownRoute = "/shutdown";
    static constexpr std::string_view EngineTimeStepName = "time_step";
    static constexpr std::string_view EngineTimeName = "time";
    static constexpr std::string_view EngineServerContentType = "application/json";
};

Detailed Documentation

Fields

static constexpr short MaxAddrBindTries = 1024

Maximum amount of tries for EngineJSONserver to bind to different ports.

static constexpr std::string_view EngineServerAddrArg = "serverurl"

Parameter name that is used to pass along the server address.

static constexpr std::string_view EngineRegistrationServerAddrArg = "regservurl"

Parameter name that is used to pass along the server address.

static constexpr std::string_view EngineNameArg = "engine"

Parameter name that is used to pass along the engine name.

static constexpr std::string_view EngineServerGetDataPacksRoute = "/get_datapacks"

REST Server Route from which to get datapack information.

static constexpr std::string_view EngineServerSetDataPacksRoute = "/set_datapacks"

REST Server Route to which to send datapack changes.

static constexpr std::string_view EngineServerRunLoopStepRoute = "/run_loop"

REST Server Route to execute a single loop.

static constexpr std::string_view EngineServerInitializeRoute = "/initialize"

REST Server Route for engine initialization.

static constexpr std::string_view EngineServerResetRoute = "/reset"

REST Server Route for engine reset.

static constexpr std::string_view EngineServerShutdownRoute = "/shutdown"

REST Server Route for engine shutdown.

static constexpr std::string_view EngineTimeStepName = "time_step"

JSON name under which the runLoopStep timeStep is saved.

static constexpr std::string_view EngineTimeName = "time"

JSON name under which the runLoopStep engine time is sent.

static constexpr std::string_view EngineServerContentType = "application/json"

Content Type passed between server and client.