-spec add(pos_integer()) -> {ok, any()} | {error, any()}.

Dynamically add more users to a currently running scenario, in all nodes

See also: add/2.

-spec add(pos_integer(), [node()]) -> {ok, any()} | {error, any()}.

Dynamically add more users to a currently running scenario, in the specified nodes

-spec do(amoc:scenario(), non_neg_integer(), amoc_config:settings()) -> {ok, any()} | {error, any()}.

Start a scenario with the given number of users and configuration

-spec get_state() -> cluster_state().

Get the scenario running status in the cluster

-spec remove(pos_integer(), boolean()) -> {ok, any()} | {error, any()}.

Dynamically remove more users from a currently running scenario, optionally forcibly, in all nodes

See also: remove/3.

-spec remove(pos_integer(), boolean(), [node()]) -> {ok, any()} | {error, any()}.

Dynamically remove more users from a currently running scenario, optionally forcibly, in the specified nodes

Forcing user removal means that all users will be signal to exit in parallel, and will forcibly be killed after a short timeout (2 seconds), whether they have exited already or not.

-spec stop() -> {ok, any()} | {error, any()}.

Stop a running scenario in the whole cluster

-spec update_settings(amoc_config:settings()) -> {ok, any()} | {error, any()}.

Update the settings of a currently running scenario, in all nodes

See also: update_settings/2.

-spec update_settings(amoc_config:settings(), [node()]) -> {ok, any()} | {error, any()}.

Update the settings of a currently running scenario, in the specified nodes