Package org.apache.qpid.protonj2.client.impl

Class ClientStreamSender.ClientOutgoingEnvelope

java.lang.Object

org.apache.qpid.protonj2.client.impl.ClientStreamSender.ClientOutgoingEnvelope

All Implemented Interfaces:

org.apache.qpid.protonj2.client.impl.ClientTransactionContext.Sendable

Enclosing class:

ClientStreamSender

public static final class ClientStreamSender.ClientOutgoingEnvelope
extends java.lang.Object
implements org.apache.qpid.protonj2.client.impl.ClientTransactionContext.Sendable

Constructor Summary

Constructors

Constructor	Description
ClientOutgoingEnvelope(ClientStreamSender sender, OutgoingDelivery delivery, int messageFormat, ProtonBuffer payload, boolean complete, ClientFuture<StreamTracker> request)	Create a new In-flight Send instance that is a continuation on an existing delivery.

Method Summary

Modifier and Type	Method	Description
ClientStreamSender.ClientOutgoingEnvelope	abort()
boolean	aborted()
ClientException	createSendTimedOutException()
OutgoingDelivery	delivery()
void	discard()	If the context that is overseeing this send is in a failed state it can request that the send be discarded without notification to the sender that it failed, this occurs most often in an in-doubt transaction context where all work will be dropped once the user attempt to retire the transaction.
ClientStreamSender.ClientOutgoingEnvelope	failed(ClientException exception)
ProtonBuffer	payload()
void	send(DeliveryState state, boolean settled)	Performs the actual send of delivery data which might be enlisted in a transaction or may simply be a passed through based on the context and its state.
java.util.concurrent.ScheduledFuture<?>	sendTimeout()
void	sendTimeout(java.util.concurrent.ScheduledFuture<?> sendTimeout)	Sets the ScheduledFuture which should be used when a send cannot be immediately performed.
ClientStreamSender.ClientOutgoingEnvelope	succeeded()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientOutgoingEnvelope

public ClientOutgoingEnvelope(ClientStreamSender sender,
                              OutgoingDelivery delivery,
                              int messageFormat,
                              ProtonBuffer payload,
                              boolean complete,
                              ClientFuture<StreamTracker> request)

Create a new In-flight Send instance that is a continuation on an existing delivery.

Parameters:

sender - The ClientSender instance that is attempting to send this encoded message.

messageFormat - The message format code to assign the send if this is the first delivery.

delivery - The OutgoingDelivery context this envelope will be added to.

payload - The payload that comprises this portion of the send.

complete - Indicates if the encoded payload represents the complete transfer or if more is coming.

request - The requesting operation that initiated this send.

Method Detail

sendTimeout

public java.util.concurrent.ScheduledFuture<?> sendTimeout()

Returns:

the ScheduledFuture used to determine when the send should fail if no credit available to write.

sendTimeout

public void sendTimeout(java.util.concurrent.ScheduledFuture<?> sendTimeout)

Sets the ScheduledFuture which should be used when a send cannot be immediately performed.

Parameters:

sendTimeout - The ScheduledFuture that will fail the send if not cancelled once it has been performed.

payload

public ProtonBuffer payload()

delivery

public OutgoingDelivery delivery()

abort

public ClientStreamSender.ClientOutgoingEnvelope abort()

aborted

public boolean aborted()

discard

public void discard()

Description copied from interface: org.apache.qpid.protonj2.client.impl.ClientTransactionContext.Sendable

If the context that is overseeing this send is in a failed state it can request that the send be discarded without notification to the sender that it failed, this occurs most often in an in-doubt transaction context where all work will be dropped once the user attempt to retire the transaction.

Specified by:

discard in interface org.apache.qpid.protonj2.client.impl.ClientTransactionContext.Sendable

succeeded

public ClientStreamSender.ClientOutgoingEnvelope succeeded()

failed

public ClientStreamSender.ClientOutgoingEnvelope failed(ClientException exception)

send

public void send(DeliveryState state,
                 boolean settled)

Description copied from interface: org.apache.qpid.protonj2.client.impl.ClientTransactionContext.Sendable

Performs the actual send of delivery data which might be enlisted in a transaction or may simply be a passed through based on the context and its state. The sender need not be aware of this though as the context will provide a delivery state that is appropriate for this send which would encapsulate any sender provided delivery state.

Specified by:

send in interface org.apache.qpid.protonj2.client.impl.ClientTransactionContext.Sendable

Parameters:

state - Sender provided delivery state or context decorated version.

settled - If the send should be sent settled or not.

createSendTimedOutException

public ClientException createSendTimedOutException()