- added function SVReceiver_enableDestAddrCheck

dotnet/IEC61850forCSharp/SampledValuesSubscriber.cs

@@ -32,15 +32,23 @@ namespace IEC61850
 
 		namespace Subscriber 
 		{
+			/// <summary>
+			/// SV receiver.
+			/// </summary>
+			/// A receiver is responsible for processing all SV message for a single Ethernet interface.
+			/// In order to process messages from multiple Ethernet interfaces you have to create multiple
+			/// instances.
 			public class SVReceiver : IDisposable
 			{
 				[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
 				private static extern IntPtr SVReceiver_create ();
 
-
 				[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
 				private static extern void SVReceiver_disableDestAddrCheck(IntPtr self);
 
+				[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+				private static extern void SVReceiver_enableDestAddrCheck(IntPtr self);
+
 				[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
 				private static extern void SVReceiver_addSubscriber(IntPtr self, IntPtr subscriber);
 
@@ -67,6 +75,10 @@ namespace IEC61850
 
 				private bool isDisposed = false;
 
+				/// <summary>
+				/// Initializes a new instance of the <see cref="IEC61850.SV.Subscriber.SVReceiver"/> class.
+				/// </summary>
+
 				public SVReceiver()
 				{
 					self = SVReceiver_create ();
@@ -82,21 +94,37 @@ namespace IEC61850
 					SVReceiver_disableDestAddrCheck (self);
 				}
 
+				public void EnableDestAddrCheck()
+				{
+					SVReceiver_enableDestAddrCheck (self);
+				}
+					
+				/// <summary>
+				/// Add a subscriber to handle
+				/// </summary>
+				/// <param name="subscriber">Subscriber.</param>
 				public void AddSubscriber(SVSubscriber subscriber)
 				{
 					SVReceiver_addSubscriber (self, subscriber.self);
 				}
 
+
 				public void RemoveSubscriber(SVSubscriber subscriber)
 				{
 					SVReceiver_removeSubscriber (self, subscriber.self);
 				}
 
+				/// <summary>
+				/// Start handling SV messages
+				/// </summary>
 				public void Start()
 				{
 					SVReceiver_start (self);
 				}
 
+				/// <summary>
+				/// Stop handling SV messges
+				/// </summary>
 				public void Stop()
 				{
 					SVReceiver_stop (self);
@@ -107,6 +135,14 @@ namespace IEC61850
 					return SVReceiver_isRunning (self);
 				}
 
+				/// <summary>
+				/// Releases all resource used by the <see cref="IEC61850.SV.Subscriber.SVReceiver"/> object.
+				/// </summary>
+				/// <remarks>Call <see cref="Dispose"/> when you are finished using the <see cref="IEC61850.SV.Subscriber.SVReceiver"/>. The
+				/// <see cref="Dispose"/> method leaves the <see cref="IEC61850.SV.Subscriber.SVReceiver"/> in an unusable state.
+				/// After calling <see cref="Dispose"/>, you must release all references to the
+				/// <see cref="IEC61850.SV.Subscriber.SVReceiver"/> so the garbage collector can reclaim the memory that the
+				/// <see cref="IEC61850.SV.Subscriber.SVReceiver"/> was occupying.</remarks>
 				public void Dispose()
 				{
 					if (isDisposed == false) {
@@ -128,6 +164,13 @@ namespace IEC61850
 			/// </summary>
 			public delegate void SVUpdateListener (SVSubscriber report, object parameter, SVSubscriberASDU asdu);
 
+			/// <summary>
+			/// Sampled Values (SV) Subscriber
+			/// 
+			/// A subscriber is an instance associated with a single stream of measurement data. It is identified
+			/// by the Ethernet destination address, the appID value (both are on SV message level) and the svID value
+			/// that is part of each ASDU.
+			/// </summary>
 			public class SVSubscriber : IDisposable
 			{
 				[UnmanagedFunctionPointer(CallingConvention.Cdecl)]

examples/iec61850_client_example1/client_example1.c

@@ -1,7 +1,7 @@
 /*
  * client_example1.c
  *
- * This example is intended to be used with server_example3 or server_example_goose.
+ * This example is intended to be used with server_example_basic_io or server_example_goose.
  */
 
 #include "iec61850_client.h"

src/sampled_values/sv_subscriber.c

@@ -118,6 +118,12 @@ SVReceiver_disableDestAddrCheck(SVReceiver self)
     self->checkDestAddr = false;
 }
 
+void
+SVReceiver_enableDestAddrCheck(SVReceiver self)
+{
+    self->checkDestAddr = false;
+}
+
 void
 SVReceiver_addSubscriber(SVReceiver self, SVSubscriber subscriber)
 {

src/sampled_values/sv_subscriber.h

@@ -1,7 +1,7 @@
 /*
  *  sv_subscriber.h
  *
- *  Copyright 2015 Michael Zillgith
+ *  Copyright 2015-2018 Michael Zillgith
  *
  *  This file is part of libIEC61850.
  *
@@ -98,7 +98,7 @@ typedef struct sSVSubscriber_ASDU* SVSubscriber_ASDU;
 /**
  * \brief opaque handle to a SV subscriber instance
  *
- * A subscriber is an instance associated with a single stream of measurement data.  It is identified
+ * A subscriber is an instance associated with a single stream of measurement data. It is identified
  * by the Ethernet destination address, the appID value (both are on SV message level) and the svID value
  * that is part of each ASDU (SVSubscriber_ASDU object).
  */
@@ -135,15 +135,24 @@ SVReceiver_create(void);
 /**
  * \brief Disable check for destination address of the received SV messages
  *
- * Per default both the appID and the destination address are checked to identify
- * relevant SV messages. Destination address check can be disabled for performance
- * reason when the appIDs are unique in the local system.
- *
  * \param self the receiver instance reference
  */
 void
 SVReceiver_disableDestAddrCheck(SVReceiver self);
 
+/**
+ * \brief Enable check for destination address of the received SV messages
+ *
+ * Per default only the appID is checked to identify relevant SV messages and the
+ * destination address is ignored for performance reasons. This only works when the
+ * appIDs are unique in the local system. Otherwise the destination address check
+ * has to be enabled.
+ *
+ * \param self the receiver instance reference
+ */
+void
+SVReceiver_enableDestAddrCheck(SVReceiver self);
+
 /**
  * \brief Set the Ethernet interface ID for the receiver instance
  *

src/vs/libiec61850.def

@@ -707,3 +707,4 @@ EXPORTS
     SVPublisher_ASDU_setQuality
     Timestamp_createFromByteArray
     IedModel_getDeviceByIndex
+    SVReceiver_enableDestAddrCheck