ForeksPubsubSdk 1.0.6

ForeksPubsubSdk

This project is build to subcribe Foreks PubSub Server with .Net applications.

• **version 😗* 1.0.6
• **author 😗* ForeksCoreTeam

Dependencies

The packages listed below must be add to project with Nuget

• Newtonsoft.Json
• Microsoft.Net.Http

Quick Start

Simple explanations of the functions can be found in this section.

Deciding Options At first, options must be decided and an object instance of ConnectionOptions class must be created to connect Foreks Pubsub Server. Default constructor of this class takes destination ip, destination port, username and password. Some static functions are implemented to connect predefined destiontion ip and port

• ToDEV
• ToUAT
• ToPROD
• ToPRODSlave

ForeksPubsubSdk.ConnectionOptions connectionOptions = ForeksPubsubSdk.ConnectionOptions.ToPROD({{your_username}}, {{your_password}});

Reconnect parameter: When the connection is dropped, new connection is established automatically. Default is true;

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

ForeksPubsubSdk.PubsubClient foreksPubsubClient = new ForeksPubsubSdk.PubsubClient(connectionOptions);

Listening Events Then, PubsubClient events must be listened.

• OnLogin
• OnHeartbeat
• onData
• OnDisconnect
• OnError
• OnMessage
• OnNotification
• OnSymbolAdd
• OnSymbolRemove

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. 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.

foreksPubsubClient.OnLogin += PubsubClient_OnLogin;
foreksPubsubClient.OnHeartbeat += PubsubClient_OnHeartbeat;
foreksPubsubClient.OnData += PubsubClient_OnData;
foreksPubsubClient.OnDisconnect += PubsubClient_OnDisconnect;
foreksPubsubClient.OnError += PubsubClient_OnError;
foreksPubsubClient.OnMessage += PubsubClient_OnMessage;
foreksPubsubClient.OnNotification += PubsubClient_OnNotification;
foreksPubsubClient.OnSymbolAdd += PubsubClient_OnSymbolAdd;
foreksPubsubClient.OnSymbolRemove += PubsubClient_OnSymbolRemove;

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>() { ForeksPubsubSdk.Fields.Last, ForeksPubsubSdk.Fields.DateTime });

Unsubscription

foreksPubsubClient.Unsubscribe(new List<string>() { "H1846" }, new List<string>() { ForeksPubsubSdk.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();

EXAMPLE

using System;
using System.Collections.Generic;

namespace PubsubTest
{
    class MainClass
    {
        static void ForeksPubsubClient_OnNotification(object sender, ForeksPubsubSdk.ResponseArgs e)
        {
            Console.WriteLine("OnNotification: " + e.ToString());
        }

        static void ForeksPubsubClient_OnSymbolRemove(object sender, ForeksPubsubSdk.ResponseArgs e)
        {
            Console.WriteLine("OnSymbolAdd: " + e.ToString());
        }

        static void ForeksPubsubClient_OnSymbolAdd(object sender, ForeksPubsubSdk.ResponseArgs e)
        {
            Console.WriteLine("OnSymbolAdd: " + e.ToString());
        }

        static void ForeksPubsubClient_OnError(object sender, ForeksPubsubSdk.ResponseArgs e)
        {
            Console.WriteLine("OnError: " + e.ToString());
        }

        static void ForeksPubsubClient_OnDisconnect(object sender, ForeksPubsubSdk.ResponseArgs e)
        {
            Console.WriteLine("OnDisconnect: " + e.ToString());
        }

        static void ForeksPubsubClient_OnHeartbeat(object sender, ForeksPubsubSdk.ResponseArgs e)
        {
            Console.WriteLine("OnHeartbeat: " + e.ToString());
        }

        static void ForeksPubsubClient_OnLogin(object sender, ForeksPubsubSdk.ResponseArgs e)
        {
            Console.WriteLine("OnLogin: " + e.ToString());
        }

        static void ForeksPubsubClient_OnMessage(object sender, ForeksPubsubSdk.ResponseArgs e)
        {
            Console.WriteLine("OnMessage: " + e.ToString());
        }

        static void ForeksPubsubClient_OnData(object sender, ForeksPubsubSdk.ResponseArgs e)
        {
            Console.WriteLine("OnData: " + e.ToString());
        }

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

                ForeksPubsubSdk.PubsubClient foreksPubsubClient = new ForeksPubsubSdk.PubsubClient(connectionOptions);

                foreksPubsubClient.OnLogin += ForeksPubsubClient_OnLogin;
                foreksPubsubClient.OnHeartbeat += ForeksPubsubClient_OnHeartbeat;
                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>() { ForeksPubsubSdk.Fields.Last, ForeksPubsubSdk.Fields.DateTime });

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

            while (true) { }
        }
    }
}