Package org.stellar.sdk.requests

Class OrderBookRequestBuilder

java.lang.Object

org.stellar.sdk.requests.RequestBuilder

org.stellar.sdk.requests.OrderBookRequestBuilder

public class OrderBookRequestBuilder
extends RequestBuilder

Builds requests connected to order book.

Nested Class Summary

Nested classes/interfaces inherited from class org.stellar.sdk.requests.RequestBuilder

RequestBuilder.Order

Constructor Summary

Constructors

Constructor	Description
OrderBookRequestBuilder(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl serverURI)

Method Summary

Modifier and Type	Method	Description
OrderBookRequestBuilder	buyingAsset(Asset asset)
RequestBuilder	cursor(String cursor)	Sets cursor parameter on the request.
OrderBookResponse	execute()
static OrderBookResponse	execute(okhttp3.OkHttpClient httpClient, okhttp3.HttpUrl uri)
RequestBuilder	order(RequestBuilder.Order direction)	Sets order parameter on the request.
OrderBookRequestBuilder	sellingAsset(Asset asset)
SSEStream<OrderBookResponse>	stream(EventListener<OrderBookResponse> listener)	An overloaded version of stream(EventListener, long) with default reconnect timeout.
SSEStream<OrderBookResponse>	stream(EventListener<OrderBookResponse> listener, long reconnectTimeout)	Allows to stream SSE events from horizon.

Methods inherited from class org.stellar.sdk.requests.RequestBuilder

limit, setAssetParameter, setAssetsParameter

Methods inherited from class java.lang.Object

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

Constructor Details

OrderBookRequestBuilder

public OrderBookRequestBuilder(okhttp3.OkHttpClient httpClient,
 okhttp3.HttpUrl serverURI)

Method Details

buyingAsset

public OrderBookRequestBuilder buyingAsset(Asset asset)

sellingAsset

public OrderBookRequestBuilder sellingAsset(Asset asset)

execute

public static OrderBookResponse execute(okhttp3.OkHttpClient httpClient,
 okhttp3.HttpUrl uri)
                                 throws IOException,
TooManyRequestsException

Throws:

IOException

TooManyRequestsException

stream

public SSEStream<OrderBookResponse> stream(EventListener<OrderBookResponse> listener,
 long reconnectTimeout)

Allows to stream SSE events from horizon. Certain endpoints in Horizon can be called in streaming mode using Server-Sent Events. This mode will keep the connection to horizon open and horizon will continue to return responses as ledgers close.

Parameters:

listener - OrderBookResponse implementation with OrderBookResponse type

reconnectTimeout - Custom stream connection timeout in ms

Returns:

EventSource object, so you can close() connection when not needed anymore

See Also:

• Server-Sent Events
• Response Format documentation

stream

public SSEStream<OrderBookResponse> stream(EventListener<OrderBookResponse> listener)

An overloaded version of stream(EventListener, long) with default reconnect timeout.

execute

public OrderBookResponse execute()
                          throws IOException,
TooManyRequestsException

Throws:

IOException

TooManyRequestsException

cursor

public RequestBuilder cursor(String cursor)

Description copied from class: RequestBuilder

Sets cursor parameter on the request. A cursor is a value that points to a specific location in a collection of resources. The cursor attribute itself is an opaque value meaning that users should not try to parse it.

Overrides:

cursor in class RequestBuilder

Parameters:

cursor - A cursor is a value that points to a specific location in a collection of resources.

See Also:

• Page documentation

order

public RequestBuilder order(RequestBuilder.Order direction)

Description copied from class: RequestBuilder

Sets order parameter on the request.

Overrides:

order in class RequestBuilder

Parameters:

direction - RequestBuilder.Order