com.ibm.mqlight.api

Class SendOptions.SendOptionsBuilder

java.lang.Object

com.ibm.mqlight.api.SendOptions.SendOptionsBuilder

Enclosing class:

SendOptions

public static class SendOptions.SendOptionsBuilder
extends Object

A builder for SendOptions objects.

Method Summary

Methods

Modifier and Type	Method and Description
SendOptions	build()
SendOptions.SendOptionsBuilder	setQos(QOS qos) Sets the quality of service that will be used to send messages to the MQ Light server.
SendOptions.SendOptionsBuilder	setRetainLink(boolean retainLink) Set the retainLink option.
SendOptions.SendOptionsBuilder	setTtl(long ttl) Sets the time to live that will be used for messages sent to the MQ Light server.

Methods inherited from class java.lang.Object

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

Method Detail

setQos

public SendOptions.SendOptionsBuilder setQos(QOS qos)
                                      throws IllegalArgumentException

Sets the quality of service that will be used to send messages to the MQ Light server.

Parameters:

qos - The required quality of service. Cannot be null.

Returns:

the instance of SendOptionsBuilder that this method was called on.

Throws:

IllegalArgumentException - if an invalid qos value is specified.

setTtl

public SendOptions.SendOptionsBuilder setTtl(long ttl)
                                      throws IllegalArgumentException

Sets the time to live that will be used for messages sent to the MQ Light server.

Parameters:

ttl - time to live in milliseconds. This must be a positive value, and a maximum of 4294967295 (0xFFFFFFFF)

Returns:

the instance of SendOptionsBuilder that this method was called on.

Throws:

IllegalArgumentException - if an invalid ttl value is specified.

setRetainLink

public SendOptions.SendOptionsBuilder setRetainLink(boolean retainLink)

Set the retainLink option. True by default this value will determine if the AMQP Link should be retained by the connection so that it can be re-used for subsequent messages. When a client will not send further messages to a given topic this value can be set to false to automatically close the Link after sending this message.

Parameters:

retainLink - true if the Link should be retained, false to close after message send.

Returns:

the instance of SendOptionsBuilder that this method was called on.

build

public SendOptions build()

Returns:

an instance of SendOptions based on the current settings of this builder.