Proton DotNet
Loading...
Searching...
No Matches
Classes | Public Member Functions | Properties | List of all members
Apache.Qpid.Proton.Client.Implementation.ClientConnection Class Reference

The client connection class manages a single connection to a remote AMQP peer and handles connection errors and reconnection operations if those are enabled. More...

Inheritance diagram for Apache.Qpid.Proton.Client.Implementation.ClientConnection:
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< IConnectionCloseAsync (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.
 
void Dispose ()
 
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< ISenderDefaultSenderAsync ()
 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.
 
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< ISessionDefaultSessionAsync ()
 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< ISessionOpenSessionAsync (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.
 
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< IReceiverOpenDurableReceiverAsync (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< IReceiverOpenDynamicReceiverAsync (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.
 
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< IReceiverOpenReceiverAsync (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.
 
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< ISenderOpenAnonymousSenderAsync (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.
 
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< ISenderOpenSenderAsync (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.
 
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< IStreamReceiverOpenStreamReceiverAsync (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.
 
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< IStreamSenderOpenStreamSenderAsync (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.
 
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< ITrackerSendAsync< 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< IReceiverNextReceiverAsync ()
 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< IReceiverNextReceiverAsync (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< IReceiverNextReceiverAsync (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< IReceiverNextReceiverAsync (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.
 
override string ToString ()
 

Properties

IClient Client [get]
 Returns the parent client instance that created this connection.
 
Task< IConnectionOpenTask [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.
 
- Properties inherited from Apache.Qpid.Proton.Client.IConnection

Detailed Description

The client connection class manages a single connection to a remote AMQP peer and handles connection errors and reconnection operations if those are enabled.

Member Function Documentation

◆ Close()

void Apache.Qpid.Proton.Client.Implementation.ClientConnection.Close ( IErrorCondition  error = null)
inline

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
errorOptional error condition to convey to the remote

Implements Apache.Qpid.Proton.Client.IConnection.

◆ CloseAsync()

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

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
errorOptional error condition to convey to the remote

Implements Apache.Qpid.Proton.Client.IConnection.

◆ DefaultSender()

ISender Apache.Qpid.Proton.Client.Implementation.ClientConnection.DefaultSender ( )
inline

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.

Implements Apache.Qpid.Proton.Client.IConnection.

◆ DefaultSenderAsync()

Task< ISender > Apache.Qpid.Proton.Client.Implementation.ClientConnection.DefaultSenderAsync ( )
inline

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.

Implements Apache.Qpid.Proton.Client.IConnection.

◆ DefaultSession()

ISession Apache.Qpid.Proton.Client.Implementation.ClientConnection.DefaultSession ( )
inline

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

Implements Apache.Qpid.Proton.Client.IConnection.

◆ DefaultSessionAsync()

Task< ISession > Apache.Qpid.Proton.Client.Implementation.ClientConnection.DefaultSessionAsync ( )
inline

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

Implements Apache.Qpid.Proton.Client.IConnection.

◆ NextReceiver() [1/4]

IReceiver Apache.Qpid.Proton.Client.Implementation.ClientConnection.NextReceiver ( )
inline

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.

Implements Apache.Qpid.Proton.Client.IConnection.

◆ NextReceiver() [2/4]

IReceiver Apache.Qpid.Proton.Client.Implementation.ClientConnection.NextReceiver ( NextReceiverPolicy  policy)
inline

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
policyThe next receiver policy to apply when selecting a result
Returns

Implements Apache.Qpid.Proton.Client.IConnection.

◆ NextReceiver() [3/4]

IReceiver Apache.Qpid.Proton.Client.Implementation.ClientConnection.NextReceiver ( NextReceiverPolicy  policy,
TimeSpan  timeout 
)
inline

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
policyThe next receiver policy to apply when selecting a result
timeoutThe 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.

Implements Apache.Qpid.Proton.Client.IConnection.

◆ NextReceiver() [4/4]

IReceiver Apache.Qpid.Proton.Client.Implementation.ClientConnection.NextReceiver ( TimeSpan  timeout)
inline

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
timeoutThe time to wait for a receiver to have a pending delivery
Returns

Implements Apache.Qpid.Proton.Client.IConnection.

◆ NextReceiverAsync() [1/4]

Task< IReceiver > Apache.Qpid.Proton.Client.Implementation.ClientConnection.NextReceiverAsync ( )
inline

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.

Implements Apache.Qpid.Proton.Client.IConnection.

◆ NextReceiverAsync() [2/4]

Task< IReceiver > Apache.Qpid.Proton.Client.Implementation.ClientConnection.NextReceiverAsync ( NextReceiverPolicy  policy)
inline

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

Implements Apache.Qpid.Proton.Client.IConnection.

◆ NextReceiverAsync() [3/4]

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

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
policyThe next receiver policy to apply when selecting a result
timeoutThe 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.

Implements Apache.Qpid.Proton.Client.IConnection.

◆ NextReceiverAsync() [4/4]

Task< IReceiver > Apache.Qpid.Proton.Client.Implementation.ClientConnection.NextReceiverAsync ( TimeSpan  timeout)
inline

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
timeoutThe time to wait for a receiver to have a pending delivery
Returns

Implements Apache.Qpid.Proton.Client.IConnection.

◆ OpenAnonymousSender()

ISender Apache.Qpid.Proton.Client.Implementation.ClientConnection.OpenAnonymousSender ( SenderOptions  options = null)
inline

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
optionsOptional sender options to use for configuration
Returns
A new sender instance.

Implements Apache.Qpid.Proton.Client.IConnection.

◆ OpenAnonymousSenderAsync()

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

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
optionsOptional sender options to use for configuration
Returns
A Task that returns a new sender instance when completed

Implements Apache.Qpid.Proton.Client.IConnection.

◆ OpenDurableReceiver()

IReceiver Apache.Qpid.Proton.Client.Implementation.ClientConnection.OpenDurableReceiver ( string  address,
string  subscriptionName,
ReceiverOptions  options = null 
)
inline

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
addressThe address of the node the receiver attaches to
subscriptionNameThe subscription name to use for the receiver
optionsOptional receiver options to use for configuration
Returns
A new receiver instance

Implements Apache.Qpid.Proton.Client.IConnection.

◆ OpenDurableReceiverAsync()

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

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
addressThe address of the node the receiver attaches to
subscriptionNameThe subscription name to use for the receiver
optionsOptional receiver options to use for configuration
Returns
A Task that returns a new receiver instance when completed

Implements Apache.Qpid.Proton.Client.IConnection.

◆ OpenDynamicReceiver()

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

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
optionsOptional receiver options to use for configuration
dynamicNodePropertiesOptional properties to assign to the node create
Returns
A new receiver instance

Implements Apache.Qpid.Proton.Client.IConnection.

◆ OpenDynamicReceiverAsync()

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

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
optionsOptional receiver options to use for configuration
dynamicNodePropertiesOptional properties to assign to the node create
Returns
A Task that returns a new receiver instance when completed

Implements Apache.Qpid.Proton.Client.IConnection.

◆ OpenReceiver()

IReceiver Apache.Qpid.Proton.Client.Implementation.ClientConnection.OpenReceiver ( string  address,
ReceiverOptions  options = null 
)
inline

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
addressThe address of the node the receiver attaches to
optionsOptional receiver options to use for configuration
Returns
A new receiver instance

Implements Apache.Qpid.Proton.Client.IConnection.

◆ OpenReceiverAsync()

Task< IReceiver > Apache.Qpid.Proton.Client.Implementation.ClientConnection.OpenReceiverAsync ( string  address,
ReceiverOptions  options = null 
)
inline

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
addressThe address of the node the receiver attaches to
optionsOptional receiver options to use for configuration
Returns
A Task that returns a new receiver instance when completed

Implements Apache.Qpid.Proton.Client.IConnection.

◆ OpenSender()

ISender Apache.Qpid.Proton.Client.Implementation.ClientConnection.OpenSender ( string  address,
SenderOptions  options = null 
)
inline

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
addressThe address of the node the sender attaches to
optionsOptional sender options to use for configuration
Returns
A new sender instance.

Implements Apache.Qpid.Proton.Client.IConnection.

◆ OpenSenderAsync()

Task< ISender > Apache.Qpid.Proton.Client.Implementation.ClientConnection.OpenSenderAsync ( string  address,
SenderOptions  options = null 
)
inline

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
addressThe address of the node the sender attaches to
optionsOptional sender options to use for configuration
Returns
A Task that returns a new sender instance when completed

Implements Apache.Qpid.Proton.Client.IConnection.

◆ OpenSession()

ISession Apache.Qpid.Proton.Client.Implementation.ClientConnection.OpenSession ( SessionOptions  options = null)
inline

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
optionsOptional session options to use for configuration
Returns
A new session instance.

Implements Apache.Qpid.Proton.Client.IConnection.

◆ OpenSessionAsync()

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

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
optionsOptional session options to use for configuration
Returns
A Task that result in a new session instance.

Implements Apache.Qpid.Proton.Client.IConnection.

◆ OpenStreamReceiver()

IStreamReceiver Apache.Qpid.Proton.Client.Implementation.ClientConnection.OpenStreamReceiver ( string  address,
StreamReceiverOptions  options = null 
)
inline

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
addressThe address of the node the receiver attaches to
optionsOptional receiver options to use for configuration
Returns
A new receiver instance

Implements Apache.Qpid.Proton.Client.IConnection.

◆ OpenStreamReceiverAsync()

Task< IStreamReceiver > Apache.Qpid.Proton.Client.Implementation.ClientConnection.OpenStreamReceiverAsync ( string  address,
StreamReceiverOptions  options = null 
)
inline

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
addressThe address of the node the receiver attaches to
optionsOptional receiver options to use for configuration
Returns
A Task that returns a new stream receiver instance when completed

Implements Apache.Qpid.Proton.Client.IConnection.

◆ OpenStreamSender()

IStreamSender Apache.Qpid.Proton.Client.Implementation.ClientConnection.OpenStreamSender ( string  address,
StreamSenderOptions  options = null 
)
inline

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
addressThe address of the node the sender attaches to
optionsOptional stream sender options to use for configuration
Returns
A new sender instance.

Implements Apache.Qpid.Proton.Client.IConnection.

◆ OpenStreamSenderAsync()

Task< IStreamSender > Apache.Qpid.Proton.Client.Implementation.ClientConnection.OpenStreamSenderAsync ( string  address,
StreamSenderOptions  options = null 
)
inline

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
addressThe address of the node the sender attaches to
optionsOptional stream sender options to use for configuration
Returns
A Task that returns a new sender instance when completed

Implements Apache.Qpid.Proton.Client.IConnection.

◆ Send< T >()

ITracker Apache.Qpid.Proton.Client.Implementation.ClientConnection.Send< T > ( IMessage< T >  message)
inline

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
TThe type of body the message carries
Parameters
messageThe message to be sent
Returns
A tracker instance that can be used to track the send outcome

Implements Apache.Qpid.Proton.Client.IConnection.

◆ SendAsync< T >()

Task< ITracker > Apache.Qpid.Proton.Client.Implementation.ClientConnection.SendAsync< T > ( IMessage< T >  message)
inline

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
TThe type of body the message carries
Parameters
messageThe message to be sent
Returns
A Task that results in a tracker instance that can be used to track the send outcome

Implements Apache.Qpid.Proton.Client.IConnection.

Property Documentation

◆ Client

IClient Apache.Qpid.Proton.Client.Implementation.ClientConnection.Client
get

Returns the parent client instance that created this connection.

Implements Apache.Qpid.Proton.Client.IConnection.

◆ DesiredCapabilities

IReadOnlyCollection<string> Apache.Qpid.Proton.Client.Implementation.ClientConnection.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.

Implements Apache.Qpid.Proton.Client.IConnection.

◆ OfferedCapabilities

IReadOnlyCollection<string> Apache.Qpid.Proton.Client.Implementation.ClientConnection.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.

Implements Apache.Qpid.Proton.Client.IConnection.

◆ OpenTask

Task<IConnection> Apache.Qpid.Proton.Client.Implementation.ClientConnection.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.

Implements Apache.Qpid.Proton.Client.IConnection.

◆ Properties

IReadOnlyDictionary<string, object> Apache.Qpid.Proton.Client.Implementation.ClientConnection.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.

Implements Apache.Qpid.Proton.Client.IConnection.


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