com.thomsonreuters.upa.valueadd.reactor

Class ConsumerWatchlistOptions

java.lang.Object

com.thomsonreuters.upa.valueadd.reactor.ConsumerWatchlistOptions

public class ConsumerWatchlistOptions
extends java.lang.Object

Consumer watchlist options.

Constructor Summary

Constructors

Constructor and Description
ConsumerWatchlistOptions()

Method Summary

Modifier and Type	Method and Description
ReactorChannelEventCallback	channelOpenCallback() Callback function that is provided when a channel is first opened by Reactor.connect.
void	channelOpenCallback(ReactorChannelEventCallback channelOpenCallback) Callback function that is provided when a channel is first opened by Reactor.connect.
void	clear() Clears this object for reuse.
boolean	enableWatchlist() Is the watchlist enabled.
void	enableWatchlist(boolean enableWatchlist) Enables the watchlist.
int	itemCountHint() Set to the number of items the application expects to request.
void	itemCountHint(int itemCountHint) Set to the number of items the application expects to request.
int	maxOutstandingPosts() Sets the maximum number of on-stream post acknowledgments that may be outstanding for the channel.
void	maxOutstandingPosts(int maxOutstandingPosts) Sets the maximum number of on-stream post acknowledgments that may be outstanding for the channel.
boolean	obeyOpenWindow() Controls whether item requests obey the OpenWindow provided by a service.
void	obeyOpenWindow(boolean obeyOpenWindow) Controls whether item requests obey the OpenWindow provided by a service.
int	postAckTimeout() Time a stream will wait for acknowledgment of an on-stream post, in milliseconds.
void	postAckTimeout(int postAckTimeout) Time a stream will wait for acknowledgment of an on-stream post, in milliseconds.
int	requestTimeout() Time a requested stream will wait for a response from the provider, in milliseconds.
void	requestTimeout(int requestTimeout) Time a requested stream will wait for a response from the provider, in milliseconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsumerWatchlistOptions

public ConsumerWatchlistOptions()

Method Detail

enableWatchlist

public boolean enableWatchlist()

Is the watchlist enabled.

Returns:

is the watchlist enabled

enableWatchlist

public void enableWatchlist(boolean enableWatchlist)

Enables the watchlist.

Parameters:

enableWatchlist - the enable watchlist

channelOpenCallback

public ReactorChannelEventCallback channelOpenCallback()

Callback function that is provided when a channel is first opened by Reactor.connect. This is only allowed when a watchlist is enabled and is optional.

Returns:

the channel open callback

channelOpenCallback

public void channelOpenCallback(ReactorChannelEventCallback channelOpenCallback)

Callback function that is provided when a channel is first opened by Reactor.connect. This is only allowed when a watchlist is enabled and is optional.

Parameters:

channelOpenCallback - the channel open callback

itemCountHint

public int itemCountHint()

Set to the number of items the application expects to request.

Returns:

the item count hint

itemCountHint

public void itemCountHint(int itemCountHint)

Set to the number of items the application expects to request.

Parameters:

itemCountHint - the item count hint

obeyOpenWindow

public boolean obeyOpenWindow()

Controls whether item requests obey the OpenWindow provided by a service.

Returns:

whether or not item requests obey OpenWindow

obeyOpenWindow

public void obeyOpenWindow(boolean obeyOpenWindow)

Controls whether item requests obey the OpenWindow provided by a service.

Parameters:

obeyOpenWindow - whether or not item requests obey OpenWindow

maxOutstandingPosts

public int maxOutstandingPosts()

Sets the maximum number of on-stream post acknowledgments that may be outstanding for the channel.

Returns:

the max outstanding posts

maxOutstandingPosts

public void maxOutstandingPosts(int maxOutstandingPosts)

Sets the maximum number of on-stream post acknowledgments that may be outstanding for the channel.

Parameters:

maxOutstandingPosts - the max outstanding posts

postAckTimeout

public int postAckTimeout()

Time a stream will wait for acknowledgment of an on-stream post, in milliseconds.

Returns:

the post acknowledgment timeout

postAckTimeout

public void postAckTimeout(int postAckTimeout)

Time a stream will wait for acknowledgment of an on-stream post, in milliseconds.

Parameters:

postAckTimeout - the post ack timeout

requestTimeout

public int requestTimeout()

Time a requested stream will wait for a response from the provider, in milliseconds.

Returns:

the request timeout

requestTimeout

public void requestTimeout(int requestTimeout)

Time a requested stream will wait for a response from the provider, in milliseconds.

Parameters:

requestTimeout - the request timeout

clear

public void clear()

Clears this object for reuse.