/// <summary>
/// Initialize Connection properties from connection configuration object
/// </summary>
private void Initialize()
{
PubSubConnectionDataType pubSubConnectionConfiguration = m_udpConnection.PubSubConnectionConfiguration;
DatagramConnectionTransportDataType transportSettings = ExtensionObject.ToEncodeable(pubSubConnectionConfiguration.TransportSettings)
as DatagramConnectionTransportDataType;
if (transportSettings != null && transportSettings.DiscoveryAddress != null)
{
NetworkAddressUrlDataType discoveryNetworkAddressUrlState = ExtensionObject.ToEncodeable(transportSettings.DiscoveryAddress)
as NetworkAddressUrlDataType;
if (discoveryNetworkAddressUrlState != null)
{
Utils.Trace(Utils.TraceMasks.Information, "The configuration for connection {0} has custom DiscoveryAddress configuration.",
pubSubConnectionConfiguration.Name);
DiscoveryNetworkInterfaceName = discoveryNetworkAddressUrlState.NetworkInterface;
DiscoveryNetworkAddressEndPoint = UdpClientCreator.GetEndPoint(discoveryNetworkAddressUrlState.Url);
}
}
if (DiscoveryNetworkAddressEndPoint == null)
{
Utils.Trace(Utils.TraceMasks.Information, "The configuration for connection {0} will use the default DiscoveryAddress: {1}.",
pubSubConnectionConfiguration.Name, kDefaultDiscoveryUrl);
DiscoveryNetworkAddressEndPoint = UdpClientCreator.GetEndPoint(kDefaultDiscoveryUrl);
}
}
public void ValidateUadpPubSubConnectionNetworkMessagePublishMulticast()
{
//Arrange
var localhost = GetFirstNic();
Assert.IsNotNull(localhost, "localhost is null");
Assert.IsNotNull(localhost.Address, "localhost.Address is null");
//create publisher configuration object with modified port
PubSubConfigurationDataType publisherConfiguration = UaPubSubConfigurationHelper.LoadConfiguration(PublisherConfigurationFileName);
Assert.IsNotNull(publisherConfiguration, "publisherConfiguration is null");
IPAddress multicastIPAddress = new IPAddress(new byte[4] {
239, 0, 0, 1
});
Assert.IsNotNull(multicastIPAddress, "multicastIPAddress is null");
NetworkAddressUrlDataType publisherAddress = new NetworkAddressUrlDataType();
publisherAddress.Url = "opc.udp://" + multicastIPAddress.ToString() + ":4840";
publisherConfiguration.Connections[0].Address = new ExtensionObject(publisherAddress);
//create publisher UaPubSubApplication with changed configuration settings
UaPubSubApplication publisherApplication = UaPubSubApplication.Create(publisherConfiguration);
Assert.IsNotNull(publisherApplication, "publisherApplication is null");
UadpPubSubConnection publisherConnection = publisherApplication.PubSubConnections[0] as UadpPubSubConnection;
Assert.IsNotNull(publisherConnection, "publisherConnection is null");
// will signal that the uadp message was received from local ip
m_shutdownEvent = new ManualResetEvent(false);
//setup uadp client for receiving from multicast (simulate a subscriber multicast)
UdpClient udpMulticastClient = new UdpClientMulticast(localhost.Address, multicastIPAddress, 4840);
udpMulticastClient.BeginReceive(new AsyncCallback(OnReceive), udpMulticastClient);
// prepare a network message
WriterGroupDataType writerGroup0 = publisherConnection.PubSubConnectionConfiguration.WriterGroups[0];
UaNetworkMessage networkMessage = publisherConnection.CreateNetworkMessage(writerGroup0);
//Act
publisherConnection.Start();
publisherConnection.PublishNetworkMessage(networkMessage);
//Assert
if (!m_shutdownEvent.WaitOne(EstimatedPublishingTime))
{
Assert.Fail("The UADP message was not received");
}
publisherConnection.Stop();
udpMulticastClient.Close();
udpMulticastClient.Dispose();
}
/// <summary>
/// Perform specific Start tasks
/// </summary>
protected override Task InternalStart()
{
lock (m_lock)
{
//cleanup all existing UdpClient previously open
InternalStop();
NetworkAddressUrlDataType networkAddressUrlState = ExtensionObject.ToEncodeable(PubSubConnectionConfiguration.Address)
as NetworkAddressUrlDataType;
if (networkAddressUrlState == null)
{
Utils.Trace(Utils.TraceMasks.Error, "The configuration for connection {0} has invalid Address configuration.",
this.PubSubConnectionConfiguration.Name);
return(Task.FromResult <object>(null));
}
NetworkInterfaceName = networkAddressUrlState.NetworkInterface;
NetworkAddressEndPoint = UdpClientCreator.GetEndPoint(networkAddressUrlState.Url);
if (NetworkAddressEndPoint == null)
{
Utils.Trace(Utils.TraceMasks.Error, "The configuration for connection {0} with Url:'{1}' resulted in an invalid endpoint.",
this.PubSubConnectionConfiguration.Name, networkAddressUrlState.Url);
return(Task.FromResult <object>(null));
}
//publisher initialization
if (Publishers.Count > 0)
{
m_publisherUdpClients = UdpClientCreator.GetUdpClients(UsedInContext.Publisher, networkAddressUrlState, NetworkAddressEndPoint);
}
//subscriber initialization
if (GetAllDataSetReaders().Count > 0)
{
m_subscriberUdpClients = UdpClientCreator.GetUdpClients(UsedInContext.Subscriber, networkAddressUrlState, NetworkAddressEndPoint);
foreach (UdpClient subscriberUdpClient in m_subscriberUdpClients)
{
try
{
subscriberUdpClient.BeginReceive(new AsyncCallback(OnUadpReceive), subscriberUdpClient);
}
catch (Exception ex)
{
Utils.Trace(Utils.TraceMasks.Information, "UdpClient '{0}' Cannot receive data. Exception: {1}",
subscriberUdpClient.Client.LocalEndPoint, ex.Message);
}
}
}
}
return(Task.FromResult <object>(null));
}
/// <summary>
/// Initialize Conection properties from connection configuration object
/// </summary>
private void Initialize()
{
NetworkAddressUrlDataType networkAddressUrlState = ExtensionObject.ToEncodeable(PubSubConnectionConfiguration.Address)
as NetworkAddressUrlDataType;
if (networkAddressUrlState == null)
{
Utils.Trace(Utils.TraceMasks.Error, "The configuration for connection {0} has invalid Address configuration.",
PubSubConnectionConfiguration.Name);
return;
}
// set properties
NetworkInterfaceName = networkAddressUrlState.NetworkInterface;
NetworkAddressEndPoint = UdpClientCreator.GetEndPoint(networkAddressUrlState.Url);
if (NetworkAddressEndPoint == null)
{
Utils.Trace(Utils.TraceMasks.Error, "The configuration for connection {0} with Url:'{1}' resulted in an invalid endpoint.",
PubSubConnectionConfiguration.Name, networkAddressUrlState.Url);
}
}
public void ValidateUadpPubSubConnectionNetworkMessageReceiveFromUnicast()
{
// Arrange
var localhost = GetFirstNic();
Assert.IsNotNull(localhost, "localhost is null");
Assert.IsNotNull(localhost.Address, "localhost.Address is null");
PubSubConfigurationDataType subscriberConfiguration = UaPubSubConfigurationHelper.LoadConfiguration(SubscriberConfigurationFileName);
Assert.IsNotNull(subscriberConfiguration, "subscriberConfiguration is null");
NetworkAddressUrlDataType subscriberAddress = new NetworkAddressUrlDataType();
subscriberAddress.Url = "opc.udp://" + localhost.Address.ToString() + ":4840";
subscriberConfiguration.Connections[0].Address = new ExtensionObject(subscriberAddress);
UaPubSubApplication subscriberApplication = UaPubSubApplication.Create(subscriberConfiguration);
Assert.IsNotNull(subscriberApplication, "subscriberApplication is null");
UadpPubSubConnection subscriberConnection = subscriberApplication.PubSubConnections[0] as UadpPubSubConnection;
Assert.IsNotNull(subscriberConnection, "subscriberConnection is null");
subscriberConnection.UadpMessageReceived += DataReceived;
PubSubConfigurationDataType publisherConfiguration = UaPubSubConfigurationHelper.LoadConfiguration(PublisherConfigurationFileName);
Assert.IsNotNull(publisherConfiguration, "publisherConfiguration is null");
NetworkAddressUrlDataType publisherAddress = new NetworkAddressUrlDataType();
publisherAddress.Url = "opc.udp://" + localhost.Address.ToString() + ":4840";
publisherConfiguration.Connections[0].Address = new ExtensionObject(publisherAddress);
UaPubSubApplication publisherApplication = UaPubSubApplication.Create(publisherConfiguration);
Assert.IsNotNull(publisherApplication, "publisherApplication is null");
UadpPubSubConnection publisherConnection = publisherApplication.PubSubConnections[0] as UadpPubSubConnection;
Assert.IsNotNull(publisherConnection, "publisherConnection is null");
//Act
subscriberConnection.Start();
m_shutdownEvent = new ManualResetEvent(false);
// physical network ip is mandatory on UdpClientUnicast as parameter
UdpClient udpUnicastClient = new UdpClientUnicast(localhost.Address, 4840);
Assert.IsNotNull(udpUnicastClient, "udpUnicastClient is null");
// first physical network ip = unicast address ip
IPEndPoint remoteEndPoint = new IPEndPoint(localhost.Address, 4840);
Assert.IsNotNull(remoteEndPoint, "remoteEndPoint is null");
m_sentBytes = PrepareData(publisherConnection);
int sentBytesLen = udpUnicastClient.Send(m_sentBytes, m_sentBytes.Length, remoteEndPoint);
Assert.AreEqual(sentBytesLen, m_sentBytes.Length, "Sent bytes size not equal to published bytes size!");
Thread.Sleep(EstimatedPublishingTime);
// Assert
if (!m_shutdownEvent.WaitOne(EstimatedPublishingTime))
{
Assert.Fail("Subscriber unicast error ... published data not received");
}
subscriberConnection.Stop();
}
/// <summary>
/// Creates a PubSubConfiguration object programmatically.
/// </summary>
/// <returns></returns>
public static PubSubConfigurationDataType CreatePublisherConfiguration()
{
// Define a PubSub connection with PublisherId 100
PubSubConnectionDataType pubSubConnection1 = new PubSubConnectionDataType();
pubSubConnection1.Name = "UADPConnection1";
pubSubConnection1.Enabled = true;
pubSubConnection1.PublisherId = (UInt16)100;
pubSubConnection1.TransportProfileUri = Profiles.UadpTransport;
NetworkAddressUrlDataType address = new NetworkAddressUrlDataType();
// Specify the local Network interface name to be used
// e.g. address.NetworkInterface = "Ethernet";
// Leave empty to publish on all available local interfaces.
address.NetworkInterface = String.Empty;
address.Url = "opc.udp://239.0.0.1:4840";
pubSubConnection1.Address = new ExtensionObject(address);
#region Define WriterGroup1
WriterGroupDataType writerGroup1 = new WriterGroupDataType();
writerGroup1.Name = "WriterGroup 1";
writerGroup1.Enabled = true;
writerGroup1.WriterGroupId = 1;
writerGroup1.PublishingInterval = 5000;
writerGroup1.KeepAliveTime = 5000;
writerGroup1.MaxNetworkMessageSize = 1500;
writerGroup1.HeaderLayoutUri = "UADP-Cyclic-Fixed";
UadpWriterGroupMessageDataType messageSettings = new UadpWriterGroupMessageDataType()
{
DataSetOrdering = DataSetOrderingType.AscendingWriterId,
GroupVersion = 0,
NetworkMessageContentMask = (uint)(UadpNetworkMessageContentMask.PublisherId | UadpNetworkMessageContentMask.GroupHeader
| UadpNetworkMessageContentMask.WriterGroupId | UadpNetworkMessageContentMask.GroupVersion
| UadpNetworkMessageContentMask.NetworkMessageNumber | UadpNetworkMessageContentMask.SequenceNumber)
};
writerGroup1.MessageSettings = new ExtensionObject(messageSettings);
writerGroup1.TransportSettings = new ExtensionObject(new DatagramWriterGroupTransportDataType());
// Define DataSetWriter 'Simple'
DataSetWriterDataType dataSetWriter1 = new DataSetWriterDataType();
dataSetWriter1.Name = "Writer 1";
dataSetWriter1.DataSetWriterId = 1;
dataSetWriter1.Enabled = true;
dataSetWriter1.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetWriter1.DataSetName = "Simple";
dataSetWriter1.KeyFrameCount = 1;
UadpDataSetWriterMessageDataType uadpDataSetWriterMessage = new UadpDataSetWriterMessageDataType()
{
ConfiguredSize = 32,
DataSetOffset = 15,
NetworkMessageNumber = 1,
DataSetMessageContentMask = (uint)(UadpDataSetMessageContentMask.Status | UadpDataSetMessageContentMask.SequenceNumber),
};
dataSetWriter1.MessageSettings = new ExtensionObject(uadpDataSetWriterMessage);
writerGroup1.DataSetWriters.Add(dataSetWriter1);
// Define DataSetWriter 'AllTypes'
DataSetWriterDataType dataSetWriter2 = new DataSetWriterDataType();
dataSetWriter2.Name = "Writer 2";
dataSetWriter2.DataSetWriterId = 2;
dataSetWriter2.Enabled = true;
dataSetWriter2.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetWriter2.DataSetName = "AllTypes";
dataSetWriter2.KeyFrameCount = 1;
uadpDataSetWriterMessage = new UadpDataSetWriterMessageDataType()
{
ConfiguredSize = 32,
DataSetOffset = 47,
NetworkMessageNumber = 1,
DataSetMessageContentMask = (uint)(UadpDataSetMessageContentMask.Status | UadpDataSetMessageContentMask.SequenceNumber),
};
dataSetWriter2.MessageSettings = new ExtensionObject(uadpDataSetWriterMessage);
writerGroup1.DataSetWriters.Add(dataSetWriter2);
pubSubConnection1.WriterGroups.Add(writerGroup1);
#endregion
#region Define PublishedDataSet Simple
PublishedDataSetDataType publishedDataSetSimple = new PublishedDataSetDataType();
publishedDataSetSimple.Name = "Simple"; //name shall be unique in a configuration
// Define publishedDataSetSimple.DataSetMetaData
publishedDataSetSimple.DataSetMetaData = new DataSetMetaDataType();
publishedDataSetSimple.DataSetMetaData.DataSetClassId = Uuid.Empty;
publishedDataSetSimple.DataSetMetaData.Name = publishedDataSetSimple.Name;
publishedDataSetSimple.DataSetMetaData.Fields = new FieldMetaDataCollection()
{
new FieldMetaData()
{
Name = "BoolToggle",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.Boolean,
DataType = DataTypeIds.Boolean,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "Int32",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.Int32,
DataType = DataTypeIds.Int32,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "Int32Fast",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.Int32,
DataType = DataTypeIds.Int32,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "DateTime",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.DateTime,
DataType = DataTypeIds.DateTime,
ValueRank = ValueRanks.Scalar
},
};
publishedDataSetSimple.DataSetMetaData.ConfigurationVersion = new ConfigurationVersionDataType()
{
MinorVersion = 1,
MajorVersion = 1
};
PublishedDataItemsDataType publishedDataSetSimpleSource = new PublishedDataItemsDataType();
publishedDataSetSimpleSource.PublishedData = new PublishedVariableDataTypeCollection();
//create PublishedData based on metadata names
foreach (var field in publishedDataSetSimple.DataSetMetaData.Fields)
{
publishedDataSetSimpleSource.PublishedData.Add(
new PublishedVariableDataType()
{
PublishedVariable = new NodeId(field.Name, PublishedValuesWrites.NamespaceIndexSimple),
AttributeId = Attributes.Value,
});
}
publishedDataSetSimple.DataSetSource = new ExtensionObject(publishedDataSetSimpleSource);
#endregion
#region Define PublishedDataSet AllTypes
PublishedDataSetDataType publishedDataSetAllTypes = new PublishedDataSetDataType();
publishedDataSetAllTypes.Name = "AllTypes"; //name shall be unique in a configuration
// Define publishedDataSetAllTypes.DataSetMetaData
publishedDataSetAllTypes.DataSetMetaData = new DataSetMetaDataType();
publishedDataSetAllTypes.DataSetMetaData.DataSetClassId = Uuid.Empty;
publishedDataSetAllTypes.DataSetMetaData.Name = publishedDataSetAllTypes.Name;
publishedDataSetAllTypes.DataSetMetaData.Fields = new FieldMetaDataCollection()
{
new FieldMetaData()
{
Name = "BoolToggle",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.Boolean,
DataType = DataTypeIds.Boolean,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "Byte",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.Byte,
DataType = DataTypeIds.Byte,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "Int16",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.Int16,
DataType = DataTypeIds.Int16,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "Int32",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.Int32,
DataType = DataTypeIds.Int32,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "SByte",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.SByte,
DataType = DataTypeIds.SByte,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "UInt16",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.UInt16,
DataType = DataTypeIds.UInt16,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "UInt32",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.UInt32,
DataType = DataTypeIds.UInt32,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "Float",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.Float,
DataType = DataTypeIds.Float,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "Double",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.Double,
DataType = DataTypeIds.Double,
ValueRank = ValueRanks.Scalar
},
};
publishedDataSetAllTypes.DataSetMetaData.ConfigurationVersion = new ConfigurationVersionDataType()
{
MinorVersion = 1,
MajorVersion = 1
};
PublishedDataItemsDataType publishedDataSetAllTypesSource = new PublishedDataItemsDataType();
//create PublishedData based on metadata names
foreach (var field in publishedDataSetAllTypes.DataSetMetaData.Fields)
{
publishedDataSetAllTypesSource.PublishedData.Add(
new PublishedVariableDataType()
{
PublishedVariable = new NodeId(field.Name, PublishedValuesWrites.NamespaceIndexAllTypes),
AttributeId = Attributes.Value,
});
}
publishedDataSetAllTypes.DataSetSource = new ExtensionObject(publishedDataSetAllTypesSource);
#endregion
//create the PubSub configuration root object
PubSubConfigurationDataType pubSubConfiguration = new PubSubConfigurationDataType();
pubSubConfiguration.Connections = new PubSubConnectionDataTypeCollection()
{
pubSubConnection1
};
pubSubConfiguration.PublishedDataSets = new PublishedDataSetDataTypeCollection()
{
publishedDataSetSimple, publishedDataSetAllTypes
};
return(pubSubConfiguration);
}
public void ValidateUdpClientCreatorGetUdpClients()
{
// Create a publisher application
UaPubSubApplication publisherApplication = UaPubSubApplication.Create(PublisherConfigurationFileName);
Assert.IsNotNull(publisherApplication, "m_publisherApplication should not be null");
// Get the publisher configuration
PubSubConfigurationDataType publisherConfiguration = publisherApplication.UaPubSubConfigurator.PubSubConfiguration;
Assert.IsNotNull(publisherConfiguration, "m_publisherConfiguration should not be null");
// Check publisher connections
Assert.IsNotNull(publisherConfiguration.Connections, "m_publisherConfiguration.Connections should not be null");
Assert.IsNotEmpty(publisherConfiguration.Connections, "m_publisherConfiguration.Connections should not be empty");
PubSubConnectionDataType publisherConnection1 = publisherConfiguration.Connections[0];
Assert.IsNotNull(publisherConnection1, "publisherConnection1 should not be null");
NetworkAddressUrlDataType networkAddressUrlState1 = ExtensionObject.ToEncodeable(publisherConnection1.Address)
as NetworkAddressUrlDataType;
Assert.IsNotNull(networkAddressUrlState1, "networkAddressUrlState1 is null");
IPEndPoint configuredEndPoint1 = UdpClientCreator.GetEndPoint(networkAddressUrlState1.Url);
Assert.IsNotNull(configuredEndPoint1, "configuredEndPoint1 is null");
List <UdpClient> udpClients1 = UdpClientCreator.GetUdpClients(UsedInContext.Publisher, networkAddressUrlState1, configuredEndPoint1);
Assert.IsNotNull(udpClients1, "udpClients1 is null");
Assert.IsNotEmpty(udpClients1, "udpClients1 is empty");
UdpClient udpClient1 = udpClients1[0];
Assert.IsTrue(udpClient1 is UdpClientMulticast, "udpClient1 was configured as UdpClientMulticast");
Assert.IsNotNull(udpClient1.Client.LocalEndPoint, "udpClient1 IP address is empty");
PubSubConnectionDataType publisherConnection2 = publisherConfiguration.Connections[1];
Assert.IsNotNull(publisherConnection2, "publisherConnection2 should not be null");
NetworkAddressUrlDataType networkAddressUrlState2 = ExtensionObject.ToEncodeable(publisherConnection2.Address)
as NetworkAddressUrlDataType;
Assert.IsNotNull(networkAddressUrlState2, "networkAddressUrlState2 is null");
IPEndPoint configuredEndPoint2 = UdpClientCreator.GetEndPoint(networkAddressUrlState2.Url);
Assert.IsNotNull(configuredEndPoint2, "configuredEndPoint2 is null");
List <UdpClient> udpClients2 = UdpClientCreator.GetUdpClients(UsedInContext.Publisher, networkAddressUrlState2, configuredEndPoint2);
Assert.IsNotNull(udpClients2, "udpClients2 is null");
Assert.IsNotEmpty(udpClients2, "udpClients2 is empty");
UdpClient udpClient2 = udpClients2[0];
Assert.IsTrue(udpClient2 is UdpClientBroadcast, "udpClient2 was configured as UdpClientBroadcast");
Assert.IsNotNull(udpClient2.Client.LocalEndPoint, "udpClient2 IP address is empty");
IPEndPoint udpClientEndPoint1 = udpClient1.Client.LocalEndPoint as IPEndPoint;
Assert.IsNotNull(udpClientEndPoint1, "udpClientEndPoint1 could not be cast to IPEndPoint");
IPEndPoint udpClientEndPoint2 = udpClient2.Client.LocalEndPoint as IPEndPoint;
Assert.IsNotNull(udpClientEndPoint2, "udpClientEndPoint2 could not be cast to IPEndPoint");
Assert.AreEqual(udpClientEndPoint1.Address.ToString(), udpClientEndPoint2.Address.ToString(), "udpClientEndPoint1 IP address: {0} should match udpClientEndPoint2 IP Address {1}", udpClientEndPoint1.Address.ToString(), udpClientEndPoint2.Address.ToString());
Assert.AreNotEqual(udpClientEndPoint1.Port, udpClientEndPoint2.Port, "udpClientEndPoint1 port number: {0} should not match udpClientEndPoint1 port number: {1}", udpClientEndPoint1.Port, udpClientEndPoint2.Port);
}
public void ValidateUdpPubSubConnectionNetworkMessageReceiveFromDiscoveryResponse()
{
// Arrange
var localhost = GetFirstNic();
Assert.IsNotNull(localhost, "localhost is null");
Assert.IsNotNull(localhost.Address, "localhost.Address is null");
//discovery IP address 224.0.2.14
IPAddress multicastIPAddress = new IPAddress(new byte[4] {
224, 0, 2, 14
});
Assert.IsNotNull(multicastIPAddress, "multicastIPAddress is null");
string configurationFile = Utils.GetAbsoluteFilePath(SubscriberConfigurationFileName, true, true, false);
PubSubConfigurationDataType subscriberConfiguration = UaPubSubConfigurationHelper.LoadConfiguration(configurationFile);
Assert.IsNotNull(subscriberConfiguration, "subscriberConfiguration is null");
NetworkAddressUrlDataType subscriberAddress = new NetworkAddressUrlDataType();
subscriberAddress.Url = string.Format(UdpUrlFormat, Utils.UriSchemeOpcUdp, multicastIPAddress.ToString());
subscriberConfiguration.Connections[0].Address = new ExtensionObject(subscriberAddress);
UaPubSubApplication subscriberApplication = UaPubSubApplication.Create(subscriberConfiguration);
Assert.IsNotNull(subscriberApplication, "subscriberApplication is null");
UdpPubSubConnection subscriberConnection = subscriberApplication.PubSubConnections.First() as UdpPubSubConnection;
Assert.IsNotNull(subscriberConnection, "subscriberConnection is null");
subscriberApplication.RawDataReceived += RawDataReceived;
configurationFile = Utils.GetAbsoluteFilePath(PublisherConfigurationFileName, true, true, false);
PubSubConfigurationDataType publisherConfiguration = UaPubSubConfigurationHelper.LoadConfiguration(configurationFile);
Assert.IsNotNull(publisherConfiguration, "publisherConfiguration is null");
NetworkAddressUrlDataType publisherAddress = new NetworkAddressUrlDataType();
publisherAddress.Url = string.Format(UdpUrlFormat, Utils.UriSchemeOpcUdp, multicastIPAddress.ToString());
publisherConfiguration.Connections.First().Address = new ExtensionObject(publisherAddress);
UaPubSubApplication publisherApplication = UaPubSubApplication.Create(publisherConfiguration);
Assert.IsNotNull(publisherApplication, "publisherApplication is null");
UdpPubSubConnection publisherConnection = publisherApplication.PubSubConnections.First() as UdpPubSubConnection;
Assert.IsNotNull(publisherConnection, "publisherConnection is null");
//Act
subscriberConnection.Start();
m_shutdownEvent = new ManualResetEvent(false);
m_sentBytes = PrepareData(publisherConnection, UdpConnectionType.Discovery);
// first physical network ip is mandatory on UdpClientMulticast as parameter, for multicast publisher the port must not be 4840
UdpClient udpMulticastClient = new UdpClientMulticast(localhost.Address, multicastIPAddress, 0);
Assert.IsNotNull(udpMulticastClient, "udpMulticastClient is null");
IPEndPoint remoteEndPoint = new IPEndPoint(multicastIPAddress, DiscoveryPortNo);
int sentBytesLen = udpMulticastClient.Send(m_sentBytes, m_sentBytes.Length, remoteEndPoint);
Assert.AreEqual(sentBytesLen, m_sentBytes.Length, "Sent bytes size not equal to published bytes size!");
Thread.Sleep(EstimatedPublishingTime);
// Assert
if (!m_shutdownEvent.WaitOne(EstimatedPublishingTime))
{
Assert.Fail("Subscriber multicast error ... published data not received");
}
subscriberConnection.Stop();
}
/// <summary>
/// Creates a Subscriber PubSubConfiguration object for UDP & UADP programmatically.
/// </summary>
/// <returns></returns>
private static PubSubConfigurationDataType CreateSubscriberConfiguration_MqttUadp(string urlAddress)
{
// Define a PubSub connection with PublisherId 3
PubSubConnectionDataType pubSubConnection1 = new PubSubConnectionDataType();
pubSubConnection1.Name = "Subscriber Connection MQTT UADP";
pubSubConnection1.Enabled = true;
pubSubConnection1.PublisherId = (UInt16)3;
pubSubConnection1.TransportProfileUri = Profiles.PubSubMqttUadpTransport;
NetworkAddressUrlDataType address = new NetworkAddressUrlDataType();
// Specify the local Network interface name to be used
// e.g. address.NetworkInterface = "Ethernet";
// Leave empty to subscribe on all available local interfaces.
address.NetworkInterface = String.Empty;
address.Url = urlAddress;
pubSubConnection1.Address = new ExtensionObject(address);
// Configure the mqtt specific configuration with the MQTTbroker
ITransportProtocolConfiguration mqttConfiguration = new MqttClientProtocolConfiguration(version: EnumMqttProtocolVersion.V500);
pubSubConnection1.ConnectionProperties = mqttConfiguration.ConnectionProperties;
string brokerQueueName = "Uadp_WriterGroup_1";
string brokerMetaData = "$Metadata";
#region Define ReaderGroup1
ReaderGroupDataType readerGroup1 = new ReaderGroupDataType();
readerGroup1.Name = "ReaderGroup 1";
readerGroup1.Enabled = true;
readerGroup1.MaxNetworkMessageSize = 1500;
readerGroup1.MessageSettings = new ExtensionObject(new ReaderGroupMessageDataType());
readerGroup1.TransportSettings = new ExtensionObject(new ReaderGroupTransportDataType());
#region Define DataSetReader 'Simple' for PublisherId = (UInt16)1, DataSetWriterId = 1
DataSetReaderDataType dataSetReaderSimple = new DataSetReaderDataType();
dataSetReaderSimple.Name = "Reader 1 MQTT UADP";
dataSetReaderSimple.PublisherId = (UInt16)3;
dataSetReaderSimple.WriterGroupId = 0;
dataSetReaderSimple.DataSetWriterId = 1;
dataSetReaderSimple.Enabled = true;
dataSetReaderSimple.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetReaderSimple.KeyFrameCount = 1;
BrokerDataSetReaderTransportDataType brokerTransportSettings = new BrokerDataSetReaderTransportDataType()
{
QueueName = brokerQueueName,
MetaDataQueueName = $"{brokerQueueName}/{brokerMetaData}",
};
dataSetReaderSimple.TransportSettings = new ExtensionObject(brokerTransportSettings);
UadpDataSetReaderMessageDataType uadpDataSetReaderMessage = new UadpDataSetReaderMessageDataType()
{
GroupVersion = 0,
NetworkMessageNumber = 0,
NetworkMessageContentMask = (uint)(uint)(UadpNetworkMessageContentMask.PublisherId
| UadpNetworkMessageContentMask.GroupHeader
| UadpNetworkMessageContentMask.WriterGroupId
| UadpNetworkMessageContentMask.PayloadHeader
| UadpNetworkMessageContentMask.GroupVersion
| UadpNetworkMessageContentMask.NetworkMessageNumber
| UadpNetworkMessageContentMask.SequenceNumber),
DataSetMessageContentMask = (uint)(UadpDataSetMessageContentMask.Status | UadpDataSetMessageContentMask.SequenceNumber),
};
dataSetReaderSimple.MessageSettings = new ExtensionObject(uadpDataSetReaderMessage);
// Create and set DataSetMetaData for DataSet Simple
DataSetMetaDataType simpleMetaData = CreateDataSetMetaDataSimple();
dataSetReaderSimple.DataSetMetaData = simpleMetaData;
// Create and set SubscribedDataSet
TargetVariablesDataType subscribedDataSet = new TargetVariablesDataType();
subscribedDataSet.TargetVariables = new FieldTargetDataTypeCollection();
foreach (var fieldMetaData in simpleMetaData.Fields)
{
subscribedDataSet.TargetVariables.Add(new FieldTargetDataType()
{
DataSetFieldId = fieldMetaData.DataSetFieldId,
TargetNodeId = new NodeId(fieldMetaData.Name, NamespaceIndexSimple),
AttributeId = Attributes.Value,
OverrideValueHandling = OverrideValueHandling.OverrideValue,
OverrideValue = new Variant(TypeInfo.GetDefaultValue(fieldMetaData.DataType, (int)ValueRanks.Scalar))
});
}
dataSetReaderSimple.SubscribedDataSet = new ExtensionObject(subscribedDataSet);
#endregion
readerGroup1.DataSetReaders.Add(dataSetReaderSimple);
#region Define DataSetReader 'AllTypes' for PublisherId = (UInt16)1, DataSetWriterId = 2
DataSetReaderDataType dataSetReaderAllTypes = new DataSetReaderDataType();
dataSetReaderAllTypes.Name = "Reader 2 MQTT UADP";
dataSetReaderAllTypes.PublisherId = (UInt16)3;
dataSetReaderAllTypes.WriterGroupId = 0;
dataSetReaderAllTypes.DataSetWriterId = 2;
dataSetReaderAllTypes.Enabled = true;
dataSetReaderAllTypes.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetReaderAllTypes.KeyFrameCount = 1;
dataSetReaderAllTypes.TransportSettings = new ExtensionObject(brokerTransportSettings);
uadpDataSetReaderMessage = new UadpDataSetReaderMessageDataType()
{
GroupVersion = 0,
NetworkMessageNumber = 0,
NetworkMessageContentMask = (uint)(uint)(UadpNetworkMessageContentMask.PublisherId
| UadpNetworkMessageContentMask.GroupHeader
| UadpNetworkMessageContentMask.WriterGroupId
| UadpNetworkMessageContentMask.PayloadHeader
| UadpNetworkMessageContentMask.GroupVersion
| UadpNetworkMessageContentMask.NetworkMessageNumber
| UadpNetworkMessageContentMask.SequenceNumber),
DataSetMessageContentMask = (uint)(UadpDataSetMessageContentMask.Status | UadpDataSetMessageContentMask.SequenceNumber),
};
dataSetReaderAllTypes.MessageSettings = new ExtensionObject(uadpDataSetReaderMessage);
// Create and set DataSetMetaData for DataSet AllTypes
DataSetMetaDataType allTypesMetaData = CreateDataSetMetaDataAllTypes();
dataSetReaderAllTypes.DataSetMetaData = allTypesMetaData;
// Create and set SubscribedDataSet
subscribedDataSet = new TargetVariablesDataType();
subscribedDataSet.TargetVariables = new FieldTargetDataTypeCollection();
foreach (var fieldMetaData in allTypesMetaData.Fields)
{
subscribedDataSet.TargetVariables.Add(new FieldTargetDataType()
{
DataSetFieldId = fieldMetaData.DataSetFieldId,
TargetNodeId = new NodeId(fieldMetaData.Name, NamespaceIndexAllTypes),
AttributeId = Attributes.Value,
OverrideValueHandling = OverrideValueHandling.OverrideValue,
OverrideValue = new Variant(TypeInfo.GetDefaultValue(fieldMetaData.DataType, (int)ValueRanks.Scalar))
});
}
dataSetReaderAllTypes.SubscribedDataSet = new ExtensionObject(subscribedDataSet);
#endregion
readerGroup1.DataSetReaders.Add(dataSetReaderAllTypes);
#endregion
pubSubConnection1.ReaderGroups.Add(readerGroup1);
//create pub sub configuration root object
PubSubConfigurationDataType pubSubConfiguration = new PubSubConfigurationDataType();
pubSubConfiguration.Connections = new PubSubConnectionDataTypeCollection()
{
pubSubConnection1
};
return(pubSubConfiguration);
}
/// <summary>
/// Creates a Subscriber PubSubConfiguration object for MQTT & Json programmatically.
/// </summary>
/// <returns></returns>
private static PubSubConfigurationDataType CreateSubscriberConfiguration_MqttJson(string urlAddress)
{
// Define a PubSub connection with PublisherId 2
PubSubConnectionDataType pubSubConnection1 = new PubSubConnectionDataType();
pubSubConnection1.Name = "Subscriber Connection3 MQTT Json";
pubSubConnection1.Enabled = true;
pubSubConnection1.PublisherId = (UInt16)2;
pubSubConnection1.TransportProfileUri = Profiles.PubSubMqttJsonTransport;
NetworkAddressUrlDataType address = new NetworkAddressUrlDataType();
// Specify the local Network interface name to be used
// e.g. address.NetworkInterface = "Ethernet";
// Leave empty to subscribe on all available local interfaces.
address.NetworkInterface = String.Empty;
address.Url = urlAddress;
pubSubConnection1.Address = new ExtensionObject(address);
// Configure the mqtt specific configuration with the MQTTbroker
ITransportProtocolConfiguration mqttConfiguration = new MqttClientProtocolConfiguration(version: EnumMqttProtocolVersion.V500);
pubSubConnection1.ConnectionProperties = mqttConfiguration.ConnectionProperties;
// Define "Simple" MetaData
DataSetMetaDataType simpleMetaData = CreateDataSetMetaDataSimple();
// Define "AllTypes" Metadata
DataSetMetaDataType allTypesMetaData = CreateDataSetMetaDataAllTypes();
#region Define ReaderGroup1
ReaderGroupDataType readerGroup1 = new ReaderGroupDataType();
readerGroup1.Name = "ReaderGroup 1";
readerGroup1.Enabled = true;
readerGroup1.MaxNetworkMessageSize = 1500;
readerGroup1.MessageSettings = new ExtensionObject(new ReaderGroupMessageDataType());
readerGroup1.TransportSettings = new ExtensionObject(new ReaderGroupTransportDataType());
#region Define DataSetReader1 'Simple' for PublisherId = (UInt16)3, DataSetWriterId = 1
DataSetReaderDataType dataSetReaderSimple = new DataSetReaderDataType();
dataSetReaderSimple.Name = "Reader 1 MQTT JSON Variant Encoding";
dataSetReaderSimple.PublisherId = (UInt16)2;
dataSetReaderSimple.WriterGroupId = 1;
dataSetReaderSimple.DataSetWriterId = 1;
dataSetReaderSimple.Enabled = true;
dataSetReaderSimple.DataSetFieldContentMask = 0;// Variant encoding;
dataSetReaderSimple.KeyFrameCount = 1;
dataSetReaderSimple.DataSetMetaData = simpleMetaData;
BrokerDataSetReaderTransportDataType brokerTransportSettings = new BrokerDataSetReaderTransportDataType()
{
QueueName = "Json_WriterGroup_1",
};
dataSetReaderSimple.TransportSettings = new ExtensionObject(brokerTransportSettings);
JsonDataSetReaderMessageDataType jsonDataSetReaderMessage = new JsonDataSetReaderMessageDataType()
{
NetworkMessageContentMask = (uint)(uint)(JsonNetworkMessageContentMask.NetworkMessageHeader
| JsonNetworkMessageContentMask.DataSetMessageHeader
| JsonNetworkMessageContentMask.PublisherId
| JsonNetworkMessageContentMask.DataSetClassId
| JsonNetworkMessageContentMask.ReplyTo),
DataSetMessageContentMask = (uint)(JsonDataSetMessageContentMask.DataSetWriterId
| JsonDataSetMessageContentMask.MetaDataVersion
| JsonDataSetMessageContentMask.SequenceNumber
| JsonDataSetMessageContentMask.Status
| JsonDataSetMessageContentMask.Timestamp),
};
dataSetReaderSimple.MessageSettings = new ExtensionObject(jsonDataSetReaderMessage);
TargetVariablesDataType subscribedDataSet = new TargetVariablesDataType();
subscribedDataSet.TargetVariables = new FieldTargetDataTypeCollection();
foreach (var fieldMetaData in simpleMetaData.Fields)
{
subscribedDataSet.TargetVariables.Add(new FieldTargetDataType()
{
DataSetFieldId = fieldMetaData.DataSetFieldId,
TargetNodeId = new NodeId(fieldMetaData.Name, NamespaceIndexSimple),
AttributeId = Attributes.Value,
OverrideValueHandling = OverrideValueHandling.OverrideValue,
OverrideValue = new Variant(TypeInfo.GetDefaultValue(fieldMetaData.DataType, (int)ValueRanks.Scalar))
});
}
dataSetReaderSimple.SubscribedDataSet = new ExtensionObject(subscribedDataSet);
#endregion
readerGroup1.DataSetReaders.Add(dataSetReaderSimple);
#region Define DataSetReader2 'AllTypes' for PublisherId = (UInt16)2, DataSetWriterId = 1
DataSetReaderDataType dataSetReaderAllTypes = new DataSetReaderDataType();
dataSetReaderAllTypes.Name = "Reader 2 MQTT JSON RawData Encoding";
dataSetReaderAllTypes.PublisherId = (UInt16)2;
dataSetReaderAllTypes.WriterGroupId = 1;
dataSetReaderAllTypes.DataSetWriterId = 2;
dataSetReaderAllTypes.Enabled = true;
dataSetReaderAllTypes.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetReaderAllTypes.KeyFrameCount = 1;
dataSetReaderAllTypes.DataSetMetaData = allTypesMetaData;
brokerTransportSettings = new BrokerDataSetReaderTransportDataType()
{
QueueName = "Json_WriterGroup_1",
};
dataSetReaderAllTypes.TransportSettings = new ExtensionObject(brokerTransportSettings);
jsonDataSetReaderMessage = new JsonDataSetReaderMessageDataType()
{
NetworkMessageContentMask = (uint)(JsonNetworkMessageContentMask.NetworkMessageHeader
| JsonNetworkMessageContentMask.DataSetMessageHeader
| JsonNetworkMessageContentMask.PublisherId
| JsonNetworkMessageContentMask.DataSetClassId
| JsonNetworkMessageContentMask.ReplyTo),
DataSetMessageContentMask = (uint)(JsonDataSetMessageContentMask.DataSetWriterId
| JsonDataSetMessageContentMask.MetaDataVersion
| JsonDataSetMessageContentMask.SequenceNumber
| JsonDataSetMessageContentMask.Status
| JsonDataSetMessageContentMask.Timestamp),
};
dataSetReaderAllTypes.MessageSettings = new ExtensionObject(jsonDataSetReaderMessage);
subscribedDataSet = new TargetVariablesDataType();
subscribedDataSet.TargetVariables = new FieldTargetDataTypeCollection();
foreach (var fieldMetaData in allTypesMetaData.Fields)
{
subscribedDataSet.TargetVariables.Add(new FieldTargetDataType()
{
DataSetFieldId = fieldMetaData.DataSetFieldId,
TargetNodeId = new NodeId(fieldMetaData.Name, NamespaceIndexSimple),
AttributeId = Attributes.Value,
OverrideValueHandling = OverrideValueHandling.OverrideValue,
OverrideValue = new Variant(TypeInfo.GetDefaultValue(fieldMetaData.DataType, (int)ValueRanks.Scalar))
});
}
dataSetReaderAllTypes.SubscribedDataSet = new ExtensionObject(subscribedDataSet);
#endregion
readerGroup1.DataSetReaders.Add(dataSetReaderAllTypes);
#endregion
pubSubConnection1.ReaderGroups.Add(readerGroup1);
//create pub sub configuration root object
PubSubConfigurationDataType pubSubConfiguration = new PubSubConfigurationDataType();
pubSubConfiguration.Connections = new PubSubConnectionDataTypeCollection()
{
pubSubConnection1
};
return(pubSubConfiguration);
}
/// <summary>
/// Creates a PubSubConfiguration object programmatically.
/// </summary>
/// <returns></returns>
public static PubSubConfigurationDataType CreateSubscriberConfiguration()
{
// Define a PubSub connection with PublisherId 100
PubSubConnectionDataType pubSubConnection1 = new PubSubConnectionDataType();
pubSubConnection1.Name = "UADPConnection1";
pubSubConnection1.Enabled = true;
pubSubConnection1.PublisherId = (UInt16)100;
pubSubConnection1.TransportProfileUri = Profiles.UadpTransport;
NetworkAddressUrlDataType address = new NetworkAddressUrlDataType();
// Specify the local Network interface name to be used
// e.g. address.NetworkInterface = "Ethernet";
// Leave empty to subscribe on all available local interfaces.
address.NetworkInterface = String.Empty;
address.Url = "opc.udp://239.0.0.1:4840";
pubSubConnection1.Address = new ExtensionObject(address);
#region Define 'Simple' MetaData
DataSetMetaDataType simpleMetaData = new DataSetMetaDataType();
simpleMetaData.DataSetClassId = new Uuid(Guid.Empty);
simpleMetaData.Name = "Simple";
simpleMetaData.Fields = new FieldMetaDataCollection()
{
new FieldMetaData()
{
Name = "BoolToggle",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.Boolean,
DataType = DataTypeIds.Boolean,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "Int32",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.Int32,
DataType = DataTypeIds.Int32,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "Int32Fast",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.Int32,
DataType = DataTypeIds.Int32,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "DateTime",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.DateTime,
DataType = DataTypeIds.DateTime,
ValueRank = ValueRanks.Scalar
},
};
simpleMetaData.ConfigurationVersion = new ConfigurationVersionDataType()
{
MinorVersion = 1,
MajorVersion = 1
};
#endregion
#region Define 'AllTypes' Metadata
DataSetMetaDataType allTypesMetaData = new DataSetMetaDataType();
allTypesMetaData.DataSetClassId = new Uuid(Guid.Empty);
allTypesMetaData.Name = "AllTypes";
allTypesMetaData.Fields = new FieldMetaDataCollection()
{
new FieldMetaData()
{
Name = "BoolToggle",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.Boolean,
DataType = DataTypeIds.Boolean,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "Byte",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.Byte,
DataType = DataTypeIds.Byte,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "Int16",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.Int16,
DataType = DataTypeIds.Int16,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "Int32",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.Int32,
DataType = DataTypeIds.Int32,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "SByte",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.SByte,
DataType = DataTypeIds.SByte,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "UInt16",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.UInt16,
DataType = DataTypeIds.UInt16,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "UInt32",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.UInt32,
DataType = DataTypeIds.UInt32,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "Float",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.Float,
DataType = DataTypeIds.Float,
ValueRank = ValueRanks.Scalar
},
new FieldMetaData()
{
Name = "Double",
DataSetFieldId = new Uuid(Guid.NewGuid()),
BuiltInType = (byte)DataTypes.Double,
DataType = DataTypeIds.Double,
ValueRank = ValueRanks.Scalar
},
};
allTypesMetaData.ConfigurationVersion = new ConfigurationVersionDataType()
{
MinorVersion = 1,
MajorVersion = 1
};
#endregion
#region Define ReaderGroup1
ReaderGroupDataType readerGroup1 = new ReaderGroupDataType();
readerGroup1.Name = "ReaderGroup 1";
readerGroup1.Enabled = true;
readerGroup1.MaxNetworkMessageSize = 1500;
readerGroup1.MessageSettings = new ExtensionObject(new ReaderGroupMessageDataType());
readerGroup1.TransportSettings = new ExtensionObject(new ReaderGroupTransportDataType());
#region Define DataSetReader 'Simple' for PublisherId = (UInt16)100, DataSetWriterId = 1
DataSetReaderDataType dataSetReaderSimple = new DataSetReaderDataType();
dataSetReaderSimple.Name = "Reader 1";
dataSetReaderSimple.PublisherId = (UInt16)100;
dataSetReaderSimple.WriterGroupId = 0;
dataSetReaderSimple.DataSetWriterId = 0;
dataSetReaderSimple.Enabled = true;
dataSetReaderSimple.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetReaderSimple.KeyFrameCount = 1;
dataSetReaderSimple.DataSetMetaData = simpleMetaData;
UadpDataSetReaderMessageDataType uadpDataSetReaderMessage = new UadpDataSetReaderMessageDataType()
{
GroupVersion = 0,
DataSetOffset = 15,
NetworkMessageNumber = 0,
NetworkMessageContentMask = (uint)(uint)(UadpNetworkMessageContentMask.PublisherId | UadpNetworkMessageContentMask.GroupHeader
| UadpNetworkMessageContentMask.WriterGroupId | UadpNetworkMessageContentMask.GroupVersion
| UadpNetworkMessageContentMask.NetworkMessageNumber | UadpNetworkMessageContentMask.SequenceNumber),
DataSetMessageContentMask = (uint)(UadpDataSetMessageContentMask.Status | UadpDataSetMessageContentMask.SequenceNumber),
};
dataSetReaderSimple.MessageSettings = new ExtensionObject(uadpDataSetReaderMessage);
TargetVariablesDataType subscribedDataSet = new TargetVariablesDataType();
subscribedDataSet.TargetVariables = new FieldTargetDataTypeCollection();
foreach (var fieldMetaData in simpleMetaData.Fields)
{
subscribedDataSet.TargetVariables.Add(new FieldTargetDataType()
{
DataSetFieldId = fieldMetaData.DataSetFieldId,
TargetNodeId = new NodeId(fieldMetaData.Name, NamespaceIndexSimple),
AttributeId = Attributes.Value,
OverrideValueHandling = OverrideValueHandling.OverrideValue,
OverrideValue = new Variant(TypeInfo.GetDefaultValue(fieldMetaData.DataType, (int)ValueRanks.Scalar))
});
}
dataSetReaderSimple.SubscribedDataSet = new ExtensionObject(subscribedDataSet);
#endregion
readerGroup1.DataSetReaders.Add(dataSetReaderSimple);
#region Define DataSetReader 'AllTypes' for PublisherId = (UInt16)100, DataSetWriterId = 2
DataSetReaderDataType dataSetReaderAllTypes = new DataSetReaderDataType();
dataSetReaderAllTypes.Name = "Reader 2";
dataSetReaderAllTypes.PublisherId = (UInt16)100;
dataSetReaderAllTypes.WriterGroupId = 0;
dataSetReaderAllTypes.DataSetWriterId = 0;
dataSetReaderAllTypes.Enabled = true;
dataSetReaderAllTypes.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetReaderAllTypes.KeyFrameCount = 1;
dataSetReaderAllTypes.DataSetMetaData = allTypesMetaData;
uadpDataSetReaderMessage = new UadpDataSetReaderMessageDataType()
{
GroupVersion = 0,
DataSetOffset = 47,
NetworkMessageNumber = 0,
NetworkMessageContentMask = (uint)(uint)(UadpNetworkMessageContentMask.PublisherId | UadpNetworkMessageContentMask.GroupHeader
| UadpNetworkMessageContentMask.WriterGroupId | UadpNetworkMessageContentMask.GroupVersion
| UadpNetworkMessageContentMask.NetworkMessageNumber | UadpNetworkMessageContentMask.SequenceNumber),
DataSetMessageContentMask = (uint)(UadpDataSetMessageContentMask.Status | UadpDataSetMessageContentMask.SequenceNumber),
};
dataSetReaderAllTypes.MessageSettings = new ExtensionObject(uadpDataSetReaderMessage);
subscribedDataSet = new TargetVariablesDataType();
subscribedDataSet.TargetVariables = new FieldTargetDataTypeCollection();
foreach (var fieldMetaData in allTypesMetaData.Fields)
{
subscribedDataSet.TargetVariables.Add(new FieldTargetDataType()
{
DataSetFieldId = fieldMetaData.DataSetFieldId,
TargetNodeId = new NodeId(fieldMetaData.Name, NamespaceIndexAllTypes),
AttributeId = Attributes.Value,
OverrideValueHandling = OverrideValueHandling.OverrideValue,
OverrideValue = new Variant(TypeInfo.GetDefaultValue(fieldMetaData.DataType, (int)ValueRanks.Scalar))
});
}
dataSetReaderAllTypes.SubscribedDataSet = new ExtensionObject(subscribedDataSet);
#endregion
readerGroup1.DataSetReaders.Add(dataSetReaderAllTypes);
#endregion
pubSubConnection1.ReaderGroups.Add(readerGroup1);
//create pub sub configuration root object
PubSubConfigurationDataType pubSubConfiguration = new PubSubConfigurationDataType();
pubSubConfiguration.Connections = new PubSubConnectionDataTypeCollection()
{
pubSubConnection1
};
return(pubSubConfiguration);
}
public void ValidateUdpPubSubConnectionNetworkMessagePublishBroadcast()
{
//Arrange
var localhost = GetFirstNic();
Assert.IsNotNull(localhost, "localhost is null");
Assert.IsNotNull(localhost.Address, "localhost.Address is null");
//create publisher configuration object with modified port
string configurationFile = Utils.GetAbsoluteFilePath(PublisherConfigurationFileName, true, true, false);
PubSubConfigurationDataType publisherConfiguration = UaPubSubConfigurationHelper.LoadConfiguration(configurationFile);
Assert.IsNotNull(publisherConfiguration, "publisherConfiguration is null");
IPAddress broadcastIPAddress = GetFirstNicLastIPByteChanged(255);
Assert.IsNotNull(broadcastIPAddress, "broadcastIPAddress is null");
NetworkAddressUrlDataType publisherAddress = new NetworkAddressUrlDataType();
publisherAddress.Url = "opc.udp://" + broadcastIPAddress.ToString() + ":4840";
publisherConfiguration.Connections[0].Address = new ExtensionObject(publisherAddress);
//create publisher UaPubSubApplication with changed configuration settings
UaPubSubApplication publisherApplication = UaPubSubApplication.Create(publisherConfiguration);
Assert.IsNotNull(publisherApplication, "publisherApplication is null");
UdpPubSubConnection publisherConnection = publisherApplication.PubSubConnections[0] as UdpPubSubConnection;
Assert.IsNotNull(publisherConnection, "publisherConnection is null");
// will signal that the uadp message was received from local ip
m_shutdownEvent = new ManualResetEvent(false);
//setup uadp client for receiving from broadcast (simulate a subscriber broadcast)
UdpClient udpBroadcastClient = new UdpClientBroadcast(localhost.Address, 4840, UsedInContext.Subscriber);
udpBroadcastClient.BeginReceive(new AsyncCallback(OnReceive), udpBroadcastClient);
// prepare a network message
WriterGroupDataType writerGroup0 = publisherConnection.PubSubConnectionConfiguration.WriterGroups.First();
IList <UaNetworkMessage> networkMessages = publisherConnection.CreateNetworkMessages(writerGroup0);
Assert.IsNotNull(networkMessages, "connection.CreateNetworkMessages shall not return null");
//Act
publisherConnection.Start();
if (networkMessages != null)
{
foreach (UaNetworkMessage uaNetworkMessage in networkMessages)
{
if (uaNetworkMessage != null)
{
publisherConnection.PublishNetworkMessage(uaNetworkMessage);
}
}
}
//Assert
if (!m_shutdownEvent.WaitOne(EstimatedPublishingTime))
{
Assert.Fail("The UADP message was not received");
}
publisherConnection.Stop();
udpBroadcastClient.Close();
udpBroadcastClient.Dispose();
}
/// <summary>
/// Creates a PubSubConfiguration object for MQTT & Json programmatically.
/// </summary>
/// <returns></returns>
private static PubSubConfigurationDataType CreatePublisherConfiguration_MqttJson(string urlAddress)
{
// Define a PubSub connection with PublisherId 100
PubSubConnectionDataType pubSubConnection1 = new PubSubConnectionDataType();
pubSubConnection1.Name = "Publisher Connection3 MQTT Json";
pubSubConnection1.Enabled = true;
pubSubConnection1.PublisherId = (UInt16)2;
pubSubConnection1.TransportProfileUri = Profiles.PubSubMqttJsonTransport;
NetworkAddressUrlDataType address = new NetworkAddressUrlDataType();
// Specify the local Network interface name to be used
// e.g. address.NetworkInterface = "Ethernet";
// Leave empty to publish on all available local interfaces.
address.NetworkInterface = String.Empty;
address.Url = urlAddress;
pubSubConnection1.Address = new ExtensionObject(address);
// Configure the mqtt specific configuration with the MQTTbroker
ITransportProtocolConfiguration mqttConfiguration = new MqttClientProtocolConfiguration(version: EnumMqttProtocolVersion.V500);
pubSubConnection1.ConnectionProperties = mqttConfiguration.ConnectionProperties;
string brokerQueueName = "Json_WriterGroup_1";
string brokerMetaData = "$Metadata";
#region Define WriterGroup1 - Json
WriterGroupDataType writerGroup1 = new WriterGroupDataType();
writerGroup1.Name = "WriterGroup 1";
writerGroup1.Enabled = true;
writerGroup1.WriterGroupId = 1;
writerGroup1.PublishingInterval = 5000;
writerGroup1.KeepAliveTime = 5000;
writerGroup1.MaxNetworkMessageSize = 1500;
JsonWriterGroupMessageDataType jsonMessageSettings = new JsonWriterGroupMessageDataType()
{
NetworkMessageContentMask = (uint)(JsonNetworkMessageContentMask.NetworkMessageHeader
| JsonNetworkMessageContentMask.DataSetMessageHeader
| JsonNetworkMessageContentMask.PublisherId
| JsonNetworkMessageContentMask.DataSetClassId
| JsonNetworkMessageContentMask.ReplyTo)
};
writerGroup1.MessageSettings = new ExtensionObject(jsonMessageSettings);
writerGroup1.TransportSettings = new ExtensionObject(new BrokerWriterGroupTransportDataType()
{
QueueName = brokerQueueName,
}
);
// Define DataSetWriter 'Simple' Variant encoding
DataSetWriterDataType dataSetWriter1 = new DataSetWriterDataType();
dataSetWriter1.Name = "Writer Variant Encoding";
dataSetWriter1.DataSetWriterId = 1;
dataSetWriter1.Enabled = true;
dataSetWriter1.DataSetFieldContentMask = 0;// Variant encoding;
dataSetWriter1.DataSetName = "Simple";
dataSetWriter1.KeyFrameCount = 1;
JsonDataSetWriterMessageDataType jsonDataSetWriterMessage = new JsonDataSetWriterMessageDataType()
{
DataSetMessageContentMask = (uint)(JsonDataSetMessageContentMask.DataSetWriterId
| JsonDataSetMessageContentMask.MetaDataVersion
| JsonDataSetMessageContentMask.SequenceNumber
| JsonDataSetMessageContentMask.Status
| JsonDataSetMessageContentMask.Timestamp),
};
dataSetWriter1.MessageSettings = new ExtensionObject(jsonDataSetWriterMessage);
BrokerDataSetWriterTransportDataType jsonDataSetWriterTransport = new BrokerDataSetWriterTransportDataType()
{
QueueName = brokerQueueName,
MetaDataQueueName = $"{brokerQueueName}/{brokerMetaData}",
MetaDataUpdateTime = 10000
};
dataSetWriter1.TransportSettings = new ExtensionObject(jsonDataSetWriterTransport);
writerGroup1.DataSetWriters.Add(dataSetWriter1);
// Define DataSetWriter 'Simple' - Variant encoding
DataSetWriterDataType dataSetWriter2 = new DataSetWriterDataType();
dataSetWriter2.Name = "Writer RawData Encoding";
dataSetWriter2.DataSetWriterId = 2;
dataSetWriter2.Enabled = true;
dataSetWriter2.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetWriter2.DataSetName = "AllTypes";
dataSetWriter2.KeyFrameCount = 1;
jsonDataSetWriterMessage = new JsonDataSetWriterMessageDataType()
{
DataSetMessageContentMask = (uint)(JsonDataSetMessageContentMask.DataSetWriterId
| JsonDataSetMessageContentMask.SequenceNumber
| JsonDataSetMessageContentMask.Status
| JsonDataSetMessageContentMask.Timestamp),
};
dataSetWriter2.MessageSettings = new ExtensionObject(jsonDataSetWriterMessage);
dataSetWriter2.TransportSettings = new ExtensionObject(jsonDataSetWriterTransport);
writerGroup1.DataSetWriters.Add(dataSetWriter2);
pubSubConnection1.WriterGroups.Add(writerGroup1);
#endregion
// Define PublishedDataSet Simple
PublishedDataSetDataType publishedDataSetSimple = CreatePublishedDataSetSimple();
// Define PublishedDataSet AllTypes
PublishedDataSetDataType publishedDataSetAllTypes = CreatePublishedDataSetAllTypes();
//create the PubSub configuration root object
PubSubConfigurationDataType pubSubConfiguration = new PubSubConfigurationDataType();
pubSubConfiguration.Connections = new PubSubConnectionDataTypeCollection()
{
pubSubConnection1
};
pubSubConfiguration.PublishedDataSets = new PublishedDataSetDataTypeCollection()
{
publishedDataSetSimple, publishedDataSetAllTypes
};
return(pubSubConfiguration);
}
/// <summary>
/// Creates a PubSubConfiguration object for UDP & UADP programmatically.
/// </summary>
/// <returns></returns>
private static PubSubConfigurationDataType CreatePublisherConfiguration_UdpUadp(string urlAddress)
{
// Define a PubSub connection with PublisherId 1
PubSubConnectionDataType pubSubConnection1 = new PubSubConnectionDataType();
pubSubConnection1.Name = "Publisher Connection1 UDP UADP";
pubSubConnection1.Enabled = true;
pubSubConnection1.PublisherId = (UInt16)1;
pubSubConnection1.TransportProfileUri = Profiles.PubSubUdpUadpTransport;
NetworkAddressUrlDataType address = new NetworkAddressUrlDataType();
// Specify the local Network interface name to be used
// e.g. address.NetworkInterface = "Ethernet";
// Leave empty to publish on all available local interfaces.
address.NetworkInterface = String.Empty;
address.Url = urlAddress;
pubSubConnection1.Address = new ExtensionObject(address);
#region Define WriterGroup1
WriterGroupDataType writerGroup1 = new WriterGroupDataType();
writerGroup1.Name = "WriterGroup 1";
writerGroup1.Enabled = true;
writerGroup1.WriterGroupId = 1;
writerGroup1.PublishingInterval = 5000;
writerGroup1.KeepAliveTime = 5000;
writerGroup1.MaxNetworkMessageSize = 1500;
writerGroup1.HeaderLayoutUri = "UADP-Cyclic-Fixed";
UadpWriterGroupMessageDataType uadpMessageSettings = new UadpWriterGroupMessageDataType()
{
DataSetOrdering = DataSetOrderingType.AscendingWriterId,
GroupVersion = 0,
NetworkMessageContentMask = (uint)(UadpNetworkMessageContentMask.PublisherId
| UadpNetworkMessageContentMask.GroupHeader
| UadpNetworkMessageContentMask.WriterGroupId
| UadpNetworkMessageContentMask.GroupVersion
| UadpNetworkMessageContentMask.NetworkMessageNumber
| UadpNetworkMessageContentMask.SequenceNumber)
};
writerGroup1.MessageSettings = new ExtensionObject(uadpMessageSettings);
// initialize Datagram (UDP) Transport Settings
writerGroup1.TransportSettings = new ExtensionObject(new DatagramWriterGroupTransportDataType());
// Define DataSetWriter 'Simple'
DataSetWriterDataType dataSetWriter1 = new DataSetWriterDataType();
dataSetWriter1.Name = "Writer 1";
dataSetWriter1.DataSetWriterId = 1;
dataSetWriter1.Enabled = true;
dataSetWriter1.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetWriter1.DataSetName = "Simple";
dataSetWriter1.KeyFrameCount = 1;
UadpDataSetWriterMessageDataType uadpDataSetWriterMessage = new UadpDataSetWriterMessageDataType()
{
ConfiguredSize = 32,
DataSetOffset = 15,
NetworkMessageNumber = 1,
DataSetMessageContentMask = (uint)(UadpDataSetMessageContentMask.Status | UadpDataSetMessageContentMask.SequenceNumber),
};
dataSetWriter1.MessageSettings = new ExtensionObject(uadpDataSetWriterMessage);
writerGroup1.DataSetWriters.Add(dataSetWriter1);
// Define DataSetWriter 'AllTypes'
DataSetWriterDataType dataSetWriter2 = new DataSetWriterDataType();
dataSetWriter2.Name = "Writer 2";
dataSetWriter2.DataSetWriterId = 2;
dataSetWriter2.Enabled = true;
dataSetWriter2.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetWriter2.DataSetName = "AllTypes";
dataSetWriter2.KeyFrameCount = 1;
uadpDataSetWriterMessage = new UadpDataSetWriterMessageDataType()
{
ConfiguredSize = 32,
DataSetOffset = 47,
NetworkMessageNumber = 1,
DataSetMessageContentMask = (uint)(UadpDataSetMessageContentMask.Status | UadpDataSetMessageContentMask.SequenceNumber),
};
dataSetWriter2.MessageSettings = new ExtensionObject(uadpDataSetWriterMessage);
writerGroup1.DataSetWriters.Add(dataSetWriter2);
pubSubConnection1.WriterGroups.Add(writerGroup1);
#endregion
// Define PublishedDataSet Simple
PublishedDataSetDataType publishedDataSetSimple = CreatePublishedDataSetSimple();
// Define PublishedDataSet AllTypes
PublishedDataSetDataType publishedDataSetAllTypes = CreatePublishedDataSetAllTypes();
//create the PubSub configuration root object
PubSubConfigurationDataType pubSubConfiguration = new PubSubConfigurationDataType();
pubSubConfiguration.Connections = new PubSubConnectionDataTypeCollection()
{
pubSubConnection1
};
pubSubConfiguration.PublishedDataSets = new PublishedDataSetDataTypeCollection()
{
publishedDataSetSimple, publishedDataSetAllTypes
};
return(pubSubConfiguration);
}
public void ValidateUdpPubSubConnectionNetworkMessageReceiveFromBroadcast()
{
// Arrange
var localhost = GetFirstNic();
Assert.IsNotNull(localhost, "localhost is null");
Assert.IsNotNull(localhost.Address, "localhost.Address is null");
string configurationFile = Utils.GetAbsoluteFilePath(m_subscriberConfigurationFileName, true, true, false);
PubSubConfigurationDataType subscriberConfiguration = UaPubSubConfigurationHelper.LoadConfiguration(configurationFile);
Assert.IsNotNull(subscriberConfiguration, "subscriberConfiguration is null");
NetworkAddressUrlDataType subscriberAddress = new NetworkAddressUrlDataType();
subscriberAddress.Url = string.Format(kUdpUrlFormat, Utils.UriSchemeOpcUdp, localhost.Address.ToString());
subscriberConfiguration.Connections.First().Address = new ExtensionObject(subscriberAddress);
UaPubSubApplication subscriberApplication = UaPubSubApplication.Create(subscriberConfiguration);
Assert.IsNotNull(subscriberApplication, "subscriberApplication is null");
UdpPubSubConnection subscriberConnection = subscriberApplication.PubSubConnections.First() as UdpPubSubConnection;
Assert.IsNotNull(subscriberConnection, "subscriberConnection is null");
subscriberApplication.RawDataReceived += RawDataReceived;
configurationFile = Utils.GetAbsoluteFilePath(m_publisherConfigurationFileName, true, true, false);
PubSubConfigurationDataType publisherConfiguration = UaPubSubConfigurationHelper.LoadConfiguration(configurationFile);
Assert.IsNotNull(publisherConfiguration, "publisherConfiguration is null");
IPAddress broadcastIPAddress = GetFirstNicLastIPByteChanged(255);
Assert.IsNotNull(broadcastIPAddress, "broadcastIPAddress is null");
NetworkAddressUrlDataType publisherAddress = new NetworkAddressUrlDataType();
publisherAddress.Url = string.Format(kUdpUrlFormat, Utils.UriSchemeOpcUdp, broadcastIPAddress.ToString());
publisherConfiguration.Connections.First().Address = new ExtensionObject(publisherAddress);
UaPubSubApplication publisherApplication = UaPubSubApplication.Create(publisherConfiguration);
Assert.IsNotNull(publisherApplication, "publisherApplication is null");
UdpPubSubConnection publisherConnection = publisherApplication.PubSubConnections.First() as UdpPubSubConnection;
Assert.IsNotNull(publisherConnection, "publisherConnection is null");
//Act
subscriberConnection.Start();
m_shutdownEvent = new ManualResetEvent(false);
m_sentBytes = PrepareData(publisherConnection);
// first physical network ip is mandatory on UdpClientBroadcast as parameter
UdpClient udpBroadcastClient = new UdpClientBroadcast(localhost.Address, kDiscoveryPortNo, UsedInContext.Publisher);
Assert.IsNotNull(udpBroadcastClient, "udpBroadcastClient is null");
IPEndPoint remoteEndPoint = new IPEndPoint(broadcastIPAddress, kDiscoveryPortNo);
int sentBytesLen = udpBroadcastClient.Send(m_sentBytes, m_sentBytes.Length, remoteEndPoint);
Assert.AreEqual(sentBytesLen, m_sentBytes.Length, "Sent bytes size not equal to published bytes size!");
Thread.Sleep(kEstimatedPublishingTime);
// Assert
if (!m_shutdownEvent.WaitOne(kEstimatedPublishingTime))
{
Assert.Fail("Subscriber broadcast error ... published data not received");
}
subscriberConnection.Stop();
}
public void ValidateUdpPubSubConnectionNetworkMessageDiscoveryPublish()
{
//Arrange
var localhost = GetFirstNic();
Assert.IsNotNull(localhost, "localhost is null");
Assert.IsNotNull(localhost.Address, "localhost.Address is null");
//create publisher configuration object with modified port
string configurationFile = Utils.GetAbsoluteFilePath(m_publisherConfigurationFileName, true, true, false);
PubSubConfigurationDataType publisherConfiguration = UaPubSubConfigurationHelper.LoadConfiguration(configurationFile);
Assert.IsNotNull(publisherConfiguration, "publisherConfiguration is null");
Assert.Greater(publisherConfiguration.Connections.Count, 1, "publisherConfiguration.Connection should be > 0");
//discovery IP adress 224.0.2.14
IPAddress[] multicastIPAddresses = Dns.GetHostAddresses(kUdpDiscoveryIp);
IPAddress multicastIPAddress = multicastIPAddresses.First();
Assert.IsNotNull(multicastIPAddress, "multicastIPAddress is null");
NetworkAddressUrlDataType publisherAddress = new NetworkAddressUrlDataType();
publisherAddress.Url = string.Format(kUdpUrlFormat, Utils.UriSchemeOpcUdp, multicastIPAddress.ToString());
publisherConfiguration.Connections[0].Address = new ExtensionObject(publisherAddress);
//create publisher UaPubSubApplication with changed configuration settings
UaPubSubApplication publisherApplication = UaPubSubApplication.Create(publisherConfiguration);
Assert.IsNotNull(publisherApplication, "publisherApplication is null");
UdpPubSubConnection publisherConnection = publisherApplication.PubSubConnections.First() as UdpPubSubConnection;
Assert.IsNotNull(publisherConnection, "publisherConnection is null");
// will signal that the uadp message was received from local ip
m_shutdownEvent = new ManualResetEvent(false);
//setup uadp client for receiving from multicast (simulate a subscriber multicast)
UdpClient udpMulticastClient = new UdpClientMulticast(localhost.Address, multicastIPAddress, kDiscoveryPortNo);
udpMulticastClient.BeginReceive(new AsyncCallback(OnReceive), udpMulticastClient);
// prepare a network message
WriterGroupDataType writerGroup0 = publisherConnection.PubSubConnectionConfiguration.WriterGroups.First();
List <UInt16> dataSetWriterIds = new List <UInt16>();
foreach (DataSetWriterDataType dataSetWriterDataType in writerGroup0.DataSetWriters)
{
dataSetWriterIds.Add(dataSetWriterDataType.DataSetWriterId);
}
IList <UaNetworkMessage> networkMessages = publisherConnection.CreateDataSetMetaDataNetworkMessages(dataSetWriterIds.ToArray());
Assert.IsNotNull(networkMessages, "connection.CreateNetworkMessages shall not return null");
//Act
publisherConnection.Start();
if (networkMessages != null)
{
foreach (UaNetworkMessage uaNetworkMessage in networkMessages)
{
if (uaNetworkMessage != null)
{
publisherConnection.PublishNetworkMessage(uaNetworkMessage);
}
}
}
//Assert
bool noMessageReceived = false;
if (!m_shutdownEvent.WaitOne(kEstimatedPublishingTime))
{
noMessageReceived = true;
}
publisherConnection.Stop();
udpMulticastClient.Close();
udpMulticastClient.Dispose();
if (noMessageReceived)
{
Assert.Fail("The UDP message was not received");
}
}
public void ValidateUdpPubSubConnectionNetworkMessagePublishUnicast()
{
//Arrange
var localhost = GetFirstNic();
Assert.IsNotNull(localhost, "localhost is null");
Assert.IsNotNull(localhost.Address, "localhost.Address is null");
//create publisher configuration object with modified port
string configurationFile = Utils.GetAbsoluteFilePath(PublisherConfigurationFileName, true, true, false);
PubSubConfigurationDataType publisherConfiguration = UaPubSubConfigurationHelper.LoadConfiguration(configurationFile);
Assert.IsNotNull(publisherConfiguration, "publisherConfiguration is null");
Assert.Greater(publisherConfiguration.Connections.Count, 1, "publisherConfiguration.Connection should be > 0");
IPAddress unicastIPAddress = localhost.Address;
Assert.IsNotNull(unicastIPAddress, "unicastIPAddress is null");
NetworkAddressUrlDataType publisherAddress = new NetworkAddressUrlDataType();
publisherAddress.Url = string.Format(UdpUrlFormat, Utils.UriSchemeOpcUdp, unicastIPAddress.ToString());
publisherConfiguration.Connections.First().Address = new ExtensionObject(publisherAddress);
//create publisher UaPubSubApplication with changed configuration settings
UaPubSubApplication publisherApplication = UaPubSubApplication.Create(publisherConfiguration);
Assert.IsNotNull(publisherApplication, "publisherApplication is null");
UdpPubSubConnection publisherConnection = publisherApplication.PubSubConnections.First() as UdpPubSubConnection;
Assert.IsNotNull(publisherConnection, "publisherConnection is null");
// will signal that the uadp message was received from local ip
m_shutdownEvent = new ManualResetEvent(false);
//setup uadp client for receiving from multicast (simulate a subscriber unicast)
UdpClient udpUnicastClient = new UdpClientUnicast(localhost.Address, DiscoveryPortNo);
Assert.IsNotNull(udpUnicastClient, "udpUnicastClient is null");
udpUnicastClient.BeginReceive(new AsyncCallback(OnReceive), udpUnicastClient);
// prepare a network message
WriterGroupDataType writerGroup0 = publisherConnection.PubSubConnectionConfiguration.WriterGroups.First();
Assert.IsNotNull(writerGroup0, "writerGroup0 is null");
System.Collections.Generic.IList <UaNetworkMessage> networkMessages = publisherConnection.CreateNetworkMessages(writerGroup0, new WriterGroupPublishState());
Assert.IsNotNull(networkMessages, "connection.CreateNetworkMessages shall not return null");
//Act
publisherConnection.Start();
if (networkMessages != null)
{
foreach (UaNetworkMessage uaNetworkMessage in networkMessages)
{
if (uaNetworkMessage != null)
{
publisherConnection.PublishNetworkMessage(uaNetworkMessage);
}
}
}
//Assert
bool noMessageReceived = false;
if (!m_shutdownEvent.WaitOne(EstimatedPublishingTime))
{
noMessageReceived = true;
}
publisherConnection.Stop();
udpUnicastClient.Close();
udpUnicastClient.Dispose();
if (noMessageReceived == true)
{
Assert.Fail("The UDP message was not received");
}
}
/// <summary>
/// Creates a Subscriber PubSubConfiguration object for UDP & UADP programmatically.
/// </summary>
/// <returns></returns>
private static PubSubConfigurationDataType CreateSubscriberConfiguration_UdpUadp(string urlAddress)
{
// Define a PubSub connection with PublisherId 1
PubSubConnectionDataType pubSubConnection1 = new PubSubConnectionDataType();
pubSubConnection1.Name = "Subscriber Connection UDP UADP";
pubSubConnection1.Enabled = true;
pubSubConnection1.PublisherId = (UInt16)1;
pubSubConnection1.TransportProfileUri = Profiles.PubSubUdpUadpTransport;
NetworkAddressUrlDataType address = new NetworkAddressUrlDataType();
// Specify the local Network interface name to be used
// e.g. address.NetworkInterface = "Ethernet";
// Leave empty to subscribe on all available local interfaces.
address.NetworkInterface = String.Empty;
address.Url = urlAddress;
pubSubConnection1.Address = new ExtensionObject(address);
// configure custoom DicoveryAddress for Dicovery messages
pubSubConnection1.TransportSettings = new ExtensionObject()
{
Body = new DatagramConnectionTransportDataType()
{
DiscoveryAddress = new ExtensionObject()
{
Body = new NetworkAddressUrlDataType()
{
Url = "opc.udp://224.0.2.15:4840"
}
}
}
};
#region Define ReaderGroup1
ReaderGroupDataType readerGroup1 = new ReaderGroupDataType();
readerGroup1.Name = "ReaderGroup 1";
readerGroup1.Enabled = true;
readerGroup1.MaxNetworkMessageSize = 1500;
readerGroup1.MessageSettings = new ExtensionObject(new ReaderGroupMessageDataType());
readerGroup1.TransportSettings = new ExtensionObject(new ReaderGroupTransportDataType());
#region Define DataSetReader 'Simple' for PublisherId = (UInt16)1, DataSetWriterId = 1
DataSetReaderDataType dataSetReaderSimple = new DataSetReaderDataType();
dataSetReaderSimple.Name = "Reader 1 UDP UADP";
dataSetReaderSimple.PublisherId = (UInt16)1;
dataSetReaderSimple.WriterGroupId = 0;
dataSetReaderSimple.DataSetWriterId = 1;
dataSetReaderSimple.Enabled = true;
dataSetReaderSimple.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetReaderSimple.KeyFrameCount = 1;
dataSetReaderSimple.TransportSettings = new ExtensionObject(new DataSetReaderTransportDataType());
UadpDataSetReaderMessageDataType uadpDataSetReaderMessage = new UadpDataSetReaderMessageDataType()
{
GroupVersion = 0,
NetworkMessageNumber = 0,
NetworkMessageContentMask = (uint)(uint)(UadpNetworkMessageContentMask.PublisherId
| UadpNetworkMessageContentMask.GroupHeader
| UadpNetworkMessageContentMask.WriterGroupId
| UadpNetworkMessageContentMask.GroupVersion
| UadpNetworkMessageContentMask.NetworkMessageNumber
| UadpNetworkMessageContentMask.SequenceNumber),
DataSetMessageContentMask = (uint)(UadpDataSetMessageContentMask.Status | UadpDataSetMessageContentMask.SequenceNumber),
};
dataSetReaderSimple.MessageSettings = new ExtensionObject(uadpDataSetReaderMessage);
// Create and set DataSetMetaData for DataSet Simple
DataSetMetaDataType simpleMetaData = CreateDataSetMetaDataSimple();
dataSetReaderSimple.DataSetMetaData = simpleMetaData;
// Create and set SubscribedDataSet
TargetVariablesDataType subscribedDataSet = new TargetVariablesDataType();
subscribedDataSet.TargetVariables = new FieldTargetDataTypeCollection();
foreach (var fieldMetaData in simpleMetaData.Fields)
{
subscribedDataSet.TargetVariables.Add(new FieldTargetDataType()
{
DataSetFieldId = fieldMetaData.DataSetFieldId,
TargetNodeId = new NodeId(fieldMetaData.Name, NamespaceIndexSimple),
AttributeId = Attributes.Value,
OverrideValueHandling = OverrideValueHandling.OverrideValue,
OverrideValue = new Variant(TypeInfo.GetDefaultValue(fieldMetaData.DataType, (int)ValueRanks.Scalar))
});
}
dataSetReaderSimple.SubscribedDataSet = new ExtensionObject(subscribedDataSet);
#endregion
readerGroup1.DataSetReaders.Add(dataSetReaderSimple);
#region Define DataSetReader 'AllTypes' for PublisherId = (UInt16)1, DataSetWriterId = 2
DataSetReaderDataType dataSetReaderAllTypes = new DataSetReaderDataType();
dataSetReaderAllTypes.Name = "Reader 2 UDP UADP";
dataSetReaderAllTypes.PublisherId = (UInt16)1;
dataSetReaderAllTypes.WriterGroupId = 0;
dataSetReaderAllTypes.DataSetWriterId = 2;
dataSetReaderAllTypes.Enabled = true;
dataSetReaderAllTypes.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetReaderAllTypes.KeyFrameCount = 1;
dataSetReaderAllTypes.TransportSettings = new ExtensionObject(new DataSetReaderTransportDataType());
uadpDataSetReaderMessage = new UadpDataSetReaderMessageDataType()
{
GroupVersion = 0,
NetworkMessageNumber = 0,
NetworkMessageContentMask = (uint)(uint)(UadpNetworkMessageContentMask.PublisherId
| UadpNetworkMessageContentMask.GroupHeader
| UadpNetworkMessageContentMask.WriterGroupId
| UadpNetworkMessageContentMask.GroupVersion
| UadpNetworkMessageContentMask.NetworkMessageNumber
| UadpNetworkMessageContentMask.SequenceNumber),
DataSetMessageContentMask = (uint)(UadpDataSetMessageContentMask.Status | UadpDataSetMessageContentMask.SequenceNumber),
};
dataSetReaderAllTypes.MessageSettings = new ExtensionObject(uadpDataSetReaderMessage);
// Create and set DataSetMetaData for DataSet AllTypes
DataSetMetaDataType allTypesMetaData = CreateDataSetMetaDataAllTypes();
dataSetReaderAllTypes.DataSetMetaData = allTypesMetaData;
// Create and set SubscribedDataSet
subscribedDataSet = new TargetVariablesDataType();
subscribedDataSet.TargetVariables = new FieldTargetDataTypeCollection();
foreach (var fieldMetaData in allTypesMetaData.Fields)
{
subscribedDataSet.TargetVariables.Add(new FieldTargetDataType()
{
DataSetFieldId = fieldMetaData.DataSetFieldId,
TargetNodeId = new NodeId(fieldMetaData.Name, NamespaceIndexAllTypes),
AttributeId = Attributes.Value,
OverrideValueHandling = OverrideValueHandling.OverrideValue,
OverrideValue = new Variant(TypeInfo.GetDefaultValue(fieldMetaData.DataType, (int)ValueRanks.Scalar))
});
}
dataSetReaderAllTypes.SubscribedDataSet = new ExtensionObject(subscribedDataSet);
#endregion
readerGroup1.DataSetReaders.Add(dataSetReaderAllTypes);
#endregion
pubSubConnection1.ReaderGroups.Add(readerGroup1);
//create pub sub configuration root object
PubSubConfigurationDataType pubSubConfiguration = new PubSubConfigurationDataType();
pubSubConfiguration.Connections = new PubSubConnectionDataTypeCollection()
{
pubSubConnection1
};
return(pubSubConfiguration);
}
/// <summary>
/// Creates and returns a list of <see cref="UdpClient"/> created based on configuration options
/// </summary>
/// <param name="pubSubContext">Is the method called in a publisher context or a subscriber context</param>
/// <param name="networkAddressUrl">The configuration object <see cref="NetworkAddressUrlDataType"/>.</param>
/// <param name="configuredEndpoint">The configured <see cref="IPEndPoint"/> that will be used for data exchange.</param>
/// <returns></returns>
internal static List <UdpClient> GetUdpClients(UsedInContext pubSubContext, NetworkAddressUrlDataType networkAddressUrl, IPEndPoint configuredEndpoint)
{
StringBuilder buffer = new StringBuilder();
buffer.AppendFormat("networkAddressUrl.NetworkInterface = {0} \n", networkAddressUrl != null ? networkAddressUrl.NetworkInterface : "null");
buffer.AppendFormat("networkAddressUrl.Url = {0} \n", networkAddressUrl?.Url != null ? networkAddressUrl?.Url : "null");
buffer.AppendFormat("configuredEndpoint = {0}", configuredEndpoint != null ? configuredEndpoint.ToString() : "null");
Utils.Trace(Utils.TraceMasks.Information, buffer.ToString());
List <UdpClient> udpClients = new List <UdpClient>();
//validate input parameters
if (networkAddressUrl == null || configuredEndpoint == null)
{
//log warning?
return(udpClients);
}
//detect the list on network interfaces that will be used for creating the UdpClient s
List <NetworkInterface> usableNetworkInterfaces = new List <NetworkInterface>();
var interfaces = NetworkInterface.GetAllNetworkInterfaces();
if (string.IsNullOrEmpty(networkAddressUrl.NetworkInterface))
{
Utils.Trace(Utils.TraceMasks.Information, "No NetworkInterface name was provided. Use all available NICs.");
usableNetworkInterfaces.AddRange(interfaces);
}
else
{
//the configuration contains a NetworkInterface name, try to locate it
foreach (NetworkInterface nic in interfaces)
{
if (nic.Name.Equals(networkAddressUrl.NetworkInterface, StringComparison.OrdinalIgnoreCase))
{
usableNetworkInterfaces.Add(nic);
}
}
if (usableNetworkInterfaces.Count == 0)
{
Utils.Trace(Utils.TraceMasks.Information, "The configured value for NetworkInterface name('{0}') could not be used.", networkAddressUrl.NetworkInterface);
usableNetworkInterfaces.AddRange(interfaces);
}
}
foreach (NetworkInterface nic in usableNetworkInterfaces)
{
Utils.Trace(Utils.TraceMasks.Information, "NetworkInterface name('{0}') attempts to create instance of UdpClient.", nic.Name);
//ignore loop-back interface
if (nic.NetworkInterfaceType == NetworkInterfaceType.Loopback)
{
continue;
}
//ignore tunnel interface
if (nic.NetworkInterfaceType == NetworkInterfaceType.Tunnel)
{
continue;
}
UdpClient udpClient = CreateUdpClientForNetworkInterface(pubSubContext, nic, configuredEndpoint);
if (udpClient == null)
{
continue;
}
//store UdpClient
udpClients.Add(udpClient);
Utils.Trace(Utils.TraceMasks.Information, "NetworkInterface name('{0}') UdpClient successfully created.", nic.Name);
}
return(udpClients);
}
/// <summary>
/// Creates a PubSubConfiguration object for MQTT & UADP programmatically.
/// </summary>
/// <returns></returns>
private static PubSubConfigurationDataType CreatePublisherConfiguration_MqttUadp(string urlAddress)
{
// Define a PubSub connection with PublisherId 3
PubSubConnectionDataType pubSubConnection1 = new PubSubConnectionDataType();
pubSubConnection1.Name = "Publisher Connection MQTT UADP";
pubSubConnection1.Enabled = true;
pubSubConnection1.PublisherId = (UInt16)3;
pubSubConnection1.TransportProfileUri = Profiles.PubSubMqttUadpTransport;
NetworkAddressUrlDataType address = new NetworkAddressUrlDataType();
// Specify the local Network interface name to be used
// e.g. address.NetworkInterface = "Ethernet";
// Leave empty to publish on all available local interfaces.
address.NetworkInterface = String.Empty;
address.Url = urlAddress;
pubSubConnection1.Address = new ExtensionObject(address);
// Configure the mqtt specific configuration with the MQTTbroker
ITransportProtocolConfiguration mqttConfiguration = new MqttClientProtocolConfiguration(version: EnumMqttProtocolVersion.V500);
pubSubConnection1.ConnectionProperties = mqttConfiguration.ConnectionProperties;
string brokerQueueName = "Uadp_WriterGroup_1";
string brokerMetaData = "$Metadata";
#region Define WriterGroup1
WriterGroupDataType writerGroup1 = new WriterGroupDataType();
writerGroup1.Name = "WriterGroup 1";
writerGroup1.Enabled = true;
writerGroup1.WriterGroupId = 1;
writerGroup1.PublishingInterval = 5000;
writerGroup1.KeepAliveTime = 5000;
writerGroup1.MaxNetworkMessageSize = 1500;
writerGroup1.HeaderLayoutUri = "UADP-Cyclic-Fixed";
UadpWriterGroupMessageDataType uadpMessageSettings = new UadpWriterGroupMessageDataType()
{
DataSetOrdering = DataSetOrderingType.AscendingWriterId,
GroupVersion = 0,
NetworkMessageContentMask = (uint)(UadpNetworkMessageContentMask.PublisherId
| UadpNetworkMessageContentMask.GroupHeader
| UadpNetworkMessageContentMask.WriterGroupId
| UadpNetworkMessageContentMask.PayloadHeader
| UadpNetworkMessageContentMask.GroupVersion
| UadpNetworkMessageContentMask.NetworkMessageNumber
| UadpNetworkMessageContentMask.SequenceNumber)
};
writerGroup1.MessageSettings = new ExtensionObject(uadpMessageSettings);
// initialize Broker transport settings
writerGroup1.TransportSettings = new ExtensionObject(new BrokerWriterGroupTransportDataType()
{
QueueName = brokerQueueName,
});
// Define DataSetWriter 'Simple'
DataSetWriterDataType dataSetWriter1 = new DataSetWriterDataType();
dataSetWriter1.Name = "Writer 1";
dataSetWriter1.DataSetWriterId = 1;
dataSetWriter1.Enabled = true;
dataSetWriter1.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetWriter1.DataSetName = "Simple";
dataSetWriter1.KeyFrameCount = 1;
UadpDataSetWriterMessageDataType uadpDataSetWriterMessage = new UadpDataSetWriterMessageDataType()
{
ConfiguredSize = 32,
DataSetOffset = 15,
NetworkMessageNumber = 1,
DataSetMessageContentMask = (uint)(UadpDataSetMessageContentMask.Status | UadpDataSetMessageContentMask.SequenceNumber),
};
dataSetWriter1.MessageSettings = new ExtensionObject(uadpDataSetWriterMessage);
BrokerDataSetWriterTransportDataType uadpDataSetWriterTransport = new BrokerDataSetWriterTransportDataType()
{
QueueName = brokerQueueName,
MetaDataQueueName = $"{brokerQueueName}/{brokerMetaData}",
MetaDataUpdateTime = 60000
};
dataSetWriter1.TransportSettings = new ExtensionObject(uadpDataSetWriterTransport);
writerGroup1.DataSetWriters.Add(dataSetWriter1);
// Define DataSetWriter 'AllTypes'
DataSetWriterDataType dataSetWriter2 = new DataSetWriterDataType();
dataSetWriter2.Name = "Writer 2";
dataSetWriter2.DataSetWriterId = 2;
dataSetWriter2.Enabled = true;
dataSetWriter2.DataSetFieldContentMask = (uint)DataSetFieldContentMask.RawData;
dataSetWriter2.DataSetName = "AllTypes";
dataSetWriter2.KeyFrameCount = 1;
uadpDataSetWriterMessage = new UadpDataSetWriterMessageDataType()
{
ConfiguredSize = 32,
DataSetOffset = 47,
NetworkMessageNumber = 1,
DataSetMessageContentMask = (uint)(UadpDataSetMessageContentMask.Status | UadpDataSetMessageContentMask.SequenceNumber),
};
dataSetWriter2.MessageSettings = new ExtensionObject(uadpDataSetWriterMessage);
dataSetWriter2.TransportSettings = new ExtensionObject(uadpDataSetWriterTransport);
writerGroup1.DataSetWriters.Add(dataSetWriter2);
pubSubConnection1.WriterGroups.Add(writerGroup1);
#endregion
// Define PublishedDataSet Simple
PublishedDataSetDataType publishedDataSetSimple = CreatePublishedDataSetSimple();
// Define PublishedDataSet AllTypes
PublishedDataSetDataType publishedDataSetAllTypes = CreatePublishedDataSetAllTypes();
//create the PubSub configuration root object
PubSubConfigurationDataType pubSubConfiguration = new PubSubConfigurationDataType();
pubSubConfiguration.Connections = new PubSubConnectionDataTypeCollection()
{
pubSubConnection1
};
pubSubConfiguration.PublishedDataSets = new PublishedDataSetDataTypeCollection()
{
publishedDataSetSimple, publishedDataSetAllTypes
};
return(pubSubConfiguration);
}
