namespace rgpot::rpc¶
Overview¶
PotentialConfig.morse for a MorsePot backend. More…
namespace rpc {
// structs
struct MorseConfigureResult;
// global functions
MorseConfig morseConfigFrom(const ::MorseParams::Reader& params, MorseConfig base = {});
MorseConfigureResult configureMorse(const ::PotentialConfig::Reader& cfg, const MorsePot& current);
std::string potentialConfigArm(const ::PotentialConfig::Reader& cfg);
} // namespace rpc
Detailed Documentation¶
PotentialConfig.morse for a MorsePot backend.
Name of the PotentialConfig arm a configure() call carries.
MorsePot fixes its parameters at construction, so applying the morse arm builds a replacement pot. switch_width is not on the wire and carries over from the pot being replaced.
A peer built against a newer potentials-schema can send an arm this build does not know. which() then returns the raw discriminant, so the name comes from the compiled schema and an unknown arm is reported by its discriminant instead of indexing past the known ones.
Global Functions¶
MorseConfigureResult configureMorse(const ::PotentialConfig::Reader& cfg, const MorsePot& current)
none is a no-op, morse rebuilds the pot, every other arm is refused.