Skip to content

Commit cd31f99

Browse files
More docs
1 parent 07b935f commit cd31f99

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

projects/client/RabbitMQ.Client/src/client/api/ConnectionFactory.cs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -310,11 +310,27 @@ public AuthMechanismFactory AuthMechanismFactory(IList<string> mechanismNames)
310310
/// <summary>
311311
/// Create a connection to the specified endpoint.
312312
/// </summary>
313+
/// <exception cref="BrokerUnreachableException">
314+
/// When the configured hostname was not reachable.
315+
/// </exception>
313316
public virtual IConnection CreateConnection()
314317
{
315318
return CreateConnection(new List<string>() { HostName });
316319
}
317320

321+
/// <summary>
322+
/// Create a connection using a list of hostnames. The first reachable
323+
/// hostname will be used initially. Subsequent hostname picks are determined
324+
/// by the <see cref="IHostnameSelector" /> configured.
325+
/// </summary>
326+
/// <param name="hostnames">
327+
/// List of hostnames to use for the initial
328+
/// connection and recovery.
329+
/// </param>
330+
/// <returns>Open connection</returns>
331+
/// <exception cref="BrokerUnreachableException">
332+
/// When no hostname was reachable.
333+
/// </exception>
318334
public IConnection CreateConnection(IList<string> hostnames)
319335
{
320336
IConnection conn;

0 commit comments

Comments
 (0)