ForeksPubsubSdk 2.0.1

.NET Standard 2.0
dotnet add package ForeksPubsubSdk --version 2.0.1
NuGet\Install-Package ForeksPubsubSdk -Version 2.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ForeksPubsubSdk" Version="2.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ForeksPubsubSdk --version 2.0.1
#r "nuget: ForeksPubsubSdk, 2.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install ForeksPubsubSdk as a Cake Addin
#addin nuget:?package=ForeksPubsubSdk&version=2.0.1

// Install ForeksPubsubSdk as a Cake Tool
#tool nuget:?package=ForeksPubsubSdk&version=2.0.1

Quick Start

Simple explanations of the functions can be found in this section. For more info click here

Deciding Options Options must be decided and an object instance of ConnectionOptions class must be created to connect Foreks Pubsub Server. Help for username and password click www.foreks.com.

Some static functions are implemented to connect predefined destiontion ip and port

  • ToDEV
  • ToUAT
  • ToPROD
  • ToPRODSlave
ConnectionOptions connectionOptions = new ConnectionOptions({{hostname}},{{port}},{{username}},{{password}},{{applicationName}});
//or
ConnectionOptions connectionOptions = ConnectionOptions.ToPROD({{your_username}}, {{your_password}},{{applicationName}});

Reconnect parameter: When the connection is dropped, new connection is established automatically. Default is true; On state of unauthorized user and login on another device, reconnection is not start.

Creating Client An object instance of PubsubClient must be created. Object takes an object instance of connectionOptions class.

PubsubClient foreksPubsubClient = new PubsubClient(connectionOptions);

Listening Events PubsubClient events must be listened.

  • OnLogin: When the response of a login request is received this event will be triggered despite the fact that the login is succeeded.
  • OnHeartbeat: When the server sends heartbeat message, this event will be triggered. Server heartbeat messages periodically. Client heartbeat messages are send in the background.
  • OnPong: When the client's ping function is triggered with a payload (for example timestamp), this payload sends to server and received back with this handler.
  • OnData: When the subscribed field is changed, server sends new data and this event will be triggered.
  • OnDisconnect: When the connection is dropped, this event will be triggered.
  • OnError: When the server sends Error or Unknown message, this event will be triggered.
  • OnMessage: When the server sends global message, this event will be triggered. Not in use yet.
  • OnNotification: When the server sends notification, this event will be triggered.
  • OnSymbolAdd: When a symbol is added to definition, such as hot insert in BIST, this event will be triggered. Definition of the symbol will be sent.
  • OnSymbolRemove: When a symbol is removed from definition, this event will be triggered. Definition of the symbol will be sent.

OnLogin If the ResponseArgs.Success is false, the status of the user must be determined via the ResponseArgs.Code. Along with unsuccessful OnLogin method, OnDisconnect method is called also.

*ConnectionStatus.Drop.SERVER_LOGOUT : login on another device *ConnectionStatus.Drop.LOGIN_REJECT : unauthorized *ConnectionStatus.Drop.SERVER_EXCEPTION : server exception

Subscription Subscribe method of an object which is an instance of PubsubClient takes to List<string> as an input parameters. First one holds the id's of the symbols which can be found in https://feed-definition.foreks.com/symbol/search Second one holds the shortCode's of the fields which are predefined in Fields class.

foreksPubsubClient.Subscribe(new List<string>() { "H1846", "H14678" }, new List<string>() { Fields.Last, Fields.DateTime });

You can use 'ForeksDefinitions' helper method instead of id's.

Unsubscription

Unsubscribe(symbols,fields) Unsubscribe(symbols) UnsubscribeAll()

foreksPubsubClient.Unsubscribe(new List<string>() { "H1846" }, new List<string>() { Fields.Last });

Listening Data With start function, new TCP connection is created and login request is send. If the login request is succeeded, subscriptions which were set before start function are called automatically. With every incoming data related event is triggered.

foreksPubsubClient.Start();
//or
foreksPubsubClient.StartWithoutBlocking();

Stopping Data With stop function, unsubscribeAll method is triggered and existed TCP connection is closed.

foreksPubsubClient.Stop();

EXAMPLE

using System;
using System.Collections.Generic;
using ForeksPubsubSdk;

namespace PubsubTest
{
    class MainClass
    {
        static void ForeksPubsubClient_OnNotification(object sender, ResponseArgs e){}

        static void ForeksPubsubClient_OnSymbolRemove(object sender, ResponseArgs e){}

        static void ForeksPubsubClient_OnSymbolAdd(object sender, ResponseArgs e){}

        static void ForeksPubsubClient_OnError(object sender, ResponseArgs e){}

        static void ForeksPubsubClient_OnDisconnect(object sender, ResponseArgs e){}

        static void ForeksPubsubClient_OnHeartbeat(object sender, ResponseArgs e){}

        static void ForeksPubsubClient_OnPong(object sender, ResponseArgs e)
        {
            long now = (long)(DateTime.UtcNow - new DateTime(1970, 1, 1)).TotalMilliseconds;
            long sent = long.Parse(e.Result.ToString());
 
            long cycle = now - sent;
            Console.WriteLine("OnPong: a cycle takes " + cycle + " miliseconds");
        }

        static void ForeksPubsubClient_OnLogin(object sender, ResponseArgs e)
        {
            if (e.Success)
            {
                foreksPubsubClient.Ping(((long)(DateTime.UtcNow - new DateTime(1970, 1, 1)).TotalMilliseconds).ToString());
            }
        }

        static void ForeksPubsubClient_OnMessage(object sender, ResponseArgs e){}

        static void ForeksPubsubClient_OnData(object sender, ResponseArgs e){}

        static void Main(string[] args)
        {
            try
            {
                ConnectionOptions connectionOptions = ConnectionOptions.ToPROD({{your_username}}, {{your_password}}, {{your_applicationName}});

                PubsubClient foreksPubsubClient = new PubsubClient(connectionOptions);

                foreksPubsubClient.OnLogin += ForeksPubsubClient_OnLogin;
                foreksPubsubClient.OnHeartbeat += ForeksPubsubClient_OnHeartbeat;
                foreksPubsubClient.OnPong += ForeksPubsubClient_OnPong;
                foreksPubsubClient.OnData += ForeksPubsubClient_OnData;
                foreksPubsubClient.OnDisconnect += ForeksPubsubClient_OnDisconnect;
                foreksPubsubClient.OnError += ForeksPubsubClient_OnError;
                foreksPubsubClient.OnMessage += ForeksPubsubClient_OnMessage;
                foreksPubsubClient.OnNotification += ForeksPubsubClient_OnNotification;
                foreksPubsubClient.OnSymbolAdd += ForeksPubsubClient_OnSymbolAdd;
                foreksPubsubClient.OnSymbolRemove += ForeksPubsubClient_OnSymbolRemove;

                foreksPubsubClient.Subscribe(new List<string>() { "H1846", "H14678" }, new List<string>() { Fields.Last, Fields.DateTime });

                //ForeksDefinitions helper method for finding ids
                //ForeksDefinitions foreksDefinitions = new ForeksDefinitions(connectionOptions);
                //foreksPubsubClient.Subscribe(foreksDefinitions.GetSubscriptionList("code=EURUSD&code=GARAN"), new List<string>() { Fields.Last, Fields.DateTime });

                foreksPubsubClient.Start();
            }
            catch (Exception exception)
            {
                Console.WriteLine(exception.Message);
            }

            while (true) { }
        }
    }
}
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.1 371 9/24/2021
2.0.0 315 9/22/2021
1.0.27 544 7/20/2020
1.0.26 462 4/24/2020
1.0.25 507 3/18/2020
1.0.24 461 3/12/2020
1.0.23 519 1/29/2020
1.0.22 550 10/11/2019
1.0.21 537 8/22/2019
1.0.20 602 6/18/2019
1.0.19 654 5/24/2019
1.0.18 610 5/23/2019
1.0.17 798 1/4/2019
1.0.16 712 12/19/2018
1.0.15 770 12/10/2018
1.0.14 749 12/7/2018
1.0.13 782 12/5/2018
1.0.12 736 12/5/2018
1.0.11 724 11/26/2018
1.0.10 735 11/26/2018
1.0.9 731 11/22/2018
1.0.8 782 10/19/2018
1.0.7 765 10/16/2018
1.0.6 871 8/8/2018
1.0.5 842 8/3/2018
1.0.4 962 8/3/2018
1.0.3 852 8/3/2018
1.0.2 834 8/2/2018
1.0.1 853 8/2/2018
1.0.0 835 8/2/2018

upgrade to Standart 2.0