com.binance.client

Class SubscriptionOptions

java.lang.Object

com.binance.client.SubscriptionOptions

public class SubscriptionOptions
extends Object

The configuration for the subscription APIs

Constructor Summary

Constructors

Constructor and Description
SubscriptionOptions()
SubscriptionOptions(SubscriptionOptions options)

Method Summary

Modifier and Type	Method and Description
int	getConnectionDelayOnFailure()
int	getReceiveLimitMs()
String	getUri()
boolean	isAutoReconnect()
SubscriptionOptions	setAutoReconnect(boolean isAutoReconnect) When the connection lost is happening on the subscription line, specify whether the client reconnect to server automatically.
void	setConnectionDelayOnFailure(int connectionDelayOnFailure) If auto reconnect is enabled, specify the delay time before reconnect.
void	setReceiveLimitMs(int receiveLimitMs) Set the receive limit in millisecond.
void	setUri(String uri) Set the URI for subscription.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionOptions

public SubscriptionOptions(SubscriptionOptions options)

SubscriptionOptions

public SubscriptionOptions()

Method Detail

setUri

public void setUri(String uri)

Set the URI for subscription.

Parameters:

uri - The URI name like "wss://api.binance.pro".

setReceiveLimitMs

public void setReceiveLimitMs(int receiveLimitMs)

Set the receive limit in millisecond. If no message is received within this limit time, the connection will be disconnected.

Parameters:

receiveLimitMs - The receive limit in millisecond.

setConnectionDelayOnFailure

public void setConnectionDelayOnFailure(int connectionDelayOnFailure)

If auto reconnect is enabled, specify the delay time before reconnect.

Parameters:

connectionDelayOnFailure - The delay time in second.

setAutoReconnect

public SubscriptionOptions setAutoReconnect(boolean isAutoReconnect)

When the connection lost is happening on the subscription line, specify whether the client reconnect to server automatically.

The connection lost means:

• Caused by network problem
• The connection close triggered by server (happened every 24 hours)
• No any message can be received from server within a specified time, see setReceiveLimitMs(int) (int)}

Parameters:

isAutoReconnect - The boolean flag, true for enable, false for disable

Returns:

Return self for chaining

isAutoReconnect

public boolean isAutoReconnect()

getReceiveLimitMs

public int getReceiveLimitMs()

getConnectionDelayOnFailure

public int getConnectionDelayOnFailure()

getUri

public String getUri()