dnp3.IReadHandler Interface Reference

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

Public Member Functions
void	BeginFragment (ReadType readType, ResponseHeader header)
	Called when a valid response fragment is received, but before any measurements are processed More...
void	EndFragment (ReadType readType, ResponseHeader header)
	Called when all the data from a response fragment has been processed More...
void	HandleBinaryInput (HeaderInfo info, System.Collections.Generic.ICollection< BinaryInput > values)
	Handle binary input data More...
void	HandleDoubleBitBinaryInput (HeaderInfo info, System.Collections.Generic.ICollection< DoubleBitBinaryInput > values)
	Handle double-bit binary input data More...
void	HandleBinaryOutputStatus (HeaderInfo info, System.Collections.Generic.ICollection< BinaryOutputStatus > values)
	Handle binary output status data More...
void	HandleCounter (HeaderInfo info, System.Collections.Generic.ICollection< Counter > values)
	Handle counter data More...
void	HandleFrozenCounter (HeaderInfo info, System.Collections.Generic.ICollection< FrozenCounter > values)
	Handle frozen counter input data More...
void	HandleAnalogInput (HeaderInfo info, System.Collections.Generic.ICollection< AnalogInput > values)
	Handle analog input data More...
void	HandleFrozenAnalogInput (HeaderInfo info, System.Collections.Generic.ICollection< FrozenAnalogInput > values)
	Handle frozen analog input data More...
void	HandleAnalogOutputStatus (HeaderInfo info, System.Collections.Generic.ICollection< AnalogOutputStatus > values)
	Handle analog output status data More...
void	HandleOctetString (HeaderInfo info, System.Collections.Generic.ICollection< OctetString > values)
	Handle octet string data More...
void	HandleStringAttr (HeaderInfo info, StringAttr attr, byte set, byte variation, string value)
	Handle a known or unknown visible string device attribute More...
void	HandleVariationListAttr (HeaderInfo info, VariationListAttr attr, byte set, byte variation, System.Collections.Generic.ICollection< AttrItem > value)
	Handle a known or unknown list of attribute variations More...
void	HandleUintAttr (HeaderInfo info, UintAttr attr, byte set, byte variation, uint value)
	Handle an unsigned integer device attribute More...
void	HandleBoolAttr (HeaderInfo info, BoolAttr attr, byte set, byte variation, bool value)
	Handle a boolean device attribute More...
void	HandleIntAttr (HeaderInfo info, IntAttr attr, byte set, byte variation, int value)
	Handle a signed integer device attribute More...
void	HandleTimeAttr (HeaderInfo info, TimeAttr attr, byte set, byte variation, ulong value)
	Handle a DNP3 time device attribute More...
void	HandleFloatAttr (HeaderInfo info, FloatAttr attr, byte set, byte variation, double value)
	Handle a floating point device attribute More...
void	HandleOctetStringAttr (HeaderInfo info, OctetStringAttr attr, byte set, byte variation, System.Collections.Generic.ICollection< byte > value)
	Handle an octet string device attribute More...
void	HandleBitStringAttr (HeaderInfo info, BitStringAttr attr, byte set, byte variation, System.Collections.Generic.ICollection< byte > 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. IReadHandler.BeginFragment is called first, followed by one or more of the measurement handlers, and finally IReadHandler.EndFragment is called.

Member Function Documentation

BeginFragment()

void dnp3.IReadHandler.BeginFragment	(	ReadType	readType,
		ResponseHeader	header
	)

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

Parameters

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

EndFragment()

void dnp3.IReadHandler.EndFragment	(	ReadType	readType,
		ResponseHeader	header
	)

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

Parameters

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

HandleAnalogInput()

void dnp3.IReadHandler.HandleAnalogInput	(	HeaderInfo	info,
		System.Collections.Generic.ICollection< AnalogInput >	values
	)

Handle analog input data

Parameters

info	Group/variation and qualifier information
values	System.Collections.Generic.ICollection<T> of values from the response

HandleAnalogOutputStatus()

void dnp3.IReadHandler.HandleAnalogOutputStatus	(	HeaderInfo	info,
		System.Collections.Generic.ICollection< AnalogOutputStatus >	values
	)

Handle analog output status data

Parameters

info	Group/variation and qualifier information
values	System.Collections.Generic.ICollection<T> of values from the response

HandleBinaryInput()

void dnp3.IReadHandler.HandleBinaryInput	(	HeaderInfo	info,
		System.Collections.Generic.ICollection< BinaryInput >	values
	)

Handle binary input data

Parameters

info	Group/variation and qualifier information
values	System.Collections.Generic.ICollection<T> of values from the response

HandleBinaryOutputStatus()

void dnp3.IReadHandler.HandleBinaryOutputStatus	(	HeaderInfo	info,
		System.Collections.Generic.ICollection< BinaryOutputStatus >	values
	)

Handle binary output status data

Parameters

info	Group/variation and qualifier information
values	System.Collections.Generic.ICollection<T> of values from the response

HandleBitStringAttr()

void dnp3.IReadHandler.HandleBitStringAttr	(	HeaderInfo	info,
		BitStringAttr	attr,
		byte	set,
		byte	variation,
		System.Collections.Generic.ICollection< byte >	value
	)

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

HandleBoolAttr()

void dnp3.IReadHandler.HandleBoolAttr	(	HeaderInfo	info,
		BoolAttr	attr,
		byte	set,
		byte	variation,
		bool	value
	)

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

HandleCounter()

void dnp3.IReadHandler.HandleCounter	(	HeaderInfo	info,
		System.Collections.Generic.ICollection< Counter >	values
	)

Handle counter data

Parameters

info	Group/variation and qualifier information
values	System.Collections.Generic.ICollection<T> of values from the response

HandleDoubleBitBinaryInput()

void dnp3.IReadHandler.HandleDoubleBitBinaryInput	(	HeaderInfo	info,
		System.Collections.Generic.ICollection< DoubleBitBinaryInput >	values
	)

Handle double-bit binary input data

Parameters

info	Group/variation and qualifier information
values	System.Collections.Generic.ICollection<T> of values from the response

HandleFloatAttr()

void dnp3.IReadHandler.HandleFloatAttr	(	HeaderInfo	info,
		FloatAttr	attr,
		byte	set,
		byte	variation,
		double	value
	)

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

HandleFrozenAnalogInput()

void dnp3.IReadHandler.HandleFrozenAnalogInput	(	HeaderInfo	info,
		System.Collections.Generic.ICollection< FrozenAnalogInput >	values
	)

Handle frozen analog input data

Parameters

info	Group/variation and qualifier information
values	System.Collections.Generic.ICollection<T> of values from the response

HandleFrozenCounter()

void dnp3.IReadHandler.HandleFrozenCounter	(	HeaderInfo	info,
		System.Collections.Generic.ICollection< FrozenCounter >	values
	)

Handle frozen counter input data

Parameters

info	Group/variation and qualifier information
values	System.Collections.Generic.ICollection<T> of values from the response

HandleIntAttr()

void dnp3.IReadHandler.HandleIntAttr	(	HeaderInfo	info,
		IntAttr	attr,
		byte	set,
		byte	variation,
		int	value
	)

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

HandleOctetString()

void dnp3.IReadHandler.HandleOctetString	(	HeaderInfo	info,
		System.Collections.Generic.ICollection< OctetString >	values
	)

Handle octet string data

Parameters

info	Group/variation and qualifier information
values	System.Collections.Generic.ICollection<T> of values from the response

HandleOctetStringAttr()

void dnp3.IReadHandler.HandleOctetStringAttr	(	HeaderInfo	info,
		OctetStringAttr	attr,
		byte	set,
		byte	variation,
		System.Collections.Generic.ICollection< byte >	value
	)

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

HandleStringAttr()

void dnp3.IReadHandler.HandleStringAttr	(	HeaderInfo	info,
		StringAttr	attr,
		byte	set,
		byte	variation,
		string	value
	)

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

HandleTimeAttr()

void dnp3.IReadHandler.HandleTimeAttr	(	HeaderInfo	info,
		TimeAttr	attr,
		byte	set,
		byte	variation,
		ulong	value
	)

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

HandleUintAttr()

void dnp3.IReadHandler.HandleUintAttr	(	HeaderInfo	info,
		UintAttr	attr,
		byte	set,
		byte	variation,
		uint	value
	)

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

HandleVariationListAttr()

void dnp3.IReadHandler.HandleVariationListAttr	(	HeaderInfo	info,
		VariationListAttr	attr,
		byte	set,
		byte	variation,
		System.Collections.Generic.ICollection< AttrItem >	value
	)

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

---

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

• IReadHandler.cs