Lightstreamer - Portfolio Demo - .NET Adapter

The Portfolio Demo simulate a portfolio management: it shows a list of stocks included in a portfolio and provide a simple order entry form. Changes to portfolio contents, as a result of new orders, are displayed on the page in real-time. In addition to that, the Full Version of the Portfolio Demo also shows, for each stock in the portfolio, the current price, updated in real-time from a market data feed.

This project shows the .Net Data Adapter and Metadata Adapters for the Portfolio Demo and how they can be plugged into Lightstreamer Server. It also shows how to integrate the Lightstreamer - Stock-List Demo - .NET Adapter into the same Adapter Set to support the full version of the Portfolio Demo.

As an example of Clients Using This Adapter, you may refer to the Basic Portfolio Demo - HTML Client and view the corresponding Basic Portfolio Demo Live Demo, or you may refer to the Portfolio Demo - HTML Client and view the corresponding Portfolio Demo Live Demo for the full version of the Portfolio Demo.

Details

This project contains the source code and all the resources needed to build a .NET Core application running the Portfolio Data and Metadata Adapters.

.NET Interfaces

Lightstreamer Server exposes native Java Adapter interfaces. The .NET interfaces are added through the Lightstreamer Adapter Remoting Infrastructure (ARI).

The Architecture of Adapter Remoting Infrastructure for .NET.

You'll find more details about the SDK for .NET Standard Adapters at .NET Interfaces in the Lightstreamer - "Hello World" Tutorial - .NET Adapter project.

Dig the Code

This project includes the implementation of the IDataProvider interface and the IMetadataProvider interface for the Portfolio Demo.

The application is divided into 6 main classes.

• PortfolioDataAdapter.cs: this is a C#/.NET porting of the Lightstreamer - Portfolio Demo - Java Adapter. It inherits from the IDataProvider interface and calls back Lightstreamer through the IItemEventListener interface. Use it as a starting point to implement your custom data adapter in case of COMMAND mode subscription.
• PortfolioMetadataAdapter.cs: this is a C#/.NET porting of the Metadata Adapter in Lightstreamer - Portfolio Demo - Java Adapter. It inherits from the LiteralBasedProvider, a simple Metadata Adapter already included in the .NET Standard Adapter SDK binaries, which is enough for this demo. See also LiteralBasedProvider Metadata Adapter. In addition, it implements the NotifyUserMessage method, to handle sendMessage requests from the Portfolio Demo client. This allows the Portfolio Demo client to use sendMessage to submit buy/sell orders to the (simulated) portfolio feed used by the Portfolio Data Adapter.
• PortfolioFeed.cs: used to receive data from the simulated portfolio feed in an asynchronous way.
• NotificationQueue.cs: used to provide an executor of tasks in a single dedicated thread.
• StandaloneAdaptersLauncher.cs: this is a stand-alone executable that launches both the Data Adapter and the Metadata Adapter for the .NET Portfolio Demo example. It redirects sockets connections from Lightstreamer to the .NET Servers implemented in the SDK library.
• Log4NetLogging.cs: used by the stand-alone executable to forward the log produced by the LS .NET Standard SDK library to the application logging system, based on NLog.

Check out the sources for further explanations.

Install

Install the Basic Portfolio Demo

If you want to install a basic version of the .Net Portfolio Demo in your local Lightstreamer Server, follow the steps below.

• Download the latest Lightstreamer distribution (see the Compatibility Notes for more details about the correct version; Lightstreamer Server comes with a free non-expiring demo license for 20 connected users) from Lightstreamer Download page, and install it, as explained in the GETTING_STARTED.TXT file in the installation home directory.

• Get the deploy.zip file of the latest release and unzip it.

• Plug the Proxy Data Adapter and the Proxy MetaData Adapter into the Server: go to the Deployment_LS folder and copy the DotNetPortfolio directory and all of its files to the adapters folder of your Lightstreamer Server installation. Refer to the comments embedded in the provided adapters.xml file template, for further details on configuration options.

• Launch Lightstreamer Server. The Server startup will complete only after a successful connection between the Proxy Adapters and the Remote Adapters.

• Launch the Remote .NET Adapters. Run the PortfolioDemoLauncher.bat script under the Deployment_DotNet_Adapters directory. The script runs the PortfolioDemoLauncher which hosts both the Remote Data Adapter and the Remote Metadata Adapter for the .NET Portfolio Demo. In case of need, the application prints on the log a help page if run with the following syntax: "dotnet PortfolioDemoLauncher.dll /help". Please note that the .NET Remote Adapters connect to Proxy Adapters, not vice versa.

• Test the Adapter, launching the Basic Portfolio Demo - HTML Client, listed in Clients Using This Adapter.

  • To make the Basic Portfolio Demo - HTML Client front-end pages get data from the newly installed Adapter Set, you need to modify the front-end pages and set the required Adapter Set name to PORTFOLIODEMO_REMOTE when creating the LightstreamerClient instance. So edit the lsClient.js file of the Basic Portfolio Demo front-end deployed under Lightstreamer/pages/PortfolioDemo_Basic and replace:
    

  var lsClient = new LightstreamerClient(protocolToUse+"//localhost:"+portToUse,"PORTFOLIODEMO");
  

  with:
  

  var lsClient = new LightstreamerClient(protocolToUse+"//localhost:"+portToUse,"PORTFOLIODEMO_REMOTE");
  

  (you don't need to reconfigure the Data Adapter name, as it is the same in both Adapter Sets).

  • As the referred Adapter Set has changed, make sure that the front-end no longer shares the Engine with other demos. So a line like this:
    lsClient.connectionSharing.enableSharing("PortfolioDemoCommonConnection", "ATTACH", "CREATE");
    should become like this:
    lsClient.connectionSharing.enableSharing("RemotePortfolioConnection", "ATTACH", "CREATE");
  • Open a browser window and go to: http://localhost:8080/PortfolioDemo_Basic

Install the Portfolio Demo

To work with full functionality, the Portfolio Demo - HTML Client, needs both the PORTFOLIO_ADAPTER, from the Portfolio Demo, and the QUOTE_ADAPTER, from the Stock-List Demo (see Lightstreamer StockList Demo Adapter for .NET). If you want to install a full version of the Portfolio Demo in your local Lightstreamer Server, you have to deploy the PORTFOLIO_ADAPTER and the QUOTE_ADAPTER together in the same Adapter Set. To allow the two adapters to coexist within the same Adapter Set, please follow the steps below.

• Download the latest Lightstreamer distribution (see the Compatibility Notes for more details about the correct version; Lightstreamer Server comes with a free non-expiring demo license for 20 connected users) from Lightstreamer Download page, and install it, as explained in the GETTING_STARTED.TXT file in the installation home directory.
• Get the deploy.zip file of the latest release and unzip it.
• Plug the Proxy Data Adapter and the Proxy MetaData Adapter into the Server: go to the Full_Deployment_LS folder and copy the DotNetFullPortfolio directory and all of its files to the adapters folder of your Lightstreamer Server installation. Refer to the comments embedded in the provided adapters.xml file template, for further details on configuration options.
• Launch Lightstreamer Server. The Server startup will complete only after a successful connection between the Proxy Adapters and the Remote Adapters.
• Launch the Remote .NET Adapters. Run the PortfolioFullDemoLauncher.bat script under the Full_Deployment_DotNet_Adapters directory. The script runs two Data Adapters, one for the Portfolio Demo and one for the StockList, and a single Metadata Adapter.
• Test the Adapter, launching the Portfolio Demo - HTML Client, listed in Clients Using This Adapter.
  • To make the Portfolio Demo - HTML Client front-end pages get data from the newly installed Adapter Set, you need to modify the front-end pages and set the required Adapter Set name to PORTFOLIODEMO_REMOTE when creating the LightstreamerClient instance. So edit the lsClient.js file of the Portfolio Demo front-end deployed under Lightstreamer/pages/PortfolioDemo and replace:
    var lsClient = new LightstreamerClient(protocolToUse+"//localhost:"+portToUse,"FULLPORTFOLIODEMO");
    with:
    var lsClient = new LightstreamerClient(protocolToUse+"//localhost:"+portToUse,"FULLPORTFOLIODEMO_REMOTE");
    (you don't need to reconfigure the Data Adapter name, as it is the same in both Adapter Sets).
  • As the referred Adapter Set has changed, make sure that the front-end no longer shares the Engine with other demos. So a line like this:
    lsClient.connectionSharing.enableSharing("PortfolioDemoCommonConnection", "ATTACH", "CREATE");
    should become like this:
    lsClient.connectionSharing.enableSharing("RemotePortfolioConnection", "ATTACH", "CREATE");
  • Open a browser window and go to: http://localhost:8080/PortfolioDemo

Build

To build your own version of PortfolioDemoDotNetCore.dll, instead of using the one provided in the deploy.zip file from the Install section above, follow these steps:

• Download this project.
• Create a project (we used Microsoft's Visual Studio Community Edition) for ".NET Core library" template and name it "PortfolioDemoDotNetCore",
• Include in the project the sources src/src_adapters.
• Get the binaries files of the Lightstreamer .NET Standard Adapters Server library from NuGet Lightstreamer.DotNetStandard.Adapters, copy it into the lib directory and add it as a reference for the project; or more simply, use directly the "NuGet Package Manager" looking for 'Lightstreamer Adapters' and intalling the Lightstreamer.DotNetStandard.Adapters package.
• Get the binaries files of the NLog library from NuGet, copy it into the lib directory and add it as a reference for the project; or more simply, use directly the "NuGet Package Manager" looking for 'NLog' and intalling the NLog package.
• Build Solution

Build the Stand-Alone Launcher

To build your own version of the Stand-Alone Launcher, follow these steps:

• Create a project for ".NET Core App Console" template and name it "PortfolioDemoLauncher".
• Include in the project the sources src/src_standalone_launcher.
• Include references to the .NET Portfolio Demo Data Adapters binaries you have built in the previous step.
• Get the binaries files of the Lightstreamer .NET Standard Adapters Server library from NuGet Lightstreamer.DotNetStandard.Adapters, copy it into the lib directory and add it as a reference for the project; or more simply, use directly the "NuGet Package Manager" looking for 'Lightstreamer Adapters' and intalling the Lightstreamer.DotNetStandard.Adapters package.
• Get the binaries files of the NLog library from NuGet, copy it into the lib directory and add it as a reference for the project; or more simply, use directly the "NuGet Package Manager" looking for 'NLog' and intalling the NLog package.
• Make sure that the entry point of the executable is the AdaptersLauncher class.
• Build Solution

See Also

• Adapter Remoting Infrastructure Network Protocol Specification
• .NET Standard Adapter API Reference

Clients Using This Adapter

• Lightstreamer - Portfolio Demos - HTML Clients
• Lightstreamer - Portfolio Demo - Flex Client
• Lightstreamer - Portfolio Demo - Dojo Toolkit Client

Related Projects

• Lightstreamer - Portfolio Demo - Java Adapter
• Lightstreamer - StockList Demo - .NET Adapter

Lightstreamer Compatibility Notes

• Compatible with Lightstreamer SDK for .NET Standard Adapters version 1.15 or newer and Lightstreamer Server version 7.4 or newer.

• For a version of this example compatible with Lightstreamer Server version since 7.0, please refer to this tag.
• For instructions compatible with Lightstreamer SDK for .NET Adapters version 1.12 to 1.14, please refer to this tag.
• For instructions compatible with Lightstreamer SDK for .NET Adapters version 1.10, please refer to this tag.