AMQP Sender link resource. More...
Inheritance diagram for Apache.Qpid.Proton.Engine.ISender:
Public Member Functions | |
| ISender | Drained () |
| Called when the remote receiver has requested a drain of credit and the sender has sent all available messages. More... | |
| IOutgoingDelivery | Next () |
| When there has been no deliveries so far or the current delivery has reached a complete state this method updates the current delivery to a new instance and returns that value. If the current delivery has not been completed by either calling a completing API method then this method will throw an exception to indicate the sender state cannot allow a new delivery to be started. More... | |
| ISender | Disposition (Predicate< IOutgoingDelivery > filter, IDeliveryState state, bool settle) |
| For each unsettled outgoing delivery that is pending in the sender apply the given predicate and if it matches then apply the given delivery state and settled value to it. More... | |
| ISender | Settle (Predicate< IOutgoingDelivery > filter) |
| For each unsettled outgoing delivery that is pending in the sender apply the given predicate and if it matches then settle the delivery. More... | |
| ISender | DeliveryStateUpdatedHandler (Action< IOutgoingDelivery > handler) |
| Handler for updates for deliveries that have previously been sent. Updates can happen when the remote settles or otherwise modifies the delivery and the user needs to act on those changes. More... | |
 Public Member Functions inherited from Apache.Qpid.Proton.Engine.ILink< ISender > | |
| T | Detach () |
| Detaches the local end of the link if not already closed or detached. More... | |
| T | LocalDetachHandler (Action< T > localDetachHandler) |
| Sets a Action for when an this endpoint is closed locally via a call to Close. This is a convenience event that supplements the normal locally closed event point if set. If no local detached event handler is set the endpoint will route the detached event to the local closed event handler if set and allow it to process the event in one location. Typically used by clients for logging or other state update event processing. Clients should not perform any blocking calls within this context. It is an error for the handler to throw an exception and the outcome of doing so is undefined. More... | |
| T | DetachHandler (Action< T > detachHandler) |
| Sets a EventHandler for when an AMQP detach frame is received from the remote peer. This is a convenience event that supplements the normal link closed event point if set. If no detached event handler is set the endpoint will route the detached event to the closed event handler if set and allow it to process the event in one location. More... | |
| T | CreditStateUpdateHandler (Action< T > handler) |
| Handler for link credit updates that occur after a remote flow frame arrives. More... | |
| T | ParentEndpointClosedHandler (Action< T > handler) |
| Sets a Action delegate for when the parent Session or Connection of this link is locally closed. Typically used by clients for logging or other state update event processing. Clients should not perform any blocking calls within this context. It is an error for the handler to throw an exception and the outcome of doing so is undefined. More... | |
Properties | |
| bool | IsSendable [get] |
| Checks if the sender has credit and the session window allows for any bytes to be written currently. More... | |
| IOutgoingDelivery | Current [get] |
| Gets the current outgoing delivery for this sender if one is available. The sender only tracks a current delivery in the case that the next method has bee called and if any bytes are written to the delivery using the streaming based API outgoing delivery stream bytes methods which allows for later writing of additional bytes to the delivery. Once the write bytes method or the complete API is called the final transfer is written indicating that the delivery is complete and the current delivery value is reset. An outgoing delivery that is being streamed may also be completed by calling the abort method of the outgoing delivery API. More... | |
| IReadOnlyCollection< IOutgoingDelivery > | Unsettled [get] |
| Retrieves the list of unsettled deliveries sent from this sender. The deliveries in the enumerator cannot be written to but can have their settled state and disposition updated. Only when this sender settles on its end are the outgoing delivery instances removed from the unsettled tracking. More... | |
| bool | HasUnsettled [get] |
| Returns true if the sender link is tracking any unsettled sent deliveries. More... | |
| IDeliveryTagGenerator | DeliveryTagGenerator [get, set] |
| Configures a delivery tag generator that will be used to create and set a delivery tag value on each new outgoing delivery that is created and returned from the sender next delivery method. More... | |
| Properties inherited from Apache.Qpid.Proton.Engine.ILink< ISender > | |
| bool | IsLocallyDetached [get] |
| Returns true if the endpoint having been previously locally opened is now detached due to a call the the detach method. This does not reflect the state of the remote endpoint and that should be checked separately. More... | |
| bool | IsLocallyClosedOrDetached [get] |
| Returns true if the endpoint having been previously locally opened is now detached or closed due to a call to either the close method or the detach method. This does not reflect the state of the remote endpoint and that should be checked separately. More... | |
| LinkState | LinkState [get] |
| Gets the current state of the local end of the link object. More... | |
| uint | Credit [get] |
| Reads the credit that is currently available on or assigned to this link object. More... | |
| bool | IsDraining [get] |
| Indicates if the link is draining. For a sender link this indicates that the remote has requested that the sender transmit deliveries up to the currently available credit or indicate that it has no more to send. For a receiver this indicates that the Receiver has requested that the remote sender consume its outstanding credit. More... | |
| Role | Role [get] |
| Reads the role assigned to the local end of the link. More... | |
| bool | IsSender [get] |
| Returns if this link is a sender link. More... | |
| bool | IsReceiver [get] |
| Returns if this link is a receiver link. More... | |
| IConnection | Connection [get] |
| Provides access to the connection that owns this sender endpoint. More... | |
| ISession | Session [get] |
| Provides access to the session that owns this sender endpoint. More... | |
| string | Name [get] |
| Access the name that was given to the link on creation. More... | |
| SenderSettleMode | SenderSettleMode [get, set] |
| Access the sender settle mode. Should only be called during link set-up, i.e. before calling open. If this endpoint is the initiator of the link, this method can be used to set a value other than the default. If this endpoint is not the initiator, this method should be used to set a local value. According to the AMQP spec, the application may choose to accept the sender's suggestion (accessed by calling the remote sender settle mode API) or choose another value. The value has no effect on Proton, but may be useful to the application at a later point. In order to be AMQP compliant the application is responsible for honoring the settlement mode. More... | |
| ReceiverSettleMode | ReceiverSettleMode [get, set] |
| Access the receiver settle mode. Should only be called during link set-up, i.e. before calling open. If this endpoint is the initiator of the link, this method can be used to set a value other than the default. More... | |
| Source | Source [get, set] |
| Sets the Source value to assign to the local end of this link. Must be called during link setup, i.e. before calling the open method. More... | |
| Source | RemoteSource [get] |
| Gets the Source value that was assigned by the remote end of the link. More... | |
| ITerminus | Terminus [get, set] |
| Gets the local Target terminus value as a generic terminus instance which the user can then interrogate to determine if it is a Target or a Coordinator instance. When set the value must be one of Target or Coordinator. More... | |
| ITerminus | RemoteTerminus [get] |
| Get the remote set Terminus either Target or Coordinator that is set once the remote sends its attach frame. More... | |
| Coordinator | Coordinator [get, set] |
| Attempt to access the local target terminus value as a Coordinator value. When reading if the target terminus is not a Coordinator the result is null. Must be called during link setup, i.e. before calling the open method. More... | |
| Target | Target [get, set] |
| Attempt to access the local target terminus value as a Target value. When reading if the target terminus is not a Target the result is null. Must be called during link setup, i.e. before calling the open method. More... | |
| ulong | MaxMessageSize [get, set] |
| Sets the local link max message size, to be conveyed to the peer via the Attach frame when attaching the link to the session. Null or 0 means no limit. Must be called during link setup, i.e. before calling the open method. More... | |
| bool | IsRemotelyDetached [get] |
| Returns true if this link is currently remotely detached meaning the state returned from the remote state accessor is equal to detached. A link is remotely detached after an Detach performative has been received from the remote with the close flag equal to false. More... | |
| bool | IsRemotelyClosedOrDetached [get] |
| Returns true if this link is currently remotely detached or closed meaning the state returned from the remote state accessor is equal to detached or to closed. A link is remotely detached after an Detach performative has been received from the remote with the close flag equal to false otherwise is considered closed.. More... | |
| SenderSettleMode | RemoteSenderSettleMode [get] |
| Gets the remote link sender settlement mode, as conveyed from the peer via the Attach frame when attaching the link to the session. More... | |
| ReceiverSettleMode | RemoteReceiverSettleMode [get] |
| Gets the remote link receiver settlement mode, as conveyed from the peer via the Attach frame when attaching the link to the session. More... | |
| LinkState | RemoteState [get] |
| Gets the current remote link state. More... | |
Detailed Description
AMQP Sender link resource.
Member Function Documentation
◆ DeliveryStateUpdatedHandler()
| ISender Apache.Qpid.Proton.Engine.ISender.DeliveryStateUpdatedHandler | ( | Action< IOutgoingDelivery > | handler | ) |
Handler for updates for deliveries that have previously been sent. Updates can happen when the remote settles or otherwise modifies the delivery and the user needs to act on those changes.
- Parameters
-
handler
- Returns
Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonSender.
◆ Disposition()
| ISender Apache.Qpid.Proton.Engine.ISender.Disposition | ( | Predicate< IOutgoingDelivery > | filter, |
| IDeliveryState | state, | ||
| bool | settle | ||
| ) |
For each unsettled outgoing delivery that is pending in the sender apply the given predicate and if it matches then apply the given delivery state and settled value to it.
- Parameters
-
filter The filter predicate that controls when disposition is applied state The delivery state to apply when the predicate matches settle Should the delivery be settled when the predicate matches.
- Returns
Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonSender.
◆ Drained()
| ISender Apache.Qpid.Proton.Engine.ISender.Drained | ( | ) |
Called when the remote receiver has requested a drain of credit and the sender has sent all available messages.
- Returns
- This sender instance
- Exceptions
-
InvalidOperationException If the link is not draining.
Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonSender.
◆ Next()
| IOutgoingDelivery Apache.Qpid.Proton.Engine.ISender.Next | ( | ) |
When there has been no deliveries so far or the current delivery has reached a complete state this method updates the current delivery to a new instance and returns that value. If the current delivery has not been completed by either calling a completing API method then this method will throw an exception to indicate the sender state cannot allow a new delivery to be started.
- Exceptions
-
InvalidOperationException If a current delivery is still incomplete
Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonSender.
◆ Settle()
| ISender Apache.Qpid.Proton.Engine.ISender.Settle | ( | Predicate< IOutgoingDelivery > | filter | ) |
For each unsettled outgoing delivery that is pending in the sender apply the given predicate and if it matches then settle the delivery.
- Parameters
-
filter
- Returns
Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonSender.
Property Documentation
◆ Current
|
get |
Gets the current outgoing delivery for this sender if one is available. The sender only tracks a current delivery in the case that the next method has bee called and if any bytes are written to the delivery using the streaming based API outgoing delivery stream bytes methods which allows for later writing of additional bytes to the delivery. Once the write bytes method or the complete API is called the final transfer is written indicating that the delivery is complete and the current delivery value is reset. An outgoing delivery that is being streamed may also be completed by calling the abort method of the outgoing delivery API.
◆ DeliveryTagGenerator
|
getset |
Configures a delivery tag generator that will be used to create and set a delivery tag value on each new outgoing delivery that is created and returned from the sender next delivery method.
◆ HasUnsettled
|
get |
Returns true if the sender link is tracking any unsettled sent deliveries.
◆ IsSendable
|
get |
Checks if the sender has credit and the session window allows for any bytes to be written currently.
◆ Unsettled
|
get |
Retrieves the list of unsettled deliveries sent from this sender. The deliveries in the enumerator cannot be written to but can have their settled state and disposition updated. Only when this sender settles on its end are the outgoing delivery instances removed from the unsettled tracking.
The documentation for this interface was generated from the following file:
- src/Proton/Engine/ISender.cs
