A single AMQP Connection instance. More...

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

Public Member Functions
void	Close (IErrorCondition error=null)
	Initiates a close of the connection and awaits a response from the remote that indicates completion of the close operation. If the response from the remote exceeds the configure close timeout the method returns after cleaning up the connection resources.

Task< IConnection >	CloseAsync (IErrorCondition error=null)
	Initiates a close of the connection and a Task that allows the caller to await or poll for the response from the remote that indicates completion of the close operation. If the response from the remote exceeds the configure close timeout the connection will be cleaned up and the Task signalled indicating completion.

IReceiver	OpenReceiver (string address, ReceiverOptions options=null)
	Creates a receiver used to consume messages from the given node address. The returned receiver will be configured using the provided receiver options.

Task< IReceiver >	OpenReceiverAsync (string address, ReceiverOptions options=null)
	Asynchronously creates a receiver used to consume messages from the given node address. The returned receiver will be configured using the provided receiver options.

IReceiver	OpenDurableReceiver (string address, string subscriptionName, ReceiverOptions options=null)
	Creates a receiver used to consume messages from the given node address. The returned receiver will be configured using the provided receiver options.

Task< IReceiver >	OpenDurableReceiverAsync (string address, string subscriptionName, ReceiverOptions options=null)
	Asynchronously creates a receiver used to consume messages from the given node address. The returned receiver will be configured using the provided receiver options.

IReceiver	OpenDynamicReceiver (ReceiverOptions options=null, IDictionary< string, object > dynamicNodeProperties=null)
	Creates a dynamic receiver used to consume messages from the dynamically generated node on the remote. The returned receiver will be configured using the provided options.

Task< IReceiver >	OpenDynamicReceiverAsync (ReceiverOptions options=null, IDictionary< string, object > dynamicNodeProperties=null)
	Asynchronously creates a dynamic receiver used to consume messages from the dynamically generated node on the remote. The returned receiver will be configured using the provided options.

IStreamReceiver	OpenStreamReceiver (string address, StreamReceiverOptions options=null)
	Creates a stream receiver used to consume large messages from the given node address. The returned receiver will be configured using the provided stream receiver options.

Task< IStreamReceiver >	OpenStreamReceiverAsync (string address, StreamReceiverOptions options=null)
	Asynchronously creates a stream receiver used to consume large messages from the given node address. The returned receiver will be configured using the provided stream receiver options.

ISender	DefaultSender ()
	Returns the default anonymous sender used by this connection for all send calls from the connection. If the sender has not been created yet this call will initiate its creation and open with the remote peer.

Task< ISender >	DefaultSenderAsync ()
	Asynchronously returns the default anonymous sender used by this connection for all send calls from the connection. If the sender has not been created yet this call will initiate its creation and open with the remote peer.

ISender	OpenSender (string address, SenderOptions options=null)
	Creates a sender used to send messages to the given node address. The returned sender will be configured using configuration options provided.

Task< ISender >	OpenSenderAsync (string address, SenderOptions options=null)
	Asynchronously creates a sender used to send messages to the given node address. The returned sender will be configured using configuration options provided.

IStreamSender	OpenStreamSender (string address, StreamSenderOptions options=null)
	Creates a stream sender used to send large messages to the given node address. The returned sender will be configured using configuration options provided.

Task< IStreamSender >	OpenStreamSenderAsync (string address, StreamSenderOptions options=null)
	Asynchronously creates a stream sender used to send large messages to the given node address. The returned sender will be configured using configuration options provided.

ISender	OpenAnonymousSender (SenderOptions options=null)
	Creates a anonymous sender used to send messages to the "anonymous relay" on the remote. Each message sent must include a "to" address for the remote to route the message. The returned sender will be configured using the provided sender options.

Task< ISender >	OpenAnonymousSenderAsync (SenderOptions options=null)
	Asynchronously creates a anonymous sender used to send messages to the "anonymous relay" on the remote. Each message sent must include a "to" address for the remote to route the message. The returned sender will be configured using the provided sender options.

ISession	DefaultSession ()
	Returns the default session instance that is used by this Connection to create the default anonymous connection sender as well as creating those resources created from the connection} such as sender and receiver instances not married to a specific session.

Task< ISession >	DefaultSessionAsync ()
	Asynchronously returns the default session instance that is used by this Connection to create the default anonymous connection sender as well as creating those resources created from the connection} such as sender and receiver instances not married to a specific session.

ISession	OpenSession (SessionOptions options=null)
	Creates a new session instance for use by the client application. The returned session will be configured using the provided session options.

Task< ISession >	OpenSessionAsync (SessionOptions options=null)
	Asynchronously creates a new session instance for use by the client application. The returned session will be configured using the provided session options.

ITracker	Send< T > (IMessage< T > message)
	Sends the given message using the connection scoped default sender instance. The connection send uses the remote "anonymous relay" to route messages which requires that the sent message have a valid "To" address set and that the remote supports the anonymous relay.

Task< ITracker >	SendAsync< T > (IMessage< T > message)
	Asynchronously sends the given message using the connection scoped default sender instance. The connection send uses the remote "anonymous relay" to route messages which requires that the sent message have a valid "To" address set and that the remote supports the anonymous relay.

IReceiver	NextReceiver ()
	Waits indefinitely for a receiver created from this session to have a delivery ready for receipt. The selection of the next receiver when more than one exists which has pending deliveries is based upon the configured value of the default next receiver policy that was configured in the session options used to create this session, or the connection level policy if none was assigned to the session options.

Task< IReceiver >	NextReceiverAsync ()
	Returns a task that will complete only after a receiver created from this connection has a delivery ready for receipt. The selection of the next receiver when more than one exists which has pending deliveries is based upon the configured value of the default next receiver policy that was configured in the connection options used to create this connection.

IReceiver	NextReceiver (NextReceiverPolicy policy)
	Waits indefinitely for a receiver created from this connection to have a delivery ready for receipt. The selection of the next receiver when more than one exists which has pending deliveries is based upon the value of the next receiver policy that is provided by the caller.

Task< IReceiver >	NextReceiverAsync (NextReceiverPolicy policy)
	Returns a task that will complete only after a receiver created from this connection has a delivery ready for receipt. The selection of the next receiver when more than one exists which has pending deliveries is based upon the value of the next receiver policy that is provided by the caller.

IReceiver	NextReceiver (TimeSpan timeout)
	Waits up to the given timeout for a receiver created from this connection to have a delivery ready for receipt. The selection of the next receiver when more than one exists which has pending deliveries is based upon the configured value of the default next receiver policy that was configured in the connection options used to create this connection.

Task< IReceiver >	NextReceiverAsync (TimeSpan timeout)
	Returns a task that will complete once a receiver created from this connection has a delivery ready for receipt or the given timeout expires. The selection of the next receiver when more than one exists which has pending deliveries is based upon the configured value of the default next receiver policy that was configured in the connection options used to create this connection.

IReceiver	NextReceiver (NextReceiverPolicy policy, TimeSpan timeout)
	Waits up to the given timeout for a receiver created from this connection to have a delivery ready for receipt. The selection of the next receiver when more than one exists which has pending deliveries is based upon the value of the next receiver policy that is provided by the caller.

Task< IReceiver >	NextReceiverAsync (NextReceiverPolicy policy, TimeSpan timeout)
	Returns a task that will complete once a receiver created from this connection has a delivery ready for receipt or the given timeout expires. The selection of the next receiver when more than one exists which has pending deliveries is based upon the value of the next receiver policy that is provided by the caller.

Properties
IClient	Client `[get]`
	Returns the parent client instance that created this connection.

Task< IConnection >	OpenTask `[get]`
	When a connection is created and returned to the client application it may not be remotely opened yet and if the client needs to wait for completion of the open before proceeding the open task can be fetched and waited upon.

IReadOnlyDictionary< string, object >	Properties `[get]`
	Returns the properties that the remote provided upon successfully opening the connection. If the open has not completed yet this method will block to await the open response which carries the remote properties. If the remote provides no properties this method will return null.

IReadOnlyCollection< string >	OfferedCapabilities `[get]`
	Returns the offered capabilities that the remote provided upon successfully opening the connection. If the open has not completed yet this method will block to await the open response which carries the remote offered capabilities. If the remote provides no offered capabilities this method will return null.

IReadOnlyCollection< string >	DesiredCapabilities `[get]`
	Returns the desired capabilities that the remote provided upon successfully opening the connection. If the open has not completed yet this method will block to await the open response which carries the remote desired capabilities. If the remote provides no desired capabilities this method will return null.

Detailed Description

A single AMQP Connection instance.

Member Function Documentation

◆ Close()

void Apache.Qpid.Proton.Client.IConnection.Close ( IErrorCondition error = null )

Initiates a close of the connection and awaits a response from the remote that indicates completion of the close operation. If the response from the remote exceeds the configure close timeout the method returns after cleaning up the connection resources.

Parameters

error Optional error condition to convey to the remote

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

◆ CloseAsync()

Task< IConnection > Apache.Qpid.Proton.Client.IConnection.CloseAsync ( IErrorCondition error = null )

Initiates a close of the connection and a Task that allows the caller to await or poll for the response from the remote that indicates completion of the close operation. If the response from the remote exceeds the configure close timeout the connection will be cleaned up and the Task signalled indicating completion.

Parameters

error Optional error condition to convey to the remote

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

◆ DefaultSender()

ISender Apache.Qpid.Proton.Client.IConnection.DefaultSender ( )

Returns the default anonymous sender used by this connection for all send calls from the connection. If the sender has not been created yet this call will initiate its creation and open with the remote peer.

Returns: The connection wide default anonymous sender instance.

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

◆ DefaultSenderAsync()

Task< ISender > Apache.Qpid.Proton.Client.IConnection.DefaultSenderAsync ( )

Asynchronously returns the default anonymous sender used by this connection for all send calls from the connection. If the sender has not been created yet this call will initiate its creation and open with the remote peer.

Returns: Task that provides the connection wide default anonymous sender instance.

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

◆ DefaultSession()

ISession Apache.Qpid.Proton.Client.IConnection.DefaultSession ( )

Returns the default session instance that is used by this Connection to create the default anonymous connection sender as well as creating those resources created from the connection} such as sender and receiver instances not married to a specific session.

Returns: The default session that is owned by this connection

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

◆ DefaultSessionAsync()

Task< ISession > Apache.Qpid.Proton.Client.IConnection.DefaultSessionAsync ( )

Asynchronously returns the default session instance that is used by this Connection to create the default anonymous connection sender as well as creating those resources created from the connection} such as sender and receiver instances not married to a specific session.

Returns: A Task that results in default session that is owned by this connection

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

◆ NextReceiver() [1/4]

IReceiver Apache.Qpid.Proton.Client.IConnection.NextReceiver ( )

Waits indefinitely for a receiver created from this session to have a delivery ready for receipt. The selection of the next receiver when more than one exists which has pending deliveries is based upon the configured value of the default next receiver policy that was configured in the session options used to create this session, or the connection level policy if none was assigned to the session options.

Returns: The next receiver that has a pending delivery available based on policy.

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

◆ NextReceiver() [2/4]

IReceiver Apache.Qpid.Proton.Client.IConnection.NextReceiver ( NextReceiverPolicy policy )

Waits indefinitely for a receiver created from this connection to have a delivery ready for receipt. The selection of the next receiver when more than one exists which has pending deliveries is based upon the value of the next receiver policy that is provided by the caller.

Parameters

policy The next receiver policy to apply when selecting a result

Returns

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

◆ NextReceiver() [3/4]

IReceiver Apache.Qpid.Proton.Client.IConnection.NextReceiver	(	NextReceiverPolicy	policy,
		TimeSpan	timeout
	)

Waits up to the given timeout for a receiver created from this connection to have a delivery ready for receipt. The selection of the next receiver when more than one exists which has pending deliveries is based upon the value of the next receiver policy that is provided by the caller.

Parameters

policy	The next receiver policy to apply when selecting a result
timeout	The time to wait for a receiver to have a pending delivery

Returns: A Task that results in the next receiver that has a pending delivery available based on policy.

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

◆ NextReceiver() [4/4]

IReceiver Apache.Qpid.Proton.Client.IConnection.NextReceiver ( TimeSpan timeout )

Waits up to the given timeout for a receiver created from this connection to have a delivery ready for receipt. The selection of the next receiver when more than one exists which has pending deliveries is based upon the configured value of the default next receiver policy that was configured in the connection options used to create this connection.

Parameters

timeout The time to wait for a receiver to have a pending delivery

Returns

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

◆ NextReceiverAsync() [1/4]

Task< IReceiver > Apache.Qpid.Proton.Client.IConnection.NextReceiverAsync ( )

Returns a task that will complete only after a receiver created from this connection has a delivery ready for receipt. The selection of the next receiver when more than one exists which has pending deliveries is based upon the configured value of the default next receiver policy that was configured in the connection options used to create this connection.

Returns: A Task that results in the next receiver that has a pending delivery available based on policy.

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

◆ NextReceiverAsync() [2/4]

Task< IReceiver > Apache.Qpid.Proton.Client.IConnection.NextReceiverAsync ( NextReceiverPolicy policy )

Returns a task that will complete only after a receiver created from this connection has a delivery ready for receipt. The selection of the next receiver when more than one exists which has pending deliveries is based upon the value of the next receiver policy that is provided by the caller.

Parameters

policy The next receiver policy to apply when selecting a result

Returns: A Task that results in the next receiver that has a pending delivery available based on policy.

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

◆ NextReceiverAsync() [3/4]

Task< IReceiver > Apache.Qpid.Proton.Client.IConnection.NextReceiverAsync	(	NextReceiverPolicy	policy,
		TimeSpan	timeout
	)

Returns a task that will complete once a receiver created from this connection has a delivery ready for receipt or the given timeout expires. The selection of the next receiver when more than one exists which has pending deliveries is based upon the value of the next receiver policy that is provided by the caller.

Parameters

policy	The next receiver policy to apply when selecting a result
timeout	The time to wait for a receiver to have a pending delivery

Returns: A Task that results in the next receiver that has a pending delivery available based on policy.

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

◆ NextReceiverAsync() [4/4]

Task< IReceiver > Apache.Qpid.Proton.Client.IConnection.NextReceiverAsync ( TimeSpan timeout )

Returns a task that will complete once a receiver created from this connection has a delivery ready for receipt or the given timeout expires. The selection of the next receiver when more than one exists which has pending deliveries is based upon the configured value of the default next receiver policy that was configured in the connection options used to create this connection.

Parameters

timeout The time to wait for a receiver to have a pending delivery

Returns

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

◆ OpenAnonymousSender()

ISender Apache.Qpid.Proton.Client.IConnection.OpenAnonymousSender ( SenderOptions options = null )

Creates a anonymous sender used to send messages to the "anonymous relay" on the remote. Each message sent must include a "to" address for the remote to route the message. The returned sender will be configured using the provided sender options.

The returned sender may not have been opened on the remote when it is returned. Some methods of the sender can block until the remote fully opens the sender, the user can wait for the remote to respond to the open request by obtaining the open task from the sender and using it to await the completion of the sender open.

Parameters

options Optional sender options to use for configuration

Returns: A new sender instance.

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

◆ OpenAnonymousSenderAsync()

Task< ISender > Apache.Qpid.Proton.Client.IConnection.OpenAnonymousSenderAsync ( SenderOptions options = null )

Asynchronously creates a anonymous sender used to send messages to the "anonymous relay" on the remote. Each message sent must include a "to" address for the remote to route the message. The returned sender will be configured using the provided sender options.

The returned sender may not have been opened on the remote when it is returned. Some methods of the sender can block until the remote fully opens the sender, the user can wait for the remote to respond to the open request by obtaining the open task from the sender and using it to await the completion of the sender open.

Parameters

options Optional sender options to use for configuration

Returns: A Task that returns a new sender instance when completed

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

◆ OpenDurableReceiver()

IReceiver Apache.Qpid.Proton.Client.IConnection.OpenDurableReceiver	(	string	address,
		string	subscriptionName,
		ReceiverOptions	options = `null`
	)

Creates a receiver used to consume messages from the given node address. The returned receiver will be configured using the provided receiver options.

The returned receiver may not have been opened on the remote when it is returned. Some methods of the receiver can block until the remote fully opens the receiver, the user can wait for the remote to respond to the open request by obtaining the open task from the receiver and using it to await the completion of the receiver open.

Parameters

address	The address of the node the receiver attaches to
subscriptionName	The subscription name to use for the receiver
options	Optional receiver options to use for configuration

Returns: A new receiver instance

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

◆ OpenDurableReceiverAsync()

Task< IReceiver > Apache.Qpid.Proton.Client.IConnection.OpenDurableReceiverAsync	(	string	address,
		string	subscriptionName,
		ReceiverOptions	options = `null`
	)

Asynchronously creates a receiver used to consume messages from the given node address. The returned receiver will be configured using the provided receiver options.

The returned receiver may not have been opened on the remote when it is returned. Some methods of the receiver can block until the remote fully opens the receiver, the user can wait for the remote to respond to the open request by obtaining the open task from the receiver and using it to await the completion of the receiver open.

Parameters

address	The address of the node the receiver attaches to
subscriptionName	The subscription name to use for the receiver
options	Optional receiver options to use for configuration

Returns: A Task that returns a new receiver instance when completed

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

◆ OpenDynamicReceiver()

IReceiver Apache.Qpid.Proton.Client.IConnection.OpenDynamicReceiver	(	ReceiverOptions	options = `null`,
		IDictionary< string, object >	dynamicNodeProperties = `null`
	)

Creates a dynamic receiver used to consume messages from the dynamically generated node on the remote. The returned receiver will be configured using the provided options.

The returned receiver may not have been opened on the remote when it is returned. Some methods of the receiver can block until the remote fully opens the receiver, the user can wait for the remote to respond to the open request by obtaining the open task from the receiver and using it to await the completion of the receiver open.

Parameters

options	Optional receiver options to use for configuration
dynamicNodeProperties	Optional properties to assign to the node create

Returns: A new receiver instance

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

◆ OpenDynamicReceiverAsync()

Task< IReceiver > Apache.Qpid.Proton.Client.IConnection.OpenDynamicReceiverAsync	(	ReceiverOptions	options = `null`,
		IDictionary< string, object >	dynamicNodeProperties = `null`
	)

Asynchronously creates a dynamic receiver used to consume messages from the dynamically generated node on the remote. The returned receiver will be configured using the provided options.

The returned receiver may not have been opened on the remote when it is returned. Some methods of the receiver can block until the remote fully opens the receiver, the user can wait for the remote to respond to the open request by obtaining the open task from the receiver and using it to await the completion of the receiver open.

Parameters

options	Optional receiver options to use for configuration
dynamicNodeProperties	Optional properties to assign to the node create

Returns: A Task that returns a new receiver instance when completed

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

◆ OpenReceiver()

IReceiver Apache.Qpid.Proton.Client.IConnection.OpenReceiver	(	string	address,
		ReceiverOptions	options = `null`
	)

Creates a receiver used to consume messages from the given node address. The returned receiver will be configured using the provided receiver options.

The returned receiver may not have been opened on the remote when it is returned. Some methods of the receiver can block until the remote fully opens the receiver, the user can wait for the remote to respond to the open request by obtaining the open task from the receiver and using it to await the completion of the receiver open.

Parameters

address	The address of the node the receiver attaches to
options	Optional receiver options to use for configuration

Returns: A new receiver instance

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

◆ OpenReceiverAsync()

Task< IReceiver > Apache.Qpid.Proton.Client.IConnection.OpenReceiverAsync	(	string	address,
		ReceiverOptions	options = `null`
	)

Asynchronously creates a receiver used to consume messages from the given node address. The returned receiver will be configured using the provided receiver options.

The returned receiver may not have been opened on the remote when it is returned. Some methods of the receiver can block until the remote fully opens the receiver, the user can wait for the remote to respond to the open request by obtaining the open task from the receiver and using it to await the completion of the receiver open.

Parameters

address	The address of the node the receiver attaches to
options	Optional receiver options to use for configuration

Returns: A Task that returns a new receiver instance when completed

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

◆ OpenSender()

ISender Apache.Qpid.Proton.Client.IConnection.OpenSender	(	string	address,
		SenderOptions	options = `null`
	)

Creates a sender used to send messages to the given node address. The returned sender will be configured using configuration options provided.

The returned sender may not have been opened on the remote when it is returned. Some methods of the sender can block until the remote fully opens the sender, the user can wait for the remote to respond to the open request by obtaining the open task from the sender and using it to await the completion of the sender open.

Parameters

address	The address of the node the sender attaches to
options	Optional sender options to use for configuration

Returns: A new sender instance.

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

◆ OpenSenderAsync()

Task< ISender > Apache.Qpid.Proton.Client.IConnection.OpenSenderAsync	(	string	address,
		SenderOptions	options = `null`
	)

Asynchronously creates a sender used to send messages to the given node address. The returned sender will be configured using configuration options provided.

The returned sender may not have been opened on the remote when it is returned. Some methods of the sender can block until the remote fully opens the sender, the user can wait for the remote to respond to the open request by obtaining the open task from the sender and using it to await the completion of the sender open.

Parameters

address	The address of the node the sender attaches to
options	Optional sender options to use for configuration

Returns: A Task that returns a new sender instance when completed

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

◆ OpenSession()

ISession Apache.Qpid.Proton.Client.IConnection.OpenSession ( SessionOptions options = null )

Creates a new session instance for use by the client application. The returned session will be configured using the provided session options.

The returned session may not have been opened on the remote when it is returned. Some methods of the session can block until the remote fully opens the session, the user can wait for the remote to respond to the open request by obtaining the open task from the session and using it to await the completion of the session open.

Parameters

options Optional session options to use for configuration

Returns: A new session instance.

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

◆ OpenSessionAsync()

Task< ISession > Apache.Qpid.Proton.Client.IConnection.OpenSessionAsync ( SessionOptions options = null )

Asynchronously creates a new session instance for use by the client application. The returned session will be configured using the provided session options.

The returned session may not have been opened on the remote when it is returned. Some methods of the session can block until the remote fully opens the session, the user can wait for the remote to respond to the open request by obtaining the open task from the session and using it to await the completion of the session open.

Parameters

options Optional session options to use for configuration

Returns: A Task that result in a new session instance.

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

◆ OpenStreamReceiver()

IStreamReceiver Apache.Qpid.Proton.Client.IConnection.OpenStreamReceiver	(	string	address,
		StreamReceiverOptions	options = `null`
	)

Creates a stream receiver used to consume large messages from the given node address. The returned receiver will be configured using the provided stream receiver options.

The returned receiver may not have been opened on the remote when it is returned. Some methods of the receiver can block until the remote fully opens the receiver, the user can wait for the remote to respond to the open request by obtaining the open task from the receiver and using it to await the completion of the receiver open.

Parameters

address	The address of the node the receiver attaches to
options	Optional receiver options to use for configuration

Returns: A new receiver instance

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

◆ OpenStreamReceiverAsync()

Task< IStreamReceiver > Apache.Qpid.Proton.Client.IConnection.OpenStreamReceiverAsync	(	string	address,
		StreamReceiverOptions	options = `null`
	)

Asynchronously creates a stream receiver used to consume large messages from the given node address. The returned receiver will be configured using the provided stream receiver options.

The returned receiver may not have been opened on the remote when it is returned. Some methods of the receiver can block until the remote fully opens the receiver, the user can wait for the remote to respond to the open request by obtaining the open task from the receiver and using it to await the completion of the receiver open.

Parameters

address	The address of the node the receiver attaches to
options	Optional receiver options to use for configuration

Returns: A Task that returns a new stream receiver instance when completed

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

◆ OpenStreamSender()

IStreamSender Apache.Qpid.Proton.Client.IConnection.OpenStreamSender	(	string	address,
		StreamSenderOptions	options = `null`
	)

Creates a stream sender used to send large messages to the given node address. The returned sender will be configured using configuration options provided.

The returned sender may not have been opened on the remote when it is returned. Some methods of the sender can block until the remote fully opens the sender, the user can wait for the remote to respond to the open request by obtaining the open task from the sender and using it to await the completion of the sender open.

Parameters

address	The address of the node the sender attaches to
options	Optional stream sender options to use for configuration

Returns: A new sender instance.

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

◆ OpenStreamSenderAsync()

Task< IStreamSender > Apache.Qpid.Proton.Client.IConnection.OpenStreamSenderAsync	(	string	address,
		StreamSenderOptions	options = `null`
	)

Asynchronously creates a stream sender used to send large messages to the given node address. The returned sender will be configured using configuration options provided.

The returned sender may not have been opened on the remote when it is returned. Some methods of the sender can block until the remote fully opens the sender, the user can wait for the remote to respond to the open request by obtaining the open task from the sender and using it to await the completion of the sender open.

Parameters

address	The address of the node the sender attaches to
options	Optional stream sender options to use for configuration

Returns: A Task that returns a new sender instance when completed

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

◆ Send< T >()

ITracker Apache.Qpid.Proton.Client.IConnection.Send< T > ( IMessage< T > message )

Sends the given message using the connection scoped default sender instance. The connection send uses the remote "anonymous relay" to route messages which requires that the sent message have a valid "To" address set and that the remote supports the anonymous relay.

Template Parameters

T	The type of body the message carries

Parameters

message The message to be sent

Returns: A tracker instance that can be used to track the send outcome

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

◆ SendAsync< T >()

Task< ITracker > Apache.Qpid.Proton.Client.IConnection.SendAsync< T > ( IMessage< T > message )

Asynchronously sends the given message using the connection scoped default sender instance. The connection send uses the remote "anonymous relay" to route messages which requires that the sent message have a valid "To" address set and that the remote supports the anonymous relay.

Template Parameters

T	The type of body the message carries

Parameters

message The message to be sent

Returns: A Task that results in a tracker instance that can be used to track the send outcome

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

Property Documentation

◆ Client

IClient Apache.Qpid.Proton.Client.IConnection.Client

get

Returns the parent client instance that created this connection.

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

◆ DesiredCapabilities

IReadOnlyCollection<string> Apache.Qpid.Proton.Client.IConnection.DesiredCapabilities

get

Returns the desired capabilities that the remote provided upon successfully opening the connection. If the open has not completed yet this method will block to await the open response which carries the remote desired capabilities. If the remote provides no desired capabilities this method will return null.

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

◆ OfferedCapabilities

IReadOnlyCollection<string> Apache.Qpid.Proton.Client.IConnection.OfferedCapabilities

get

Returns the offered capabilities that the remote provided upon successfully opening the connection. If the open has not completed yet this method will block to await the open response which carries the remote offered capabilities. If the remote provides no offered capabilities this method will return null.

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

◆ OpenTask

Task<IConnection> Apache.Qpid.Proton.Client.IConnection.OpenTask

get

When a connection is created and returned to the client application it may not be remotely opened yet and if the client needs to wait for completion of the open before proceeding the open task can be fetched and waited upon.

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

◆ Properties

IReadOnlyDictionary<string, object> Apache.Qpid.Proton.Client.IConnection.Properties

get

Returns the properties that the remote provided upon successfully opening the connection. If the open has not completed yet this method will block to await the open response which carries the remote properties. If the remote provides no properties this method will return null.

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

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

src/Proton.Client/Client/IConnection.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Close()

◆ CloseAsync()

◆ DefaultSender()

◆ DefaultSenderAsync()

◆ DefaultSession()

◆ DefaultSessionAsync()

◆ NextReceiver() [1/4]

◆ NextReceiver() [2/4]

◆ NextReceiver() [3/4]

◆ NextReceiver() [4/4]

◆ NextReceiverAsync() [1/4]

◆ NextReceiverAsync() [2/4]

◆ NextReceiverAsync() [3/4]

◆ NextReceiverAsync() [4/4]

◆ OpenAnonymousSender()

◆ OpenAnonymousSenderAsync()

◆ OpenDurableReceiver()

◆ OpenDurableReceiverAsync()

◆ OpenDynamicReceiver()

◆ OpenDynamicReceiverAsync()

◆ OpenReceiver()

◆ OpenReceiverAsync()

◆ OpenSender()

◆ OpenSenderAsync()

◆ OpenSession()

◆ OpenSessionAsync()

◆ OpenStreamReceiver()

◆ OpenStreamReceiverAsync()

◆ OpenStreamSender()

◆ OpenStreamSenderAsync()

◆ Send< T >()

◆ SendAsync< T >()

Property Documentation

◆ Client

◆ DesiredCapabilities

◆ OfferedCapabilities

◆ OpenTask

◆ Properties