Package org.apache.qpid.protonj2.client

Class SenderOptions

java.lang.Object

org.apache.qpid.protonj2.client.LinkOptions<SenderOptions>

org.apache.qpid.protonj2.client.SenderOptions

All Implemented Interfaces:

java.lang.Cloneable

public class SenderOptions
extends LinkOptions<SenderOptions>
implements java.lang.Cloneable

Options that control the behavior of a Sender created from them.

Constructor Summary

Constructors

Constructor	Description
SenderOptions()	Create a new SenderOptions instance configured with default configuration settings.
SenderOptions(SenderOptions options)	Create a new SenderOptions instance that copies the configuration from the specified source options.

Method Summary

Modifier and Type	Method	Description
SenderOptions	clone()
protected SenderOptions	copyInto(SenderOptions other)	Copy all options from this SenderOptions instance into the instance provided.
protected SenderOptions	self()
long	sendTimeout()
SenderOptions	sendTimeout(long sendTimeout)	Configures the timeout used when awaiting a send operation to complete.
SenderOptions	sendTimeout(long timeout, java.util.concurrent.TimeUnit units)	Configures the timeout used when awaiting a send operation to complete.

Methods inherited from class org.apache.qpid.protonj2.client.LinkOptions

autoSettle, autoSettle, closeTimeout, closeTimeout, closeTimeout, copyInto, deliveryMode, deliveryMode, desiredCapabilities, desiredCapabilities, linkName, linkName, offeredCapabilities, offeredCapabilities, openTimeout, openTimeout, openTimeout, properties, properties, requestTimeout, requestTimeout, requestTimeout, sourceOptions, targetOptions

Methods inherited from class java.lang.Object

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

Constructor Detail

SenderOptions

public SenderOptions()

Create a new SenderOptions instance configured with default configuration settings.

SenderOptions

public SenderOptions(SenderOptions options)

Create a new SenderOptions instance that copies the configuration from the specified source options.

Parameters:

options - The SenderOptions instance whose settings are to be copied into this one.

Method Detail

sendTimeout

public long sendTimeout()

Returns:

the timeout used when awaiting a response from the remote when a resource is message send.

sendTimeout

public SenderOptions sendTimeout(long sendTimeout)

Configures the timeout used when awaiting a send operation to complete. A send will block if the remote has not granted the Sender or the Session credit to do so, if the send blocks for longer than this timeout the send call will fail with an ClientSendTimedOutException exception to indicate that the send did not complete.

Parameters:

sendTimeout - Timeout value in milliseconds to wait for a remote response.

Returns:

this SenderOptions instance.

sendTimeout

public SenderOptions sendTimeout(long timeout,
                                 java.util.concurrent.TimeUnit units)

Configures the timeout used when awaiting a send operation to complete. A send will block if the remote has not granted the Sender or the Session credit to do so, if the send blocks for longer than this timeout the send call will fail with an ClientSendTimedOutException exception to indicate that the send did not complete.

Parameters:

timeout - Timeout value to wait for a remote response.

units - The TimeUnit that defines the timeout span.

Returns:

this SenderOptions instance.

clone

public SenderOptions clone()

Overrides:

clone in class java.lang.Object

copyInto

protected SenderOptions copyInto(SenderOptions other)

Copy all options from this SenderOptions instance into the instance provided.

Parameters:

other - the target of this copy operation.

Returns:

the SenderOptions instance that was given.

self

protected SenderOptions self()

Specified by:

self in class LinkOptions<SenderOptions>

Returns:

the true derived type instance for use in this class.