Class Connection

Represents information about connection and provides an access to the current trading information(Symbols, Orders, Position, Accounts etc.).

Namespace: TradingPlatform.BusinessLayer

Syntax

public sealed class Connection : object, ICustomizable, IComparable

Properties

BusinessObjects

Provides access to all business objects which are belong to this connection

Declaration

public IBusinessObjectsProvider BusinessObjects { get; }

Property Value

Type	Description
TradingPlatform.BusinessLayer.IBusinessObjectsProvider

ConnectingProgress

Declaration

public string ConnectingProgress { get; }

Property Value

Type	Description
System.String

HistoryMetaData

Gets a matched available metadata info with the vendor's side

Declaration

public HistoryMetadata HistoryMetaData { get; }

Property Value

Type	Description
TradingPlatform.BusinessLayer.Integration.HistoryMetadata

Id

Gets connection Id

Declaration

public string Id { get; }

Property Value

Type	Description
System.String

Info

Declaration

public ConnectionInfo Info { get; }

Property Value

Type	Description
ConnectionInfo

LastConnectionResult

Declaration

public ConnectionResult LastConnectionResult { get; }

Property Value

Type	Description
TradingPlatform.BusinessLayer.Integration.ConnectionResult

MessagesQueueDepth

Messages count that one is waited to process

Declaration

public int MessagesQueueDepth { get; }

Property Value

Type	Description
System.Int32

Name

Gets connection Name

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

NewsFeedSettings

Declaration

public IEnumerable<SettingItem> NewsFeedSettings { get; }

Property Value

Type	Description
IEnumerable<TradingPlatform.BusinessLayer.SettingItem>

PingTime

Represents connection ping time

Declaration

public TimeSpan? PingTime { get; }

Property Value

Type	Description
System.Nullable<TimeSpan>

RoundTripTime

Declaration

public TimeSpan? RoundTripTime { get; }

Property Value

Type	Description
System.Nullable<TimeSpan>

Settings

Contains list of connection settings. Will be reused on each population time.

Declaration

public IList<SettingItem> Settings { get; set; }

Property Value

Type	Description
IList<TradingPlatform.BusinessLayer.SettingItem>

State

Gets connection's state (Connected/Connecting/Fail etc.)

Declaration

public ConnectionState State { get; }

Property Value

Type	Description
TradingPlatform.BusinessLayer.ConnectionState

TotalSubscriptionsCount

Declaration

public int TotalSubscriptionsCount { get; }

Property Value

Type	Description
System.Int32

Type

Defines connection type

Declaration

public ConnectionType Type { get; set; }

Property Value

Type	Description
TradingPlatform.BusinessLayer.ConnectionType

Uptime

Declaration

public TimeSpan Uptime { get; }

Property Value

Type	Description
TimeSpan

VendorName

Gets connection's vendor name

Declaration

public string VendorName { get; }

Property Value

Type	Description
System.String

VolumeAnalysisMetadata

Declaration

public VolumeAnalysisMetadata VolumeAnalysisMetadata { get; }

Property Value

Type	Description
TradingPlatform.BusinessLayer.Integration.VolumeAnalysisMetadata

Methods

CompareTo(Object)

Declaration

public int CompareTo(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Int32

Connect()

Establishes a connection to a specified vendor

Declaration

public ConnectionResult Connect()

Returns

Type	Description
TradingPlatform.BusinessLayer.Integration.ConnectionResult

Disconnect()

Closes a connection.

Declaration

public void Disconnect()

GetNews(GetNewsRequestParameters)

Declaration

public IEnumerable<NewsArticle> GetNews(GetNewsRequestParameters requestParameters)

Parameters

Type	Name	Description
TradingPlatform.BusinessLayer.GetNewsRequestParameters	requestParameters

Returns

Type	Description
IEnumerable<TradingPlatform.BusinessLayer.NewsArticle>

GetNewsArticleContent(GetNewsArticleContentRequestParameters)

Declaration

public string GetNewsArticleContent(GetNewsArticleContentRequestParameters requestParameters)

Parameters

Type	Name	Description
TradingPlatform.BusinessLayer.GetNewsArticleContentRequestParameters	requestParameters

Returns

Type	Description
System.String

GetOrdersHistory(OrdersHistoryRequestParameters)

Declaration

public IList<OrderHistory> GetOrdersHistory(OrdersHistoryRequestParameters parameters)

Parameters

Type	Name	Description
OrdersHistoryRequestParameters	parameters

Returns

Type	Description
IList<TradingPlatform.BusinessLayer.OrderHistory>

GetTrades(TradesHistoryRequestParameters)

Declaration

public IList<Trade> GetTrades(TradesHistoryRequestParameters parameters)

Parameters

Type	Name	Description
TradesHistoryRequestParameters	parameters

Returns

Type	Description
IList<Trade>

SendCustomRequest(RequestParameters)

Declaration

public void SendCustomRequest(RequestParameters parameters)

Parameters

Type	Name	Description
RequestParameters	parameters

SubscribeNewsUpdates(SubscribeNewsRequestParameters, Action<NewsArticle>)

Declaration

public void SubscribeNewsUpdates(SubscribeNewsRequestParameters subscribeNewsRequestParameters, Action<NewsArticle> updateAction)

Parameters

Type	Name	Description
TradingPlatform.BusinessLayer.SubscribeNewsRequestParameters	subscribeNewsRequestParameters
Action<TradingPlatform.BusinessLayer.NewsArticle>	updateAction

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

UnsubscribeNewsUpdates(SubscribeNewsRequestParameters, Action<NewsArticle>)

Declaration

public void UnsubscribeNewsUpdates(SubscribeNewsRequestParameters subscribeNewsRequestParameters, Action<NewsArticle> updateAction)

Parameters

Type	Name	Description
TradingPlatform.BusinessLayer.SubscribeNewsRequestParameters	subscribeNewsRequestParameters
Action<TradingPlatform.BusinessLayer.NewsArticle>	updateAction

Events

ConnectingProgressChanged

Will be triggered when ConnectingProgress changed.

Declaration

public event EventHandler<ConnectionConnectingProgressChangedEventArgs> ConnectingProgressChanged

Event Type

Type	Description
EventHandler<TradingPlatform.BusinessLayer.ConnectionConnectingProgressChangedEventArgs>

NewPerformedRequest

Declaration

public event EventHandler<PerformedRequestEventArgs> NewPerformedRequest

Event Type

Type	Description
EventHandler<TradingPlatform.BusinessLayer.Utils.PerformedRequestEventArgs>

StateChanged

Will be triggered when State changed.

Declaration

public event EventHandler<ConnectionStateChangedEventArgs> StateChanged

Event Type

Type	Description
EventHandler<TradingPlatform.BusinessLayer.ConnectionStateChangedEventArgs>

Implements

IComparable