net.solarnetwork.io.modbus

Interface ModbusClientConfig

public interface ModbusClientConfig

API for Modbus client configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_AUTO_RECONNECT The default automatic reconnection setting.
static long	DEFAULT_RECONNECT_DELAY_SECS The default reconnection delay seconds.

Method Summary

Modifier and Type	Method and Description
default long	getAutoReconnectDelaySeconds() Get the number of seconds to delay attempting to automatically reestablish a connection when the isAutoReconnect() setting is enabled.
String	getDescription() Get a description of this Modbus client configuration.
default long	getSendMinimumDelayMs() Get a minimum delay between sending messages, in milliseconds.
default boolean	isAutoReconnect() Get the "auto reconnect" setting.

Field Detail

DEFAULT_AUTO_RECONNECT

static final boolean DEFAULT_AUTO_RECONNECT

The default automatic reconnection setting.

See Also:

Constant Field Values

DEFAULT_RECONNECT_DELAY_SECS

static final long DEFAULT_RECONNECT_DELAY_SECS

The default reconnection delay seconds.

See Also:

Constant Field Values

Method Detail

isAutoReconnect

default boolean isAutoReconnect()

Get the "auto reconnect" setting.

Returns:

true if the Modbus connection should try to maintain a persistent connection, and reestablish it if it fails/closes/ends for any reason; false to not automatically reestablish the connection if it fails

getAutoReconnectDelaySeconds

default long getAutoReconnectDelaySeconds()

Get the number of seconds to delay attempting to automatically reestablish a connection when the isAutoReconnect() setting is enabled.

Returns:

the number of seconds to delay before attempting to reestablish a failed/closed/ended connection and isAutoReconnect() returns true

getDescription

String getDescription()

Get a description of this Modbus client configuration.

This intention of this value is for use in logging and debugging contexts. It should return something meaningful and specific to the configuration, such as a description of the connection like the serial port name or TCP host and port.

Returns:

the configuration description, never null

getSendMinimumDelayMs

default long getSendMinimumDelayMs()

Get a minimum delay between sending messages, in milliseconds.

Returns:

the sending delay, or anything less than 1 for no delay

Since:

1.1