Apache.Qpid.Proton.Client.IClient Interface Reference

The Container that hosts one ore more AMQP connections that share a given AMQP container Id. More...

Inheritance diagram for Apache.Qpid.Proton.Client.IClient:

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.
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.

Static Public Member Functions
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.

Properties
string	ContainerId [get]
	Returns the fixed AMQP container Id value this connection was created with.

Detailed Description

The Container that hosts one ore more AMQP connections that share a given AMQP container Id.

Member Function Documentation

Close()

void Apache.Qpid.Proton.Client.IClient.Close

(

)

Blocking close method that waits for all open connections to be closed before returning to the caller.

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientInstance.

CloseAsync()

Task< IClient > Apache.Qpid.Proton.Client.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.

Returns

A task that aggregates the wait for all connections to close.

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientInstance.

Connect() [1/2]

IConnection Apache.Qpid.Proton.Client.IClient.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.

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

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientInstance.

Connect() [2/2]

IConnection Apache.Qpid.Proton.Client.IClient.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.

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

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientInstance.

Create()

static IClient Apache.Qpid.Proton.Client.IClient.Create ( ClientOptions  options = null )

inlinestatic

Creates a new IClient instance using the Proton default implementation which has been configured using the provided client options.

Parameters

options

Optional options to use to configure the new client instance.

Returns

a new client instance using the default Proton implementation.

Property Documentation

ContainerId

string Apache.Qpid.Proton.Client.IClient.ContainerId

get

Returns the fixed AMQP container Id value this connection was created with.

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientInstance.

---

The documentation for this interface was generated from the following file:

• src/Proton.Client/Client/IClient.cs