dnp3::RestartDelay Struct Reference

Restart delay used by OutstationApplication::cold_restart() and OutstationApplication::warm_restart() More...

#include <dnp3.hpp>

Static Public Member Functions
static RestartDelay	not_supported ()
	RestartDelay indicating that the request is not supported. More...
static RestartDelay	seconds (uint16_t value)
	RestartDelay with a count of seconds. More...
static RestartDelay	milliseconds (uint16_t value)
	RestartDelay with a count of milliseconds. More...

Public Attributes
RestartDelayType	restart_type
	Indicates what RestartDelay::value is. More...
uint16_t	value
	Expected delay before the outstation comes back online. More...

Friends
class	CppRestartDelayFriend

Detailed Description

Restart delay used by OutstationApplication::cold_restart() and OutstationApplication::warm_restart()

If RestartDelay::restart_type is not RestartDelayType::not_supported, then the RestartDelay::value is valid. Otherwise, the outstation will return IIN2.0 NO_FUNC_CODE_SUPPORT.

Member Function Documentation

milliseconds()

static RestartDelay dnp3::RestartDelay::milliseconds ( uint16_t  value )

static

RestartDelay with a count of milliseconds.

Note

Values are initialized to:

• RestartDelay::restart_type : RestartDelayType::milli_seconds

Parameters

value

Expected delay before the outstation comes back online.

Returns

New instance of RestartDelay

not_supported()

static RestartDelay dnp3::RestartDelay::not_supported ( )

static

RestartDelay indicating that the request is not supported.

Note

Values are initialized to:

• RestartDelay::restart_type : RestartDelayType::not_supported
• RestartDelay::value : 0

Returns

New instance of RestartDelay

seconds()

static RestartDelay dnp3::RestartDelay::seconds ( uint16_t  value )

static

RestartDelay with a count of seconds.

Note

Values are initialized to:

• RestartDelay::restart_type : RestartDelayType::seconds

Parameters

value

Expected delay before the outstation comes back online.

Returns

New instance of RestartDelay

Member Data Documentation

restart_type

RestartDelayType dnp3::RestartDelay::restart_type

Indicates what RestartDelay::value is.

value

uint16_t dnp3::RestartDelay::value

Expected delay before the outstation comes back online.

---

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

• dnp3.hpp