dnp3 (.NET API) 1.1.0
dnp3.OutstationServer Class Reference

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

Public Member Functions

void Shutdown ()
 Gracefully shutdown all the outstations associated to this server, stops the server and release resources. More...
 
Outstation AddOutstation (OutstationConfig config, IOutstationApplication application, IOutstationInformation information, IControlHandler controlHandler, IConnectionStateListener listener, AddressFilter filter)
 Add an outstation to the server. More...
 
void Bind ()
 Bind the server to the port and starts listening. Also starts all the outstations associated to it. More...
 

Static Public Member Functions

static OutstationServer CreateTcpServer (Runtime runtime, LinkErrorMode linkErrorMode, string address)
 Create a new TCP server. More...
 
static OutstationServer CreateTlsServer (Runtime runtime, LinkErrorMode linkErrorMode, string address, TlsServerConfig tlsConfig)
 Create a new TLS server. More...
 

Detailed Description

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

To add outstations to it, use OutstationServer.AddOutstation. Once all the outstations are added, the server can be started with OutstationServer.Bind.

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

Member Function Documentation

◆ AddOutstation()

Outstation dnp3.OutstationServer.AddOutstation ( OutstationConfig  config,
IOutstationApplication  application,
IOutstationInformation  information,
IControlHandler  controlHandler,
IConnectionStateListener  listener,
AddressFilter  filter 
)
inline

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 OutstationServer.Bind to run it.

Parameters
configOutstation configuration
applicationOutstation application callbacks
informationOutstation information callbacks
controlHandlerOutstation control handler
listenerListener for the connection state
filterAddress filter
Returns
Outstation handle
Exceptions
ParamException

◆ Bind()

void dnp3.OutstationServer.Bind ( )
inline

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

Exceptions
ParamException

◆ CreateTcpServer()

static OutstationServer dnp3.OutstationServer.CreateTcpServer ( Runtime  runtime,
LinkErrorMode  linkErrorMode,
string  address 
)
inlinestatic

Create a new TCP server.

To start it, use OutstationServer.Bind.

Parameters
runtimeRuntime to execute the server on
linkErrorModeControls how link errors are handled with respect to the TCP session
addressAddress to bind the server to e.g. 127.0.0.1:20000
Returns
New TCP server instance
Exceptions
ParamException

◆ CreateTlsServer()

static OutstationServer dnp3.OutstationServer.CreateTlsServer ( Runtime  runtime,
LinkErrorMode  linkErrorMode,
string  address,
TlsServerConfig  tlsConfig 
)
inlinestatic

Create a new TLS server.

To start it, use OutstationServer.Bind.

Parameters
runtimeRuntime to execute the server on
linkErrorModeControls how link errors are handled with respect to the session
addressAddress to bind the server to e.g. 127.0.0.1:20000
tlsConfigTLS server configuration
Returns
New TLS server instance
Exceptions
ParamException

◆ Shutdown()

void dnp3.OutstationServer.Shutdown ( )
inline

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


The documentation for this class was generated from the following file: