io.stepfunc.dnp3

Class TcpServer

java.lang.Object

io.stepfunc.dnp3.TcpServer

public final class TcpServer
extends Object

TCP server that listens for connections and routes the messages to outstations.

To add outstations to it, use addOutstation(io.stepfunc.dnp3.OutstationConfig, io.stepfunc.dnp3.EventBufferConfig, io.stepfunc.dnp3.OutstationApplication, io.stepfunc.dnp3.OutstationInformation, io.stepfunc.dnp3.ControlHandler, io.stepfunc.dnp3.ConnectionStateListener, io.stepfunc.dnp3.AddressFilter). Once all the outstations are added, the server can be started with bind().

shutdown() is used to gracefully shutdown all the outstations and the server.

Constructor Summary

Constructors

Constructor and Description
TcpServer(Runtime runtime, LinkErrorMode linkErrorMode, String address) Create a new TCP server.

Method Summary

Modifier and Type	Method and Description
Outstation	addOutstation(OutstationConfig config, EventBufferConfig eventConfig, OutstationApplication application, OutstationInformation information, ControlHandler controlHandler, ConnectionStateListener listener, AddressFilter filter) Add an outstation to the server.
void	bind() Bind the server to the port and starts listening.
void	finalize()
void	shutdown() Gracefully shutdown all the outstations associated to this server, stops the server and release resources.

Methods inherited from class java.lang.Object

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

Constructor Detail

TcpServer

public TcpServer(Runtime runtime,
                 LinkErrorMode linkErrorMode,
                 String address)

Create a new TCP server.

To start it, use bind().

Parameters:

runtime - Runtime to execute the server on

linkErrorMode - Controls how link errors are handled with respect to the TCP session

address - Address to bind the server to e.g. 127.0.0.1:20000

Throws:

ParamException - ParamError

Method Detail

shutdown

public void shutdown()

Gracefully shutdown all the outstations associated to this server, stops the server and release resources.

finalize

public void finalize()

Overrides:

finalize in class Object

addOutstation

public Outstation addOutstation(OutstationConfig config,
                                EventBufferConfig eventConfig,
                                OutstationApplication application,
                                OutstationInformation information,
                                ControlHandler controlHandler,
                                ConnectionStateListener listener,
                                AddressFilter filter)

Add an outstation to the server.

The returned Outstation can be used to modify points of the outstation.

In order for the outstation to run, the TCP server must be running. Use bind() to run it.

Parameters:

config - Outstation configuration

eventConfig - Event buffer configuration

application - Outstation application callbacks

information - Outstation information callbacks

controlHandler - Outstation control handler

listener - Listener for the connection state

filter - Address filter

Returns:

Outstation handle

Throws:

ParamException - ParamError

bind

public void bind()

Bind the server to the port and starts listening. Also starts all the outstations associated to it.

Throws:

ParamException - ParamError