Callback interface used to received measurement values received from the outstation. More...

#include <dnp3.hpp>

Public Member Functions
virtual void	begin_fragment (ReadType read_type, const ResponseHeader &header)
	Called when a valid response fragment is received, but before any measurements are processed. More...

virtual void	end_fragment (ReadType read_type, const ResponseHeader &header)
	Called when all the data from a response fragment has been processed. More...

virtual void	handle_binary_input (const HeaderInfo &info, BinaryInputIterator &values)
	Handle binary input data. More...

virtual void	handle_double_bit_binary_input (const HeaderInfo &info, DoubleBitBinaryInputIterator &values)
	Handle double-bit binary input data. More...

virtual void	handle_binary_output_status (const HeaderInfo &info, BinaryOutputStatusIterator &values)
	Handle binary output status data. More...

virtual void	handle_counter (const HeaderInfo &info, CounterIterator &values)
	Handle counter data. More...

virtual void	handle_frozen_counter (const HeaderInfo &info, FrozenCounterIterator &values)
	Handle frozen counter input data. More...

virtual void	handle_analog_input (const HeaderInfo &info, AnalogInputIterator &values)
	Handle analog input data. More...

virtual void	handle_frozen_analog_input (const HeaderInfo &info, FrozenAnalogInputIterator &values)
	Handle frozen analog input data. More...

virtual void	handle_analog_output_status (const HeaderInfo &info, AnalogOutputStatusIterator &values)
	Handle analog output status data. More...

virtual void	handle_binary_output_command_event (const HeaderInfo &info, BinaryOutputCommandEventIterator &values)
	Handle binary output command events. More...

virtual void	handle_analog_output_command_event (const HeaderInfo &info, AnalogOutputCommandEventIterator &values)
	Handle analog output command events. More...

virtual void	handle_unsigned_integer (const HeaderInfo &info, UnsignedIntegerIterator &values)
	Handle unsigned integer values (g102) More...

virtual void	handle_octet_string (const HeaderInfo &info, OctetStringIterator &values)
	Handle octet string data. More...

virtual void	handle_string_attr (const HeaderInfo &info, StringAttr attr, uint8_t set, uint8_t variation, const char *value)
	Handle a known or unknown visible string device attribute. More...

virtual void	handle_variation_list_attr (const HeaderInfo &info, VariationListAttr attr, uint8_t set, uint8_t variation, AttrItemIter &value)
	Handle a known or unknown list of attribute variations. More...

virtual void	handle_uint_attr (const HeaderInfo &info, UintAttr attr, uint8_t set, uint8_t variation, uint32_t value)
	Handle an unsigned integer device attribute. More...

virtual void	handle_bool_attr (const HeaderInfo &info, BoolAttr attr, uint8_t set, uint8_t variation, bool value)
	Handle a boolean device attribute. More...

virtual void	handle_int_attr (const HeaderInfo &info, IntAttr attr, uint8_t set, uint8_t variation, int32_t value)
	Handle a signed integer device attribute. More...

virtual void	handle_time_attr (const HeaderInfo &info, TimeAttr attr, uint8_t set, uint8_t variation, uint64_t value)
	Handle a DNP3 time device attribute. More...

virtual void	handle_float_attr (const HeaderInfo &info, FloatAttr attr, uint8_t set, uint8_t variation, double value)
	Handle a floating point device attribute. More...

virtual void	handle_octet_string_attr (const HeaderInfo &info, OctetStringAttr attr, uint8_t set, uint8_t variation, ByteIterator &value)
	Handle an octet string device attribute. More...

virtual void	handle_bit_string_attr (const HeaderInfo &info, BitStringAttr attr, uint8_t set, uint8_t variation, ByteIterator &value)
	Handle a bit string device attribute. More...

Detailed Description

Callback interface used to received measurement values received from the outstation.

Methods are always invoked in the following order. ReadHandler::begin_fragment() is called first, followed by one or more of the measurement handlers, and finally ReadHandler::end_fragment() is called.

Note: this class is an "interface" and only has virtual methods, some of which may have default implementations.

Member Function Documentation

◆ begin_fragment()

virtual void dnp3::ReadHandler::begin_fragment	(	ReadType	read_type,
		const ResponseHeader &	header
	)

inlinevirtual

Called when a valid response fragment is received, but before any measurements are processed.

Parameters

read_type	Describes what triggered the callback, e.g. response to a poll vs an unsolicited response
header	Header of the fragment

Note: This method has a default implementation that does nothing

◆ end_fragment()

virtual void dnp3::ReadHandler::end_fragment	(	ReadType	read_type,
		const ResponseHeader &	header
	)

inlinevirtual

Called when all the data from a response fragment has been processed.

Parameters

read_type	Describes what triggered the read event
header	Header of the fragment

Note: This method has a default implementation that does nothing

◆ handle_analog_input()

virtual void dnp3::ReadHandler::handle_analog_input	(	const HeaderInfo &	info,
		AnalogInputIterator &	values
	)

inlinevirtual

Handle analog input data.

Parameters

info	Group/variation and qualifier information
values	iterator of values from the response

Note: This method has a default implementation that does nothing

◆ handle_analog_output_command_event()

virtual void dnp3::ReadHandler::handle_analog_output_command_event	(	const HeaderInfo &	info,
		AnalogOutputCommandEventIterator &	values
	)

inlinevirtual

Handle analog output command events.

Parameters

info	Group/variation and qualifier information
values	iterator of values from the response

Note: This method has a default implementation that does nothing

◆ handle_analog_output_status()

virtual void dnp3::ReadHandler::handle_analog_output_status	(	const HeaderInfo &	info,
		AnalogOutputStatusIterator &	values
	)

inlinevirtual

Handle analog output status data.

Parameters

info	Group/variation and qualifier information
values	iterator of values from the response

Note: This method has a default implementation that does nothing

◆ handle_binary_input()

virtual void dnp3::ReadHandler::handle_binary_input	(	const HeaderInfo &	info,
		BinaryInputIterator &	values
	)

inlinevirtual

Handle binary input data.

Parameters

info	Group/variation and qualifier information
values	iterator of values from the response

Note: This method has a default implementation that does nothing

◆ handle_binary_output_command_event()

virtual void dnp3::ReadHandler::handle_binary_output_command_event	(	const HeaderInfo &	info,
		BinaryOutputCommandEventIterator &	values
	)

inlinevirtual

Handle binary output command events.

Parameters

info	Group/variation and qualifier information
values	iterator of values from the response

Note: This method has a default implementation that does nothing

◆ handle_binary_output_status()

virtual void dnp3::ReadHandler::handle_binary_output_status	(	const HeaderInfo &	info,
		BinaryOutputStatusIterator &	values
	)

inlinevirtual

Handle binary output status data.

Parameters

info	Group/variation and qualifier information
values	iterator of values from the response

Note: This method has a default implementation that does nothing

◆ handle_bit_string_attr()

virtual void dnp3::ReadHandler::handle_bit_string_attr	(	const HeaderInfo &	info,
		BitStringAttr	attr,
		uint8_t	set,
		uint8_t	variation,
		ByteIterator &	value
	)

inlinevirtual

Handle a bit string device attribute.

Parameters

info	Group/variation and qualifier information
attr	Enumeration describing the attribute associated with the value
set	The set associated with this attribute. Examining this argument is only important if the attr argument is unknown.
variation	The variation associated with this attribute. Examining this argument is only important if the attr argument is unknown.
value	Iterator over bytes in the bit-string

Note: This method has a default implementation that does nothing

◆ handle_bool_attr()

virtual void dnp3::ReadHandler::handle_bool_attr	(	const HeaderInfo &	info,
		BoolAttr	attr,
		uint8_t	set,
		uint8_t	variation,
		bool	value
	)

inlinevirtual

Handle a boolean device attribute.

These are actually signed integer values on the wire. This method is only called for known values

Parameters

info	Group/variation and qualifier information
attr	Enumeration describing the attribute associated with the value
set	The set associated with this attribute. Examining this argument is only important if the attr argument is unknown.
variation	The variation associated with this attribute. Examining this argument is only important if the attr argument is unknown.
value	attribute value

Note: This method has a default implementation that does nothing

◆ handle_counter()

virtual void dnp3::ReadHandler::handle_counter	(	const HeaderInfo &	info,
		CounterIterator &	values
	)

inlinevirtual

Handle counter data.

Parameters

info	Group/variation and qualifier information
values	iterator of values from the response

Note: This method has a default implementation that does nothing

◆ handle_double_bit_binary_input()

virtual void dnp3::ReadHandler::handle_double_bit_binary_input	(	const HeaderInfo &	info,
		DoubleBitBinaryInputIterator &	values
	)

inlinevirtual

Handle double-bit binary input data.

Parameters

info	Group/variation and qualifier information
values	iterator of values from the response

Note: This method has a default implementation that does nothing

◆ handle_float_attr()

virtual void dnp3::ReadHandler::handle_float_attr	(	const HeaderInfo &	info,
		FloatAttr	attr,
		uint8_t	set,
		uint8_t	variation,
		double	value
	)

inlinevirtual

Handle a floating point device attribute.

Parameters

info	Group/variation and qualifier information
attr	Enumeration describing the attribute associated with the value
set	The set associated with this attribute. Examining this argument is only important if the attr argument is unknown.
variation	The variation associated with this attribute. Examining this argument is only important if the attr argument is unknown.
value	Attribute value

Note: This method has a default implementation that does nothing

◆ handle_frozen_analog_input()

virtual void dnp3::ReadHandler::handle_frozen_analog_input	(	const HeaderInfo &	info,
		FrozenAnalogInputIterator &	values
	)

inlinevirtual

Handle frozen analog input data.

Parameters

info	Group/variation and qualifier information
values	iterator of values from the response

Note: This method has a default implementation that does nothing

◆ handle_frozen_counter()

virtual void dnp3::ReadHandler::handle_frozen_counter	(	const HeaderInfo &	info,
		FrozenCounterIterator &	values
	)

inlinevirtual

Handle frozen counter input data.

Parameters

info	Group/variation and qualifier information
values	iterator of values from the response

Note: This method has a default implementation that does nothing

◆ handle_int_attr()

virtual void dnp3::ReadHandler::handle_int_attr	(	const HeaderInfo &	info,
		IntAttr	attr,
		uint8_t	set,
		uint8_t	variation,
		int32_t	value
	)

inlinevirtual

Handle a signed integer device attribute.

There are no defined attributes for this type that aren't mapped to booleans so there is no enumeration

Parameters

info	Group/variation and qualifier information
attr	Enumeration describing the attribute associated with the value
set	The set associated with this attribute. Examining this argument is only important if the attr argument is unknown.
variation	The variation associated with this attribute. Examining this argument is only important if the attr argument is unknown.
value	attribute value

Note: This method has a default implementation that does nothing

◆ handle_octet_string()

virtual void dnp3::ReadHandler::handle_octet_string	(	const HeaderInfo &	info,
		OctetStringIterator &	values
	)

inlinevirtual

Handle octet string data.

Parameters

info	Group/variation and qualifier information
values	iterator of values from the response

Note: This method has a default implementation that does nothing

◆ handle_octet_string_attr()

virtual void dnp3::ReadHandler::handle_octet_string_attr	(	const HeaderInfo &	info,
		OctetStringAttr	attr,
		uint8_t	set,
		uint8_t	variation,
		ByteIterator &	value
	)

inlinevirtual

Handle an octet string device attribute.

Parameters

info	Group/variation and qualifier information
attr	Enumeration describing the attribute associated with the value
set	The set associated with this attribute. Examining this argument is only important if the attr argument is unknown.
variation	The variation associated with this attribute. Examining this argument is only important if the attr argument is unknown.
value	Iterator over bytes in the octet-string

Note: This method has a default implementation that does nothing

◆ handle_string_attr()

virtual void dnp3::ReadHandler::handle_string_attr	(	const HeaderInfo &	info,
		StringAttr	attr,
		uint8_t	set,
		uint8_t	variation,
		const char *	value
	)

inlinevirtual

Handle a known or unknown visible string device attribute.

Parameters

info	Group/variation and qualifier information
attr	Enumeration describing the attribute (possibly unknown) associated with the value
set	The set associated with this attribute. Examining this argument is only important if the attr argument is unknown.
variation	The variation associated with this attribute. Examining this argument is only important if the attr argument is unknown.
value	attribute value

Note: This method has a default implementation that does nothing

◆ handle_time_attr()

virtual void dnp3::ReadHandler::handle_time_attr	(	const HeaderInfo &	info,
		TimeAttr	attr,
		uint8_t	set,
		uint8_t	variation,
		uint64_t	value
	)

inlinevirtual

Handle a DNP3 time device attribute.

Parameters

info	Group/variation and qualifier information
attr	Enumeration describing the attribute associated with the value
set	The set associated with this attribute. Examining this argument is only important if the attr argument is unknown.
variation	The variation associated with this attribute. Examining this argument is only important if the attr argument is unknown.
value	48-bit timestamp representing milliseconds since Unix epoch

Note: This method has a default implementation that does nothing

◆ handle_uint_attr()

virtual void dnp3::ReadHandler::handle_uint_attr	(	const HeaderInfo &	info,
		UintAttr	attr,
		uint8_t	set,
		uint8_t	variation,
		uint32_t	value
	)

inlinevirtual

Handle an unsigned integer device attribute.

Parameters

info	Group/variation and qualifier information
attr	Enumeration describing the attribute (possibly unknown) associated with the value
set	The set associated with this attribute. Examining this argument is only important if the attr argument is unknown.
variation	The variation associated with this attribute. Examining this argument is only important if the attr argument is unknown.
value	attribute value

Note: This method has a default implementation that does nothing

◆ handle_unsigned_integer()

virtual void dnp3::ReadHandler::handle_unsigned_integer	(	const HeaderInfo &	info,
		UnsignedIntegerIterator &	values
	)

inlinevirtual

Handle unsigned integer values (g102)

Parameters

info	Group/variation and qualifier information
values	iterator of values from the response

Note: This method has a default implementation that does nothing

◆ handle_variation_list_attr()

virtual void dnp3::ReadHandler::handle_variation_list_attr	(	const HeaderInfo &	info,
		VariationListAttr	attr,
		uint8_t	set,
		uint8_t	variation,
		AttrItemIter &	value
	)

inlinevirtual

Handle a known or unknown list of attribute variations.

Parameters

info	Group/variation and qualifier information
attr	Enumeration describing the attribute (possibly unknown) associated with the value
set	The set associated with this attribute. Examining this argument is only important if the attr argument is unknown.
variation	The variation associated with this attribute. Examining this argument is only important if the attr argument is unknown.
value	Iterator over a list of variation / properties pairs

Note: This method has a default implementation that does nothing

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

dnp3.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ begin_fragment()

◆ end_fragment()

◆ handle_analog_input()

◆ handle_analog_output_command_event()

◆ handle_analog_output_status()

◆ handle_binary_input()

◆ handle_binary_output_command_event()

◆ handle_binary_output_status()

◆ handle_bit_string_attr()

◆ handle_bool_attr()

◆ handle_counter()

◆ handle_double_bit_binary_input()

◆ handle_float_attr()

◆ handle_frozen_analog_input()

◆ handle_frozen_counter()

◆ handle_int_attr()

◆ handle_octet_string()

◆ handle_octet_string_attr()

◆ handle_string_attr()

◆ handle_time_attr()

◆ handle_uint_attr()

◆ handle_unsigned_integer()

◆ handle_variation_list_attr()