dnp3.Outstation Class Reference

Outstation handle More...

Public Member Functions
void	Enable ()
	enable communications More...
void	Disable ()
	disable communications More...
void	Transaction (Action< Database > callback)
	Acquire a mutex on the underlying database and apply a set of changes as a transaction More...
void	SetDecodeLevel (DecodeLevel level)
	Set decoding log level More...

Static Public Member Functions
static Outstation	CreateSerialSession (Runtime runtime, string serialPath, SerialSettings settings, OutstationConfig config, IOutstationApplication application, IOutstationInformation information, IControlHandler controlHandler)
	Create an outstation instance running on a serial port More...
static Outstation	CreateSerialSessionFaultTolerant (Runtime runtime, string serialPath, SerialSettings settings, TimeSpan openRetryDelay, OutstationConfig config, IOutstationApplication application, IOutstationInformation information, IControlHandler controlHandler)
	This method is implemented in terms of Outstation.CreateSerialSession2 but without a port listener More...
static Outstation	CreateSerialSession2 (Runtime runtime, string serialPath, SerialSettings settings, TimeSpan openRetryDelay, OutstationConfig config, IOutstationApplication application, IOutstationInformation information, IControlHandler controlHandler, IPortStateListener portListener)
	Create an outstation instance running on a serial port which is tolerant to the serial port being added and removed More...
static Outstation	CreateTcpClient (Runtime runtime, LinkErrorMode linkErrorMode, EndpointList endpoints, ConnectStrategy connectStrategy, ConnectOptions connectOptions, OutstationConfig config, IOutstationApplication application, IOutstationInformation information, IControlHandler controlHandler, IClientStateListener listener)
	Create an outstation instance running as a TCP client More...
static Outstation	CreateTlsClient (Runtime runtime, LinkErrorMode linkErrorMode, EndpointList endpoints, ConnectStrategy connectStrategy, ConnectOptions connectOptions, OutstationConfig config, IOutstationApplication application, IOutstationInformation information, IControlHandler controlHandler, IClientStateListener listener, TlsClientConfig tlsConfig)
	Create an outstation instance running as a TLS client More...

Detailed Description

Outstation handle

Use this handle to modify the internal database.

Member Function Documentation

CreateSerialSession()

static Outstation dnp3.Outstation.CreateSerialSession ( Runtime  runtime, string  serialPath, SerialSettings  settings, OutstationConfig  config, IOutstationApplication  application, IOutstationInformation  information, IControlHandler  controlHandler  )

inlinestatic

Create an outstation instance running on a serial port

The port is opened immediately on the calling thread and fails if not successful

Warning: Most users should prefer the fault tolerant version of the this method Outstation.CreateSerialSessionFaultTolerant

Parameters

runtime	runtime on which to spawn the outstation
serialPath	Path of the serial device
settings	settings for the serial port
config	outstation configuration
application	application interface
information	informational events interface
controlHandler	control handler interface

Returns

Outstation instance or null if the port cannot be opened

Exceptions

ParamException

CreateSerialSession2()

static Outstation dnp3.Outstation.CreateSerialSession2 ( Runtime  runtime, string  serialPath, SerialSettings  settings, TimeSpan  openRetryDelay, OutstationConfig  config, IOutstationApplication  application, IOutstationInformation  information, IControlHandler  controlHandler, IPortStateListener  portListener  )

inlinestatic

Create an outstation instance running on a serial port which is tolerant to the serial port being added and removed

Parameters

runtime	runtime on which to spawn the outstation
serialPath	Path of the serial device
settings	settings for the serial port
openRetryDelay	delay between attempts to open the serial port
config	outstation configuration
application	application interface
information	informational events interface
controlHandler	control handler interface
portListener	port state listener

Returns

Outstation instance or null if the port cannot be opened

Exceptions

ParamException

CreateSerialSessionFaultTolerant()

static Outstation dnp3.Outstation.CreateSerialSessionFaultTolerant ( Runtime  runtime, string  serialPath, SerialSettings  settings, TimeSpan  openRetryDelay, OutstationConfig  config, IOutstationApplication  application, IOutstationInformation  information, IControlHandler  controlHandler  )

inlinestatic

This method is implemented in terms of Outstation.CreateSerialSession2 but without a port listener

Parameters

runtime	runtime on which to spawn the outstation
serialPath	Path of the serial device
settings	settings for the serial port
openRetryDelay	delay between attempts to open the serial port
config	outstation configuration
application	application interface
information	informational events interface
controlHandler	control handler interface

Returns

Outstation instance or null if the port cannot be opened

Exceptions

ParamException

CreateTcpClient()

static Outstation dnp3.Outstation.CreateTcpClient ( Runtime  runtime, LinkErrorMode  linkErrorMode, EndpointList  endpoints, ConnectStrategy  connectStrategy, ConnectOptions  connectOptions, OutstationConfig  config, IOutstationApplication  application, IOutstationInformation  information, IControlHandler  controlHandler, IClientStateListener  listener  )

inlinestatic

Create an outstation instance running as a TCP client

Parameters

runtime	runtime on which to spawn the outstation
linkErrorMode	Controls how link errors are handled with respect to the TCP session
endpoints	List of IP endpoints.
connectStrategy	Controls the timing of (re)connection attempts
connectOptions	Options that control the TCP connection process
config	outstation configuration
application	application interface
information	informational events interface
controlHandler	control handler interface
listener	Connection listener used to receive updates on the status of the connection

Returns

Outstation instance

Exceptions

ParamException

CreateTlsClient()

static Outstation dnp3.Outstation.CreateTlsClient ( Runtime  runtime, LinkErrorMode  linkErrorMode, EndpointList  endpoints, ConnectStrategy  connectStrategy, ConnectOptions  connectOptions, OutstationConfig  config, IOutstationApplication  application, IOutstationInformation  information, IControlHandler  controlHandler, IClientStateListener  listener, TlsClientConfig  tlsConfig  )

inlinestatic

Create an outstation instance running as a TLS client

Parameters

runtime	runtime on which to spawn the outstation
linkErrorMode	Controls how link errors are handled with respect to the TCP session
endpoints	List of IP endpoints.
connectStrategy	Controls the timing of (re)connection attempts
connectOptions	Options that control the TCP connection process
config	outstation configuration
application	application interface
information	informational events interface
controlHandler	control handler interface
listener	Connection listener used to receive updates on the status of the connection
tlsConfig	TLS client configuration

Returns

Outstation instance

Exceptions

ParamException

Disable()

void dnp3.Outstation.Disable ( )

inline

disable communications

Exceptions

ParamException

Enable()

void dnp3.Outstation.Enable ( )

inline

enable communications

Exceptions

ParamException

SetDecodeLevel()

void dnp3.Outstation.SetDecodeLevel ( DecodeLevel  level )

inline

Set decoding log level

Parameters

level

Decode log

Exceptions

ParamException

Transaction()

void dnp3.Outstation.Transaction ( Action< Database >  callback )

inline

Acquire a mutex on the underlying database and apply a set of changes as a transaction

Parameters

callback

Interface on which to execute the transaction

---

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

• Outstation.cs