Module java4ever.binding

Package tech.deplant.java4ever.binding

Record Class Client.NetworkConfig

java.lang.Object

java.lang.Record

tech.deplant.java4ever.binding.Client.NetworkConfig

Record Components:

serverAddress - **This field is deprecated, but left for backward-compatibility.** Evernode endpoint.

endpoints - Any correct URL format can be specified, including IP addresses. This parameter is prevailing over `server_address`. Check the full list of [supported network endpoints](https://docs.everos.dev/ever-sdk/reference/ever-os-api/networks). List of Evernode endpoints.

networkRetriesCount - You must use `network.max_reconnect_timeout` that allows to specify maximum network resolving timeout. Deprecated.

maxReconnectTimeout - Must be specified in milliseconds. Default is 120000 (2 min). Maximum time for sequential reconnections.

reconnectTimeout - Deprecated

messageRetriesCount - Default is 5. The number of automatic message processing retries that SDK performs in case of `Message Expired (507)` error - but only for those messages which local emulation was successful or failed with replay protection error.

messageProcessingTimeout - Must be specified in milliseconds. Default is 40000 (40 sec). Timeout that is used to process message delivery for the contracts which ABI does not include "expire" header. If the message is not delivered within the specified timeout the appropriate error occurs.

waitForTimeout - Must be specified in milliseconds. Default is 40000 (40 sec). Maximum timeout that is used for query response.

outOfSyncThreshold - If client's device time is out of sync and difference is more than the threshold then error will occur. Also an error will occur if the specified threshold is more than `message_processing_timeout/2`. Must be specified in milliseconds. Default is 15000 (15 sec). Maximum time difference between server and client.

sendingEndpointCount - Default is 1. Maximum number of randomly chosen endpoints the library uses to broadcast a message.

latencyDetectionInterval - Library periodically checks the current endpoint for blockchain data synchronization latency. If the latency (time-lag) is less then `NetworkConfig.max_latency` then library selects another endpoint. Must be specified in milliseconds. Default is 60000 (1 min). Frequency of sync latency detection.

maxLatency - Must be specified in milliseconds. Default is 60000 (1 min). Maximum value for the endpoint's blockchain data synchronization latency (time-lag). Library periodically checks the current endpoint for blockchain data synchronization latency. If the latency (time-lag) is less then `NetworkConfig.max_latency` then library selects another endpoint.

queryTimeout - Is is used when no timeout specified for the request to limit the answer waiting time. If no answer received during the timeout requests ends with error. Must be specified in milliseconds. Default is 60000 (1 min). Default timeout for http requests.

queriesProtocol - `HTTP` or `WS`. Default is `HTTP`. Queries protocol.

firstRempStatusTimeout - First REMP status awaiting timeout. If no status received during the timeout than fallback transaction scenario is activated. Must be specified in milliseconds. Default is 1 (1 ms) in order to start fallback scenario together with REMP statuses processing while REMP is not properly tuned yet. UNSTABLE.

nextRempStatusTimeout - Subsequent REMP status awaiting timeout. If no status received during the timeout than fallback transaction scenario is activated. Must be specified in milliseconds. Default is 5000 (5 sec). UNSTABLE.

signatureId - This parameter should be set to `global_id` field from any blockchain block if network can not be reachable at the moment of message encoding and the message is aimed to be sent into network with `CapSignatureWithId` enabled. Otherwise signature ID is detected automatically inside message encoding functions Network signature ID which is used by VM in signature verifying instructions if capability `CapSignatureWithId` is enabled in blockchain configuration parameters.

accessKey - Access key to GraphQL API (Project secret)

Enclosing class:

Client

public static record Client.NetworkConfig(String serverAddress, String[] endpoints, Integer networkRetriesCount, Integer maxReconnectTimeout, Integer reconnectTimeout, Integer messageRetriesCount, Integer messageProcessingTimeout, Integer waitForTimeout, Integer outOfSyncThreshold, Integer sendingEndpointCount, Integer latencyDetectionInterval, Integer maxLatency, Integer queryTimeout, Client.NetworkQueriesProtocol queriesProtocol, Integer firstRempStatusTimeout, Integer nextRempStatusTimeout, Integer signatureId, String accessKey)
extends Record

Constructor Summary

Constructors

Constructor

Description

NetworkConfig(String serverAddress, String[] endpoints, Integer networkRetriesCount, Integer maxReconnectTimeout, Integer reconnectTimeout, Integer messageRetriesCount, Integer messageProcessingTimeout, Integer waitForTimeout, Integer outOfSyncThreshold, Integer sendingEndpointCount, Integer latencyDetectionInterval, Integer maxLatency, Integer queryTimeout, Client.NetworkQueriesProtocol queriesProtocol, Integer firstRempStatusTimeout, Integer nextRempStatusTimeout, Integer signatureId, String accessKey)

Creates an instance of a NetworkConfig record class.

Method Summary

Modifier and Type	Method	Description
String	accessKey()	Returns the value of the accessKey record component.
String[]	endpoints()	Returns the value of the endpoints record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Integer	firstRempStatusTimeout()	Returns the value of the firstRempStatusTimeout record component.
final int	hashCode()	Returns a hash code value for this object.
Integer	latencyDetectionInterval()	Returns the value of the latencyDetectionInterval record component.
Integer	maxLatency()	Returns the value of the maxLatency record component.
Integer	maxReconnectTimeout()	Returns the value of the maxReconnectTimeout record component.
Integer	messageProcessingTimeout()	Returns the value of the messageProcessingTimeout record component.
Integer	messageRetriesCount()	Returns the value of the messageRetriesCount record component.
Integer	networkRetriesCount()	Returns the value of the networkRetriesCount record component.
Integer	nextRempStatusTimeout()	Returns the value of the nextRempStatusTimeout record component.
Integer	outOfSyncThreshold()	Returns the value of the outOfSyncThreshold record component.
Client.NetworkQueriesProtocol	queriesProtocol()	Returns the value of the queriesProtocol record component.
Integer	queryTimeout()	Returns the value of the queryTimeout record component.
Integer	reconnectTimeout()	Returns the value of the reconnectTimeout record component.
Integer	sendingEndpointCount()	Returns the value of the sendingEndpointCount record component.
String	serverAddress()	Returns the value of the serverAddress record component.
Integer	signatureId()	Returns the value of the signatureId record component.
final String	toString()	Returns a string representation of this record class.
Integer	waitForTimeout()	Returns the value of the waitForTimeout record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

NetworkConfig

public NetworkConfig(String serverAddress,
 String[] endpoints,
 Integer networkRetriesCount,
 Integer maxReconnectTimeout,
 Integer reconnectTimeout,
 Integer messageRetriesCount,
 Integer messageProcessingTimeout,
 Integer waitForTimeout,
 Integer outOfSyncThreshold,
 Integer sendingEndpointCount,
 Integer latencyDetectionInterval,
 Integer maxLatency,
 Integer queryTimeout,
 Client.NetworkQueriesProtocol queriesProtocol,
 Integer firstRempStatusTimeout,
 Integer nextRempStatusTimeout,
 Integer signatureId,
 String accessKey)

Creates an instance of a NetworkConfig record class.

Parameters:

serverAddress - the value for the serverAddress record component

endpoints - the value for the endpoints record component

networkRetriesCount - the value for the networkRetriesCount record component

maxReconnectTimeout - the value for the maxReconnectTimeout record component

reconnectTimeout - the value for the reconnectTimeout record component

messageRetriesCount - the value for the messageRetriesCount record component

messageProcessingTimeout - the value for the messageProcessingTimeout record component

waitForTimeout - the value for the waitForTimeout record component

outOfSyncThreshold - the value for the outOfSyncThreshold record component

sendingEndpointCount - the value for the sendingEndpointCount record component

latencyDetectionInterval - the value for the latencyDetectionInterval record component

maxLatency - the value for the maxLatency record component

queryTimeout - the value for the queryTimeout record component

queriesProtocol - the value for the queriesProtocol record component

firstRempStatusTimeout - the value for the firstRempStatusTimeout record component

nextRempStatusTimeout - the value for the nextRempStatusTimeout record component

signatureId - the value for the signatureId record component

accessKey - the value for the accessKey record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

serverAddress

public String serverAddress()

Returns the value of the serverAddress record component.

Returns:

the value of the serverAddress record component

endpoints

public String[] endpoints()

Returns the value of the endpoints record component.

Returns:

the value of the endpoints record component

networkRetriesCount

public Integer networkRetriesCount()

Returns the value of the networkRetriesCount record component.

Returns:

the value of the networkRetriesCount record component

maxReconnectTimeout

public Integer maxReconnectTimeout()

Returns the value of the maxReconnectTimeout record component.

Returns:

the value of the maxReconnectTimeout record component

reconnectTimeout

public Integer reconnectTimeout()

Returns the value of the reconnectTimeout record component.

Returns:

the value of the reconnectTimeout record component

messageRetriesCount

public Integer messageRetriesCount()

Returns the value of the messageRetriesCount record component.

Returns:

the value of the messageRetriesCount record component

messageProcessingTimeout

public Integer messageProcessingTimeout()

Returns the value of the messageProcessingTimeout record component.

Returns:

the value of the messageProcessingTimeout record component

waitForTimeout

public Integer waitForTimeout()

Returns the value of the waitForTimeout record component.

Returns:

the value of the waitForTimeout record component

outOfSyncThreshold

public Integer outOfSyncThreshold()

Returns the value of the outOfSyncThreshold record component.

Returns:

the value of the outOfSyncThreshold record component

sendingEndpointCount

public Integer sendingEndpointCount()

Returns the value of the sendingEndpointCount record component.

Returns:

the value of the sendingEndpointCount record component

latencyDetectionInterval

public Integer latencyDetectionInterval()

Returns the value of the latencyDetectionInterval record component.

Returns:

the value of the latencyDetectionInterval record component

maxLatency

public Integer maxLatency()

Returns the value of the maxLatency record component.

Returns:

the value of the maxLatency record component

queryTimeout

public Integer queryTimeout()

Returns the value of the queryTimeout record component.

Returns:

the value of the queryTimeout record component

queriesProtocol

public Client.NetworkQueriesProtocol queriesProtocol()

Returns the value of the queriesProtocol record component.

Returns:

the value of the queriesProtocol record component

firstRempStatusTimeout

public Integer firstRempStatusTimeout()

Returns the value of the firstRempStatusTimeout record component.

Returns:

the value of the firstRempStatusTimeout record component

nextRempStatusTimeout

public Integer nextRempStatusTimeout()

Returns the value of the nextRempStatusTimeout record component.

Returns:

the value of the nextRempStatusTimeout record component

signatureId

public Integer signatureId()

Returns the value of the signatureId record component.

Returns:

the value of the signatureId record component

accessKey

public String accessKey()

Returns the value of the accessKey record component.

Returns:

the value of the accessKey record component