Public Member Functions | |
| override 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. | |
| override 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. | |
| override 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. | |
| override 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. | |
| override 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. | |
| override Task< IReceiver > | OpenDurableReceiverAsync (string address, string subscriptionName, ReceiverOptions options=null) |
| Creates a receiver used to consume messages from the given node address. The returned Task will allow the caller to wait for the creation of the receiver configured using the provided receiver options. | |
| override Task< IReceiver > | OpenDynamicReceiverAsync (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 Task will allow the caller to wait for the creation of the receiver configured using the provided receiver options. | |
| override Task< IReceiver > | OpenReceiverAsync (string address, ReceiverOptions options=null) |
| Creates a receiver used to consume messages from the given node address. The returned Task will allow the caller to wait for the creation of the receiver configured using the provided receiver options. | |
| override Task< ISender > | OpenSenderAsync (string address, SenderOptions options=null) |
| Creates a sender used to send messages to the given node address. The returned Task will allow the caller to wait for the creation of the receiver configured using the provided receiver options. | |
| override Task< ISender > | OpenAnonymousSenderAsync (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 Task will allow the caller to wait for the creation of the receiver configured using the provided receiver options. | |
| override 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. | |
| override Task< IReceiver > | NextReceiverAsync () |
| Returns a task that will complete only after a receiver created from this session 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 session options used to create this session, or the connection level policy if none was assigned to the session options. | |
| override IReceiver | NextReceiver (NextReceiverPolicy policy) |
| 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 value of the next receiver policy that is provided by the caller. | |
| override Task< IReceiver > | NextReceiverAsync (NextReceiverPolicy policy) |
| Returns a task that will complete only after a receiver created from this session 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. | |
| override IReceiver | NextReceiver (TimeSpan timeout) |
| Waits up to the given timeout 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. | |
| override Task< IReceiver > | NextReceiverAsync (TimeSpan timeout) |
| Returns a task that will complete once a receiver created from this session 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 session options used to create this session, or the connection level policy if none was assigned to the session options. | |
| override IReceiver | NextReceiver (NextReceiverPolicy policy, TimeSpan timeout) |
| Waits up to the given timeout 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 value of the next receiver policy that is provided by the caller. | |
| override Task< IReceiver > | NextReceiverAsync (NextReceiverPolicy policy, TimeSpan timeout) |
| Returns a task that will complete once a receiver created from this session 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. | |
 Public Member Functions inherited from Apache.Qpid.Proton.Client.Implementation.ClientSession | |
| ClientSession (ClientConnection connection, SessionOptions options, string sessionId, Engine.ISession session) | |
| void | Dispose () |
| void | Close (IErrorCondition error=null) |
| Initiates a close of the session 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 session resources. | |
| Task< ISession > | CloseAsync (IErrorCondition error=null) |
| Initiates a close of the session 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 session will be cleaned up and the Task signalled indicating completion. | |
| ISession | BeginTransaction () |
Opens a new transaction scoped to this Session if one is not already active. | |
| Task< ISession > | BeginTransactionAsync () |
Opens a new transaction scoped to this Session if one is not already active. The transaction will not be considered active until the returned Task is completed. | |
| ISession | CommitTransaction () |
| Commit the currently active transaction in this Session. | |
| Task< ISession > | CommitTransactionAsync () |
| Asynchronously commit the currently active transaction in this Session, the transaction cannot be considered retired until the Task has been completed. | |
| ISession | RollbackTransaction () |
| Roll back the currently active transaction in this Session. | |
| Task< ISession > | RollbackTransactionAsync () |
| Asynchronously roll back the currently active transaction in this Session. | |
Additional Inherited Members | |
| Properties inherited from Apache.Qpid.Proton.Client.Implementation.ClientSession | |
| IClient | Client [get] |
| Returns the parent client instance that hosts this session. | |
| IConnection | Connection [get] |
| Returns the parent connection instance that created this session. | |
| Task< ISession > | OpenTask [get] |
| When a session 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 session. 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 session. 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 session. 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.ISession | |
Member Function Documentation
◆ NextReceiver() [1/4]
|
inlinevirtual |
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.
Reimplemented from Apache.Qpid.Proton.Client.Implementation.ClientSession.
◆ NextReceiver() [2/4]
|
inlinevirtual |
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 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
Reimplemented from Apache.Qpid.Proton.Client.Implementation.ClientSession.
◆ NextReceiver() [3/4]
|
inlinevirtual |
Waits up to the given timeout 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 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.
Reimplemented from Apache.Qpid.Proton.Client.Implementation.ClientSession.
◆ NextReceiver() [4/4]
|
inlinevirtual |
Waits up to the given timeout 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.
- Parameters
-
timeout The time to wait for a receiver to have a pending delivery
- Returns
Reimplemented from Apache.Qpid.Proton.Client.Implementation.ClientSession.
◆ NextReceiverAsync() [1/4]
|
inlinevirtual |
Returns a task that will complete only after a receiver created from this session 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 session options used to create this session, or the connection level policy if none was assigned to the session options.
- Returns
- A Task that results in the next receiver that has a pending delivery available based on policy.
Reimplemented from Apache.Qpid.Proton.Client.Implementation.ClientSession.
◆ NextReceiverAsync() [2/4]
|
inlinevirtual |
Returns a task that will complete only after a receiver created from this session 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.
Reimplemented from Apache.Qpid.Proton.Client.Implementation.ClientSession.
◆ NextReceiverAsync() [3/4]
|
inlinevirtual |
Returns a task that will complete once a receiver created from this session 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.
Reimplemented from Apache.Qpid.Proton.Client.Implementation.ClientSession.
◆ NextReceiverAsync() [4/4]
|
inlinevirtual |
Returns a task that will complete once a receiver created from this session 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 session options used to create this session, or the connection level policy if none was assigned to the session options.
- Parameters
-
timeout The time to wait for a receiver to have a pending delivery
- Returns
Reimplemented from Apache.Qpid.Proton.Client.Implementation.ClientSession.
◆ OpenAnonymousSender()
|
inlinevirtual |
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.
Reimplemented from Apache.Qpid.Proton.Client.Implementation.ClientSession.
◆ OpenAnonymousSenderAsync()
|
inlinevirtual |
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 Task will allow the caller to wait for the creation of the receiver configured using the provided receiver 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 Task<ISender> instance.
Reimplemented from Apache.Qpid.Proton.Client.Implementation.ClientSession.
◆ OpenDurableReceiver()
|
inlinevirtual |
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
Reimplemented from Apache.Qpid.Proton.Client.Implementation.ClientSession.
◆ OpenDurableReceiverAsync()
|
inlinevirtual |
Creates a receiver used to consume messages from the given node address. The returned Task will allow the caller to wait for the creation of the receiver 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 Task<Receiver> instance that can be awaited
Reimplemented from Apache.Qpid.Proton.Client.Implementation.ClientSession.
◆ OpenDynamicReceiver()
|
inlinevirtual |
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
Reimplemented from Apache.Qpid.Proton.Client.Implementation.ClientSession.
◆ OpenDynamicReceiverAsync()
|
inlinevirtual |
Creates a dynamic receiver used to consume messages from the dynamically generated node. on the remote. The returned Task will allow the caller to wait for the creation of the receiver 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
-
options Optional receiver options to use for configuration dynamicNodeProperties Optional properties to assign to the node create
- Returns
- A new Task<Receiver> instance that can be awaited
Reimplemented from Apache.Qpid.Proton.Client.Implementation.ClientSession.
◆ OpenReceiver()
|
inlinevirtual |
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
Reimplemented from Apache.Qpid.Proton.Client.Implementation.ClientSession.
◆ OpenReceiverAsync()
|
inlinevirtual |
Creates a receiver used to consume messages from the given node address. The returned Task will allow the caller to wait for the creation of the receiver 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 Task<Receiver> instance that can be awaited
Reimplemented from Apache.Qpid.Proton.Client.Implementation.ClientSession.
◆ OpenSender()
|
inlinevirtual |
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.
Reimplemented from Apache.Qpid.Proton.Client.Implementation.ClientSession.
◆ OpenSenderAsync()
|
inlinevirtual |
Creates a sender used to send messages to the given node address. The returned Task will allow the caller to wait for the creation of the receiver configured using the provided receiver 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
-
address The address of the node the sender attaches to options Optional sender options to use for configuration
- Returns
- A new Task<ISender> instance.
Reimplemented from Apache.Qpid.Proton.Client.Implementation.ClientSession.
The documentation for this class was generated from the following file:
- src/Proton.Client/Client/Implementation/ClientStreamSession.cs
