The client type servers as a container of connections and provides a means of closing all open connection in a single operation which can be performed synchronously or provides a Task type that allows a caller to be notified once all connections have been closed. More...
Public Member Functions | |
| void | Close () |
| Blocking close method that waits for all open connections to be closed before returning to the caller. | |
| Task< IClient > | CloseAsync () |
| Initiates an asynchronous close of all the connections created from this client container. The returned Task allows the caller to wait for the close to complete or check in periodically to see if the operation has finished. | |
| void | Dispose () |
| IConnection | Connect (string host, int port, ConnectionOptions options=null) |
| Creates a new connection to the designated remote host on the provided port. The connection is configured using the provided connection options. This method does not block waiting for the actual IO level connection to be established, a new IConnection instance will be return which the caller can begin using. To await full connection to the remote the caller should use the open task exposed by the IConnection to wait the outcome. | |
| IConnection | Connect (string host, ConnectionOptions options=null) |
| Creates a new connection to the designated remote host on the default AMQP port. The connection is configured using the provided connection options. This method does not block waiting for the actual IO level connection to be established, a new IConnection instance will be return which the caller can begin using. To await full connection to the remote the caller should use the open task exposed by the IConnection to wait the outcome. | |
Properties | |
| string | ContainerId [get] |
| Returns the fixed AMQP container Id value this connection was created with. | |
 Properties inherited from Apache.Qpid.Proton.Client.IClient | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Apache.Qpid.Proton.Client.IClient | |
| static IClient | Create (ClientOptions options=null) |
| Creates a new IClient instance using the Proton default implementation which has been configured using the provided client options. | |
Detailed Description
The client type servers as a container of connections and provides a means of closing all open connection in a single operation which can be performed synchronously or provides a Task type that allows a caller to be notified once all connections have been closed.
Member Function Documentation
◆ Close()
|
inline |
Blocking close method that waits for all open connections to be closed before returning to the caller.
Implements Apache.Qpid.Proton.Client.IClient.
◆ CloseAsync()
|
inline |
Initiates an asynchronous close of all the connections created from this client container. The returned Task allows the caller to wait for the close to complete or check in periodically to see if the operation has finished.
- Returns
- A task that aggregates the wait for all connections to close.
Implements Apache.Qpid.Proton.Client.IClient.
◆ Connect() [1/2]
|
inline |
Creates a new connection to the designated remote host on the default AMQP port. The connection is configured using the provided connection options. This method does not block waiting for the actual IO level connection to be established, a new IConnection instance will be return which the caller can begin using. To await full connection to the remote the caller should use the open task exposed by the IConnection to wait the outcome.
- Parameters
-
host The remote host this connection should connect to options Optional connection options to use to configure the connection
- Returns
- A new connection that connects to the given host
Implements Apache.Qpid.Proton.Client.IClient.
◆ Connect() [2/2]
|
inline |
Creates a new connection to the designated remote host on the provided port. The connection is configured using the provided connection options. This method does not block waiting for the actual IO level connection to be established, a new IConnection instance will be return which the caller can begin using. To await full connection to the remote the caller should use the open task exposed by the IConnection to wait the outcome.
- Parameters
-
host The remote host this connection should connect to port The port on the remote host where the connection is established options Optional connection options to use to configure the connection
- Returns
- A new connection that connects to the given host and port
Implements Apache.Qpid.Proton.Client.IClient.
Property Documentation
◆ ContainerId
|
get |
Returns the fixed AMQP container Id value this connection was created with.
Implements Apache.Qpid.Proton.Client.IClient.
The documentation for this class was generated from the following file:
- src/Proton.Client/Client/Implementation/ClientInstance.cs
