EndpointUrl Property (EasyUAServerCore)

The URL of the server's primary endpoint.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<BrowsableAttribute(False)>
<CanBeNullAttribute()>
Public Property EndpointUrl As Uri

'Usage
 
Dim instance As EasyUAServerCore
Dim value As Uri
 
instance.EndpointUrl = value
 
value = instance.EndpointUrl

[Browsable(false)]
[CanBeNull()]
public Uri EndpointUrl {get; set;}

[Browsable(false)]
[CanBeNull()]
public:
property Uri^ EndpointUrl {
   Uri^ get();
   void set (    Uri^ value);
}

Property Value

The URL that represents the primary endpoint of the server.

This value of this property can be null (Nothing in Visual Basic).

Remarks

This property is null when EndpointUrlString cannot be parsed as a System.Uri. Setting this property to null has no effect.

This property allows the configuration of the server's primary endpoint URL. The URL is essential for clients to connect to the server. It should be set to a valid URI that clients can resolve and access.

This method or property does not throw any exceptions, aside from execution exceptions such as System.Threading.ThreadAbortException or System.OutOfMemoryException.

Example

CSharp

// This example shows how to set the primary endpoint of the server, using the Uri object.
// You can use any OPC UA client, including our Connectivity Explorer and OpcCmd utility, to connect to the server. 
//
// Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .
// OPC client, server and subscriber examples in C# on GitHub: https://github.com/OPCLabs/Examples-OPCStudio-CSharp .
// Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own
// a commercial license in order to use Online Forums, and we reply to every post.

using System;
using OpcLabs.EasyOpc.UA;
using OpcLabs.EasyOpc.UA.NodeSpace;

namespace UAServerDocExamples._EasyUAServer
{
    class EndpointUrl
    {
        public static void Main1()
        {
            // Instantiate the server object.
            // By default, the server will run on endpoint URL "opc.tcp://localhost:48040/".
            var server = new EasyUAServer();

            // Set the server endpoint URL, using the Uri object.
            server.EndpointUrl = new Uri("opc.tcp://localhost:38444/");

            // Hook event handler for the EndpointStateChanged event. It simply prints out the event.
            server.EndpointStateChanged += (sender, args) => Console.WriteLine(args);

            // Define a data variable providing random integers.
            var random = new Random();
            server.Add(new UADataVariable("MyDataVariable").ReadValueFunction(() => random.Next()));

            // Start the server.
            Console.WriteLine("The server is starting...");
            server.Start();

            Console.WriteLine("The server is started.");
            Console.WriteLine();

            // Let the user decide when to stop.
            Console.WriteLine("Press Enter to stop the server...");
            Console.ReadLine();

            // Stop the server.
            Console.WriteLine("The server is stopping...");
            server.Stop();

            Console.WriteLine("The server is stopped.");
        }
    }
}

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

EasyUAServerCore Class
EasyUAServerCore Members
EndpointUrlString Property

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.