Package com.beanit.dnp3bean

Class Outstation.TcpBuilder

java.lang.Object

com.beanit.dnp3bean.Outstation.TcpBuilder

Enclosing class:

Outstation

public static final class Outstation.TcpBuilder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
Outstation	build()
Outstation.TcpBuilder	dataSource(DataSource dataSource)
Outstation.TcpBuilder	endPointType(TcpEndPointType type)	Sets the outstation's end point type.
Outstation.TcpBuilder	eventBuffer(EventBuffer eventBuffer)	Sets the event buffer used to buffer events.
Outstation.TcpBuilder	linkStatusRequestTimeout(java.time.Duration duration)	Sets the maximum idle duration after which a link status message is requested.
Outstation.TcpBuilder	linkStatusResponseTimeout(java.time.Duration duration)	Sets the time to wait for a link status after having sent a link status request.
Outstation.TcpBuilder	listeningPort(int port)	Sets the port to listen for an incoming connection by a master.
Outstation.TcpBuilder	localAddress(java.net.InetAddress localAddress)	Sets the local IP address.
Outstation.TcpBuilder	masterDlAddress(int address)	Sets the master data link address.
Outstation.TcpBuilder	masterHost(java.lang.String host)	Sets the host name or IP address of the master.
Outstation.TcpBuilder	masterPort(int port)	Sets the port of the master to connect to.
Outstation.TcpBuilder	masterWhitelist(java.util.List<java.lang.String> hosts)	Sets the list of IPs/domains from which masters may access this outstation.
Outstation.TcpBuilder	maxReceiveMessageFragmentSize(int size)	Sets the maximum message fragment size that can be received.
Outstation.TcpBuilder	maxSendMessageFragmentSize(int size)	Sets the maximum message fragment size for sending.
Outstation.TcpBuilder	outstationDlAddress(int address)	Sets the outstation data link address.
Outstation.TcpBuilder	reconnectInterval(java.time.Duration duration)	Sets the reconnect interval.
Outstation.TcpBuilder	reset()	Resets all parameters of this builder to their default value.
Outstation.TcpBuilder	solicitedConfirmTimeout(java.time.Duration duration)	Sets the maximum time to wait for an application confirmation to a solicited response message.
Outstation.TcpBuilder	tcpConnectionListener(TcpConnectionListener listener)	Sets the lister that is notified of TCP connection events.

Methods inherited from class java.lang.Object

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

Method Detail

reset

public Outstation.TcpBuilder reset()

Resets all parameters of this builder to their default value. This method may be useful if the builder shall be reused to create new associations from scratch but keep the ability to share resources between created associations.

Returns:

this builder

listeningPort

public Outstation.TcpBuilder listeningPort(int port)

Sets the port to listen for an incoming connection by a master. Allowed range: 1-65535. The default port is 20_000.

Parameters:

port - the port to listen for an incoming connection by a master

Returns:

this builder

localAddress

public Outstation.TcpBuilder localAddress(java.net.InetAddress localAddress)

Sets the local IP address. The local IP is used 1) as the local bind address when initiating TCP connections and 2) as the interface to listen for connections when in listening or dual-endpoint mode. Default is the wildcard/anylocal InetAddress. Specifying null is equivalent to passing the wildcard address. The wildcard address will cause 1) the system to choose the a valid IP for initiating connections and 2) to listen on all available interfaces when listening for connections.

Parameters:

localAddress - the local IP address, or null for the wildcard address

Returns:

this builder

masterWhitelist

public Outstation.TcpBuilder masterWhitelist(java.util.List<java.lang.String> hosts)

Sets the list of IPs/domains from which masters may access this outstation. Passing null or an empty list will allow anonymous masters. The default is null.

Two outstations listening on the same interface and port cannot have overlapping master whitelists. That is because otherwise the incoming connections cannot be uniquely assigned to an outstation. The build() method will fail if an outstation with an overlapping whitelist exists.

The whitelist can be specified in form of domains, IPs, and subnets. A subnet can be specified in the following form: 192.168.1.0/24.

Parameters:

hosts - the IPs/domains that may access this outstation

Returns:

this builder

masterHost

public Outstation.TcpBuilder masterHost(java.lang.String host)

Sets the host name or IP address of the master. The hostname is only used when the outstation is in initiating or dual end point mode. The default is "localhost"

Parameters:

host - the host name or IP address of the master

Returns:

this builder

masterPort

public Outstation.TcpBuilder masterPort(int port)

Sets the port of the master to connect to. This port is only used when the outstation is in initiating or dual end point mode. Allowed range: 1-65535. The default port is 20_001.

Parameters:

port - the port to connect to

Returns:

this builder

endPointType

public Outstation.TcpBuilder endPointType(TcpEndPointType type)

Sets the outstation's end point type. The default is LISTENING.

Parameters:

type - the end point type

Returns:

this builder

reconnectInterval

public Outstation.TcpBuilder reconnectInterval(java.time.Duration duration)

Sets the reconnect interval. The interval specifies the time to wait after a failed connection attempt or a closed connection util a new connection attempt shall be started. This interval is only relevant for initiating and dual end points.

A duration equal to Duration.ZERO disables reconnection. The default is 5 seconds.

Parameters:

duration - the reconnect interval

Returns:

this builder

tcpConnectionListener

public Outstation.TcpBuilder tcpConnectionListener(TcpConnectionListener listener)

Sets the lister that is notified of TCP connection events. Passing null disables notification.

Parameters:

listener - the listener that is notified of TCP connection events

Returns:

this builder

masterDlAddress

public Outstation.TcpBuilder masterDlAddress(int address)

Sets the master data link address. The default is 0. The allowed address range is 0-65519.

Parameters:

address - the master data link address

Returns:

this builder

outstationDlAddress

public Outstation.TcpBuilder outstationDlAddress(int address)

Sets the outstation data link address. The default is 1. The allowed address range is 0-65519.

Parameters:

address - the outstation data link address

Returns:

this builder

linkStatusRequestTimeout

public Outstation.TcpBuilder linkStatusRequestTimeout(java.time.Duration duration)

Sets the maximum idle duration after which a link status message is requested.

Link status messages are also called keep-alive or heartbeat messages. DNP3's link layer will send link status requests after the connection was idle (no messages have been exchanged) for the given duration. Any data link message received will reset the timer for sending link status requests.

Set to Duration.ZERO to disable link status requests. Default is 60s.

Parameters:

duration - idle duration after which a link status message is requested

Returns:

this builder

linkStatusResponseTimeout

public Outstation.TcpBuilder linkStatusResponseTimeout(java.time.Duration duration)

Sets the time to wait for a link status after having sent a link status request.

A duration equal to Duration.ZERO disables waiting for link status response messages. In this case is does not matter if a link status reply is received. The default timeout is 10s.

If no link status message is received on time, the TCP connection is closed before attempting to reconnect again (through initiation and/or listening).

Parameters:

duration - the time to wait for a link status response

Returns:

this builder

dataSource

public Outstation.TcpBuilder dataSource(DataSource dataSource)

eventBuffer

public Outstation.TcpBuilder eventBuffer(EventBuffer eventBuffer)

Sets the event buffer used to buffer events. An event buffer can be created using QueueEventBuffer.Builder. Alternatively you can provide your own implementation of EventBuffer.

Parameters:

eventBuffer - The event buffer to use

Returns:

this builder

maxSendMessageFragmentSize

public Outstation.TcpBuilder maxSendMessageFragmentSize(int size)

Sets the maximum message fragment size for sending. Messages that exceed this size are fragmented. Allowed range: 249-65535. The default is 2048. This setting does not limit the size of received message fragments.

Parameters:

size - the maximum message fragment size for sending

Returns:

this builder

maxReceiveMessageFragmentSize

public Outstation.TcpBuilder maxReceiveMessageFragmentSize(int size)

Sets the maximum message fragment size that can be received. Messages that exceed this size are discarded. Allowed range: 249-65535. The default is 4096.

Parameters:

size - the maximum message fragment size that can be received

Returns:

this builder

solicitedConfirmTimeout

public Outstation.TcpBuilder solicitedConfirmTimeout(java.time.Duration duration)

Sets the maximum time to wait for an application confirmation to a solicited response message.

Set to Duration.ZERO to disable this timeout. Default is 5s.

Parameters:

duration - maximum time to wait for a confirmation to a solicited response message

Returns:

this builder

build

public Outstation build()
                 throws ListeningEndPointException

Throws:

ListeningEndPointException