diff options
| author | Simon MacMullen <simon@rabbitmq.com> | 2011-01-26 16:12:13 +0000 |
|---|---|---|
| committer | Simon MacMullen <simon@rabbitmq.com> | 2011-01-26 16:12:13 +0000 |
| commit | 306afd02529066aeb470a118f106d14dce441742 (patch) | |
| tree | fa32bd7e589ea9eb277f791ab619a1aaa896f172 /docs | |
| parent | 8b22b74269c19286a6c2988f58c66696e3930f69 (diff) | |
| download | rabbitmq-server-git-306afd02529066aeb470a118f106d14dce441742.tar.gz | |
rabbitmqctl status is not adequate to wait for the server as it can return
successfully when the vm has started but not the app. The app can then fail.
Therefore introduce a new command to wait for the app to start.
Note that this subcommand contains a timeout to wait for the VM to
start, but will wait indefinitely for the app to start once the VM
has.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/rabbitmqctl.1.xml | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml index bd9fee7d4b..5c090e5a2b 100644 --- a/docs/rabbitmqctl.1.xml +++ b/docs/rabbitmqctl.1.xml @@ -158,6 +158,28 @@ </varlistentry> <varlistentry> + <term><cmdsynopsis><command>wait</command></cmdsynopsis></term> + <listitem> + <para> + Wait for the RabbitMQ application to start. + </para> + <para> + This command will wait for the RabbitMQ application to + start at the node. As long as the Erlang node is up but + the RabbitMQ application is down it will wait + indefinitely. If the node itself goes down, or takes too + long to come up, it will fail. + </para> + <para role="example-prefix">For example:</para> + <screen role="example">rabbitmqctl wait</screen> + <para role="example"> + This command will return when the RabbitMQ node has + started up. + </para> + </listitem> + </varlistentry> + + <varlistentry> <term><cmdsynopsis><command>status</command></cmdsynopsis></term> <listitem> <para> |