opendnp3  3.0.0
Reference implementation of DNP3 (IEEE-1815)
opendnp3::MasterParams Struct Reference

Configuration information for the dnp3 master. More...

#include <opendnp3/master/MasterParams.h>

Public Member Functions

 MasterParams ()
 Default constructor. More...
 

Public Attributes

IndexQualifierMode controlQualifierMode = IndexQualifierMode::always_two_bytes
 Control how the master chooses what qualifier to send when making requests The default behavior is to always use two bytes, but the one byte optimization can be enabled. More...
 
bool disableUnsolOnStartup = true
 If true, the master will disable unsol on startup for all 3 classes. More...
 
ClassField eventScanOnEventsAvailableClassMask = ClassField::None()
 Which classes should be requested in an event scan when detecting corresponding events available IIN. More...
 
bool ignoreRestartIIN = false
 If true, the master will not clear the restart IIN bit in response to detecting it set. More...
 
bool integrityOnEventOverflowIIN = true
 Defines whether an integrity scan will be performed when the EventBufferOverflow IIN is detected. More...
 
uint32_t maxRxFragSize = DEFAULT_MAX_APDU_SIZE
 maximum APDU rx size in bytes More...
 
TimeDuration maxTaskRetryPeriod = TimeDuration::Minutes(1)
 Maximum time delay before retrying a failed task. Backs off exponentially from taskRetryPeriod. More...
 
uint32_t maxTxFragSize = DEFAULT_MAX_APDU_SIZE
 maximum APDU tx size in bytes More...
 
TimeDuration responseTimeout = TimeDuration::Seconds(5)
 Application layer response timeout. More...
 
ClassField startupIntegrityClassMask = ClassField::AllClasses()
 Which classes should be requested in a startup integrity scan, defaults to 3/2/1/0 A mask equal to 0 means no startup integrity scan will be performed. More...
 
TimeDuration taskRetryPeriod = TimeDuration::Seconds(5)
 Time delay before retrying a failed task. More...
 
TimeDuration taskStartTimeout = TimeDuration::Seconds(10)
 Time delay before failing a non-recurring task (e.g. commands) that cannot start. More...
 
TimeSyncMode timeSyncMode = TimeSyncMode::None
 If true, the master will do time syncs when it sees the time IIN bit from the outstation. More...
 
ClassField unsolClassMask = ClassField::AllEventClasses()
 Bitwise mask used determine which classes are enabled for unsol, if 0 unsol is not enabled. More...
 

Detailed Description

Configuration information for the dnp3 master.

Definition at line 35 of file MasterParams.h.

Constructor & Destructor Documentation

◆ MasterParams()

opendnp3::MasterParams::MasterParams ( )
inline

Default constructor.

Definition at line 38 of file MasterParams.h.

Member Data Documentation

◆ controlQualifierMode

IndexQualifierMode opendnp3::MasterParams::controlQualifierMode = IndexQualifierMode::always_two_bytes

Control how the master chooses what qualifier to send when making requests The default behavior is to always use two bytes, but the one byte optimization can be enabled.

Definition at line 83 of file MasterParams.h.

◆ disableUnsolOnStartup

bool opendnp3::MasterParams::disableUnsolOnStartup = true

If true, the master will disable unsol on startup for all 3 classes.

Definition at line 47 of file MasterParams.h.

◆ eventScanOnEventsAvailableClassMask

ClassField opendnp3::MasterParams::eventScanOnEventsAvailableClassMask = ClassField::None()

Which classes should be requested in an event scan when detecting corresponding events available IIN.

Definition at line 63 of file MasterParams.h.

◆ ignoreRestartIIN

bool opendnp3::MasterParams::ignoreRestartIIN = false

If true, the master will not clear the restart IIN bit in response to detecting it set.

Definition at line 50 of file MasterParams.h.

◆ integrityOnEventOverflowIIN

bool opendnp3::MasterParams::integrityOnEventOverflowIIN = true

Defines whether an integrity scan will be performed when the EventBufferOverflow IIN is detected.

Definition at line 60 of file MasterParams.h.

◆ maxRxFragSize

uint32_t opendnp3::MasterParams::maxRxFragSize = DEFAULT_MAX_APDU_SIZE

maximum APDU rx size in bytes

Definition at line 78 of file MasterParams.h.

◆ maxTaskRetryPeriod

TimeDuration opendnp3::MasterParams::maxTaskRetryPeriod = TimeDuration::Minutes(1)

Maximum time delay before retrying a failed task. Backs off exponentially from taskRetryPeriod.

Definition at line 69 of file MasterParams.h.

◆ maxTxFragSize

uint32_t opendnp3::MasterParams::maxTxFragSize = DEFAULT_MAX_APDU_SIZE

maximum APDU tx size in bytes

Definition at line 75 of file MasterParams.h.

◆ responseTimeout

TimeDuration opendnp3::MasterParams::responseTimeout = TimeDuration::Seconds(5)

Application layer response timeout.

Definition at line 41 of file MasterParams.h.

◆ startupIntegrityClassMask

ClassField opendnp3::MasterParams::startupIntegrityClassMask = ClassField::AllClasses()

Which classes should be requested in a startup integrity scan, defaults to 3/2/1/0 A mask equal to 0 means no startup integrity scan will be performed.

Definition at line 57 of file MasterParams.h.

◆ taskRetryPeriod

TimeDuration opendnp3::MasterParams::taskRetryPeriod = TimeDuration::Seconds(5)

Time delay before retrying a failed task.

Definition at line 66 of file MasterParams.h.

◆ taskStartTimeout

TimeDuration opendnp3::MasterParams::taskStartTimeout = TimeDuration::Seconds(10)

Time delay before failing a non-recurring task (e.g. commands) that cannot start.

Definition at line 72 of file MasterParams.h.

◆ timeSyncMode

TimeSyncMode opendnp3::MasterParams::timeSyncMode = TimeSyncMode::None

If true, the master will do time syncs when it sees the time IIN bit from the outstation.

Definition at line 44 of file MasterParams.h.

◆ unsolClassMask

ClassField opendnp3::MasterParams::unsolClassMask = ClassField::AllEventClasses()

Bitwise mask used determine which classes are enabled for unsol, if 0 unsol is not enabled.

Definition at line 53 of file MasterParams.h.


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