mm::auto_tuning Namespace Reference

Namespaces
namespace	detail

Classes
class	Client
	Talks to one running auto-tuning process. More...
class	Process
	Starts the auto-tuning executable and keeps it running for the process lifetime. More...
struct	ProcessOptions
	What to start, and where. More...
struct	Status
	The state of the auto-tuning process, reported by GET /api/auto-tuning. More...

Functions
std::filesystem::path	defaultBinaryName ()
	Name of the executable Motion Master installs beside itself.
void	to_json (nlohmann::json &j, const Status &status)
	Serialises a Status. Free function found by ADL, as nlohmann expects.

Variables
constexpr std::uint16_t	kDefaultPort = 63528
	Port the child serves on when the configuration names none.

Function Documentation

defaultBinaryName()

std::filesystem::path mm::auto_tuning::defaultBinaryName

(

)

Name of the executable Motion Master installs beside itself.

The install scripts download a file named for its platform and rename it to this, so one name works everywhere. See install-auto-tuning.sh.

to_json()

void mm::auto_tuning::to_json ( nlohmann::json &  j, const Status &  status  )

inline

Serialises a Status. Free function found by ADL, as nlohmann expects.

Variable Documentation

kDefaultPort

constexpr std::uint16_t mm::auto_tuning::kDefaultPort = 63528

constexpr

Port the child serves on when the configuration names none.

The auto-tuning program's own default, so a hand-started child and one started here answer on the same port.