com.micex.client

Class Client.Options

java.lang.Object

com.micex.client.Client.Options

Enclosing class:

Client

public static class Client.Options
extends Object

Options to customize the Client.

Constructor Summary

Constructors

Constructor and Description
Options()

Method Summary

Modifier and Type	Method and Description
boolean	isDirectBuffers() Check if the client is configured to create parsers which the caller code will execute immediately from the same thread.
boolean	isReorderRefresh() Check if client is configured to reorder requests when refreshing data.
void	setDirectBuffers(boolean enable) Enable the client to provide parsers with direct buffer access to the raw API data.
void	setReorderRefresh(boolean enable) Switches the client ability to reorder requests when refreshing data.

Methods inherited from class java.lang.Object

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

Constructor Detail

Options

public Options()

Method Detail

isDirectBuffers

public boolean isDirectBuffers()

Check if the client is configured to create parsers which the caller code will execute immediately from the same thread. Disabled by default.

Returns:

if client parsers are allowed to consume direct buffers.

Since:

1.3.0

See Also:

setDirectBuffers(boolean)

setDirectBuffers

public void setDirectBuffers(boolean enable)

Enable the client to provide parsers with direct buffer access to the raw API data. Disabled by default.

When enabled, the parsers provided by one of the load or open methods, must be executed immediately thereafter and by the same thread. To allow for delegating processing to another thread, caller must isolate the parser, which effectively copies direct API buffer to a byte array, providing for safe execution by another thread.

Parameters:

enable - enable direct buffer access.

Since:

1.3.0

isReorderRefresh

public boolean isReorderRefresh()

Check if client is configured to reorder requests when refreshing data. By default the client modifies the order of opened requests in an effort to provide uniform loading of data (periodically swaps heavy ORDERS and TRADES requests, and moves them bottom to allow for other requests to get a chance for an update). Disabling this behavior keeps the order of requests as they have been initially opened. One can still tune the order by providing a custom Sorter for Client.refresh(com.micex.client.Sorter).

Returns:

if client is allowed to reorder requests.

setReorderRefresh

public void setReorderRefresh(boolean enable)

Switches the client ability to reorder requests when refreshing data.

Parameters:

enable - enable built in reordering.

See Also:

isReorderRefresh()