Bug 730005

Description of problem:
qpidd-route command  'link list', which is offered by program, mismatch from command 'list connections' in documentation. I suggests to replace command in documentation instead of changing program.

Version-Release number of selected component (if applicable):
rhm-docs-0.10-2.el5
qpid-tools-0.10-6.el5


How reproducible:
100%
  
Actual results:
8.4.6. Resilient Connections
When a broker route is created, or when a durable broker route is restored after broker restart, a connection is created between the source broker and the destination broker. The connections used between brokers are called resilient connections; if the connection fails due to a communication error, it attempts to reconnect. The retry interval begins at 2 seconds and, as more attempts are made, grows to 64 seconds, and continues to retry every 64 seconds thereafter. If the connection fails due to an authentication problem, it will not continue to retry.
The command list connections can be used to show the resilient connections for a broker:

$ qpid-route list connections localhost:10001

Host            Port    Transport Durable  State             Last Error
=============================================================================
localhost       10002   tcp          N     Operational       
localhost       10003   tcp          N     Operational       
localhost       10009   tcp          N     Waiting           Connection refused

In the above output, Last Error contains the string representation of the last connection error received for the connection. State represents the state of the connection, and may be one of the following values:

Table 8.2. State values in $ qpid-route list connections
Waiting 	Waiting before attempting to reconnect.
Connecting 	Attempting to establish the connection.
Operational 	The connection has been established and can be used.
Failed 	The connection failed and will not retry (usually because authentication failed).
Closed 	The connection has been closed and will soon be deleted.
Passive 	If a cluster is federated to another cluster, only one of the nodes has an actual connection to remote node. Other nodes in the cluster have a passive connection. 

Expected results:
8.4.6. Resilient Connections
When a broker route is created, or when a durable broker route is restored after broker restart, a connection is created between the source broker and the destination broker. The connections used between brokers are called resilient connections; if the connection fails due to a communication error, it attempts to reconnect. The retry interval begins at 2 seconds and, as more attempts are made, grows to 64 seconds, and continues to retry every 64 seconds thereafter. If the connection fails due to an authentication problem, it will not continue to retry.
The command link list can be used to show the resilient connections for a broker:

$ qpid-route link list localhost:10001

Host            Port    Transport Durable  State             Last Error
=============================================================================
localhost       10002   tcp          N     Operational       
localhost       10003   tcp          N     Operational       
localhost       10009   tcp          N     Waiting           Connection refused

In the above output, Last Error contains the string representation of the last connection error received for the connection. State represents the state of the connection, and may be one of the following values:

Table 8.2. State values in $ qpid-route link list
Waiting 	Waiting before attempting to reconnect.
Connecting 	Attempting to establish the connection.
Operational 	The connection has been established and can be used.
Failed 	The connection failed and will not retry (usually because authentication failed).
Closed 	The connection has been closed and will soon be deleted.
Passive 	If a cluster is federated to another cluster, only one of the nodes has an actual connection to remote node. Other nodes in the cluster have a passive connection.