dnp3::OutstationInformation Class Reference

Informational callbacks that the outstation doesn't rely on to function. More...

#include <dnp3.hpp>

Public Member Functions
virtual void	process_request_from_idle (const RequestHeader &header)=0
	Called when a request is processed from the IDLE state. More...
virtual void	broadcast_received (FunctionCode function_code, BroadcastAction action)=0
	Called when a broadcast request is received by the outstation. More...
virtual void	enter_solicited_confirm_wait (uint8_t ecsn)=0
	Outstation has begun waiting for a solicited confirm. More...
virtual void	solicited_confirm_timeout (uint8_t ecsn)=0
	Failed to receive a solicited confirm before the timeout occurred. More...
virtual void	solicited_confirm_received (uint8_t ecsn)=0
	Received the expected confirm. More...
virtual void	solicited_confirm_wait_new_request ()=0
	Received a new request while waiting for a solicited confirm, aborting the response series. More...
virtual void	wrong_solicited_confirm_seq (uint8_t ecsn, uint8_t seq)=0
	Received a solicited confirm with the wrong sequence number. More...
virtual void	unexpected_confirm (bool unsolicited, uint8_t seq)=0
	Received a confirm when not expecting one. More...
virtual void	enter_unsolicited_confirm_wait (uint8_t ecsn)=0
	Outstation has begun waiting for an unsolicited confirm. More...
virtual void	unsolicited_confirm_timeout (uint8_t ecsn, bool retry)=0
	Failed to receive an unsolicited confirm before the timeout occurred. More...
virtual void	unsolicited_confirmed (uint8_t ecsn)=0
	Master confirmed an unsolicited message. More...
virtual void	clear_restart_iin ()=0
	Master cleared the restart IIN bit. More...

Detailed Description

Informational callbacks that the outstation doesn't rely on to function.

It may be useful to certain applications to assess the health of the communication or to count statistics

Note

this class is an "interface" and only has pure virtual methods

Member Function Documentation

broadcast_received()

virtual void dnp3::OutstationInformation::broadcast_received ( FunctionCode  function_code, BroadcastAction  action  )

pure virtual

Called when a broadcast request is received by the outstation.

Parameters

function_code	Function code received
action	Broadcast action

clear_restart_iin()

virtual void dnp3::OutstationInformation::clear_restart_iin ( )

pure virtual

Master cleared the restart IIN bit.

enter_solicited_confirm_wait()

virtual void dnp3::OutstationInformation::enter_solicited_confirm_wait ( uint8_t  ecsn )

pure virtual

Outstation has begun waiting for a solicited confirm.

Parameters

ecsn	Expected sequence number

enter_unsolicited_confirm_wait()

virtual void dnp3::OutstationInformation::enter_unsolicited_confirm_wait ( uint8_t  ecsn )

pure virtual

Outstation has begun waiting for an unsolicited confirm.

Parameters

ecsn	Expected sequence number

process_request_from_idle()

virtual void dnp3::OutstationInformation::process_request_from_idle ( const RequestHeader &  header )

pure virtual

Called when a request is processed from the IDLE state.

Parameters

header

Request header

solicited_confirm_received()

virtual void dnp3::OutstationInformation::solicited_confirm_received ( uint8_t  ecsn )

pure virtual

Received the expected confirm.

Parameters

ecsn	Expected sequence number

solicited_confirm_timeout()

virtual void dnp3::OutstationInformation::solicited_confirm_timeout ( uint8_t  ecsn )

pure virtual

Failed to receive a solicited confirm before the timeout occurred.

Parameters

ecsn	Expected sequence number

solicited_confirm_wait_new_request()

virtual void dnp3::OutstationInformation::solicited_confirm_wait_new_request ( )

pure virtual

Received a new request while waiting for a solicited confirm, aborting the response series.

unexpected_confirm()

virtual void dnp3::OutstationInformation::unexpected_confirm ( bool  unsolicited, uint8_t  seq  )

pure virtual

Received a confirm when not expecting one.

Parameters

unsolicited	True if it's an unsolicited response confirm, false if it's a solicited response confirm
seq	Received sequence number

unsolicited_confirm_timeout()

virtual void dnp3::OutstationInformation::unsolicited_confirm_timeout ( uint8_t  ecsn, bool  retry  )

pure virtual

Failed to receive an unsolicited confirm before the timeout occurred.

Parameters

ecsn	Expected sequence number
retry	Is it a retry

unsolicited_confirmed()

virtual void dnp3::OutstationInformation::unsolicited_confirmed ( uint8_t  ecsn )

pure virtual

Master confirmed an unsolicited message.

Parameters

ecsn	Expected sequence number

wrong_solicited_confirm_seq()

virtual void dnp3::OutstationInformation::wrong_solicited_confirm_seq ( uint8_t  ecsn, uint8_t  seq  )

pure virtual

Received a solicited confirm with the wrong sequence number.

Parameters

ecsn	Expected sequence number
seq	Received sequence number

---

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

• dnp3.hpp