Application Server Configuration

Remoting SDK for .NET provides a server configuration infrastructure that makes it easy to manage server application's network connectivity parameters.

This feature allows to set up the server connectivity parameters using external configuration file, so there is no need anymore to rebuild the server application to change the Server Channel port, its type (i.e. protocol), disable or enable ZeroConf support etc.

And of course the configured components can still be accessed via code and customized, if needed.

Network connectivity components and options that can be configured include server channel, one or more server messages, session manager, event sink, event queue manager, TLS, and ZeroConf support component.

ApplicationServer class now exposes a property named NetworkServerConfiguration of type RemObjects.SDK.Server.INetworkServerConfiguration. It is up to the developer to load configuration from any external source (SQLite database, JSON file, some cloud service etc) and to instantiate own implementation of this interface. Remoting SDK provides a default implementation of this interface that can be used as a starting point.

server.NetworkServer.ServerChannel = new IpHttpServerCahnnel();
server.NetworkServerConfiguration = ...custom config implementation...

Of course the same configuration changes can be done via directly setting server.NetworkServer properties. The purpose of this feature is to provide a way to load configuration from external sources. For example, one could load JSON file from a cloud storage, deserialize it into an instance of NetworkServerConfiguration class and then use that instance as a configuration settings source.

Sample Code

In this sample a server app is configured to serve JSON message on port 8100.

This sample code below uses C# however the code is very simple and should be obvious for any other language.

static class Program
{
    public static int Main(string[] args)
    {
        ApplicationServer server = new ApplicationServer("SampleServer");

        var configuration = new NetworkServerConfiguration();
        configuration.ServerMessages.Clear();
        configuration.ServerMessages.Add(new ServerMessageConfiguration(ServerMessageType.JSON, 0, true, SoapMode.DocumentLiteral));
        configuration.ServerChannel.Port = 8100;

        server.NetworkServerConfiguration = configuration;

        server.Run(args);
        return 0;
    }
}

Available Options

The INetworkServerConfiguration interface exposes following properties:

All settings providers are described in more details below.

ServerChannel

Provides settings needed to configure the server communication channel. Note that some of the options that can be defined in this section are not applicable to some of the available channel types. In case such option is provided it will be ignored, no exception will be raised at run-time.

Security

Provides settings needed to configure the optional TLS protection of the server's Server Channel.

Note: When both CertificateFileName and CertificateThumbprint are set, the certificate will be loaded from the CertificateFileName file.

ServerMessages

Provides server message settings.

SessionManager

Provides settings needed to configure the Session Manager used by the server application.

ApiDispatcher

Provides HttpAPI Dispatcher settings.

Please note that this Dispatcher can be enabled only on Http-based channels.

JavaScriptDispatcher

Provides JavaScript Dispatcher settings.

Please note that JavaScript Dispatcher can be enabled only on Http-based channels.

Summary

The Server Configuration provides an easy way to manage server application's network connectivity parameters via external configuration source and to change them if needed without rebuilding the server application itself.

See Also

• NetworkServer