Implements the stream sender using a stateful current outgoing message that prevents any sends other than to the current message until the current is completed. More...
Public Member Functions | |
| IStreamTracker | Send< T > (IMessage< T > message, IDictionary< string, object > deliveryAnnotations=null) |
| If no streaming send has been initiated and not yet completed then this method will send the given message immediately if there is credit available or blocks if the link has not yet been granted credit. If a send timeout has been configured then this method will throw a timed out error after that if the message cannot be sent. More... | |
| IStreamTracker | TrySend< T > (IMessage< T > message, IDictionary< string, object > deliveryAnnotations=null) |
| If no streaming send has been initiated and not yet completed then this method will send the given message if credit is available or returns null if no credit has been granted to the link at the time of the send attempt. More... | |
| Task< IStreamTracker > | SendAsync< T > (IMessage< T > message, IDictionary< string, object > deliveryAnnotations=null) |
| If no streaming send has been initiated and not yet completed then this method will send the given message immediately if there is credit available or waits if the link has not yet been granted credit. If a send timeout has been configured then this method will fail the returned Task with a timed out error after that if the message cannot be sent. The returned Task will be completed once the message has been sent. More... | |
| Task< IStreamTracker > | TrySendAsync< T > (IMessage< T > message, IDictionary< string, object > deliveryAnnotations=null) |
| If no streaming send has been initiated and not yet completed then this method will send the given message if credit is available or completes the returned Task with null if no credit has been granted to the link at the time of the send attempt. More... | |
| IStreamSenderMessage | BeginMessage (IDictionary< string, object > deliveryAnnotations=null) |
| Creates and returns a new streamable message that can be used by the caller to perform streaming sends of large message payload data. Only one streamed message can be active at a time so any successive calls to begin a new streaming message will throw an error to indicate that the previous instance has not yet been completed. More... | |
 Public Member Functions inherited from Apache.Qpid.Proton.Client.Implementation.ClientLinkType< IStreamSender, Engine.ISender > | |
| void | Close (IErrorCondition error=null) |
| Task< LinkType > | CloseAsync (IErrorCondition error=null) |
| void | Detach (IErrorCondition error=null) |
| Task< LinkType > | DetachAsync (IErrorCondition error=null) |
| void | Dispose () |
Additional Inherited Members | |
| Public Attributes inherited from Apache.Qpid.Proton.Client.Implementation.ClientLinkType< IStreamSender, Engine.ISender > | |
| IClient | Client |
| IConnection | Connection |
| ISession | Session |
| Task< LinkType > | OpenTask |
| Protected Member Functions inherited from Apache.Qpid.Proton.Client.Implementation.ClientLinkType< IStreamSender, Engine.ISender > | |
| virtual Task< LinkType > | DoCloseOrDetach (bool close, IErrorCondition error) |
| void | CheckClosedOrFailed () |
| void | WaitForOpenToComplete () |
| bool | NotClosedOrFailed< T > (TaskCompletionSource< T > request) |
| bool | NotClosedOrFailed< T > (TaskCompletionSource< T > request, ProtonLinkType sender) |
| Protected Attributes inherited from Apache.Qpid.Proton.Client.Implementation.ClientLinkType< IStreamSender, Engine.ISender > | |
| readonly AtomicBoolean | closed |
| readonly ClientSession | session |
| ClientException | failureCause |
| readonly TaskCompletionSource< LinkType > | openFuture |
| readonly TaskCompletionSource< LinkType > | closeFuture |
| volatile ISource | remoteSource |
| volatile ITarget | remoteTarget |
| ProtonLinkType | protonLink |
| Properties inherited from Apache.Qpid.Proton.Client.Implementation.ClientLinkType< IStreamSender, Engine.ISender > | |
| string??? | Address [get] |
| ISource | Source [get] |
| ITarget | Target [get] |
| IReadOnlyDictionary< string, object > | Properties [get] |
| IReadOnlyCollection< string > | OfferedCapabilities [get] |
| IReadOnlyCollection< string > | DesiredCapabilities [get] |
Detailed Description
Implements the stream sender using a stateful current outgoing message that prevents any sends other than to the current message until the current is completed.
Member Function Documentation
◆ BeginMessage()
|
inline |
Creates and returns a new streamable message that can be used by the caller to perform streaming sends of large message payload data. Only one streamed message can be active at a time so any successive calls to begin a new streaming message will throw an error to indicate that the previous instance has not yet been completed.
- Parameters
-
deliveryAnnotations The optional delivery annotations to transmit with the message
- Returns
- This stream sender instance
Implements Apache.Qpid.Proton.Client.IStreamSender.
◆ Send< T >()
|
inline |
If no streaming send has been initiated and not yet completed then this method will send the given message immediately if there is credit available or blocks if the link has not yet been granted credit. If a send timeout has been configured then this method will throw a timed out error after that if the message cannot be sent.
- Template Parameters
-
T The type that describes the message body
- Parameters
-
message The message object that will be sent deliveryAnnotations Optional delivery annotation to include with the message
- Returns
- A Tracker for the sent message
Implements Apache.Qpid.Proton.Client.IStreamSender.
◆ SendAsync< T >()
|
inline |
If no streaming send has been initiated and not yet completed then this method will send the given message immediately if there is credit available or waits if the link has not yet been granted credit. If a send timeout has been configured then this method will fail the returned Task with a timed out error after that if the message cannot be sent. The returned Task will be completed once the message has been sent.
- Template Parameters
-
T The type that describes the message body
- Parameters
-
message The message object that will be sent deliveryAnnotations Optional delivery annotation to include with the message
- Returns
- A Task that is completed with a Tracker once the send completes
Implements Apache.Qpid.Proton.Client.IStreamSender.
◆ TrySend< T >()
|
inline |
If no streaming send has been initiated and not yet completed then this method will send the given message if credit is available or returns null if no credit has been granted to the link at the time of the send attempt.
- Template Parameters
-
T The type that describes the message body
- Parameters
-
message The message object that will be sent deliveryAnnotations Optional delivery annotation to include with the message
- Returns
- A Tracker for the sent message or null if no credit to send is available
Implements Apache.Qpid.Proton.Client.IStreamSender.
◆ TrySendAsync< T >()
|
inline |
If no streaming send has been initiated and not yet completed then this method will send the given message if credit is available or completes the returned Task with null if no credit has been granted to the link at the time of the send attempt.
- Template Parameters
-
T The type that describes the message body
- Parameters
-
message The message object that will be sent deliveryAnnotations Optional delivery annotation to include with the message
- Returns
- A Task that provides a tracker if the send completes or null if no credit
Implements Apache.Qpid.Proton.Client.IStreamSender.
The documentation for this class was generated from the following file:
- src/Proton.Client/Client/Implementation/ClientStreamSender.cs
