Table of Contents

Class SubscriptionHolder<TSubscription, TSession>

Namespace
StockSharp.Messages
Assembly
StockSharp.Messages.dll

Subscription holder.

public class SubscriptionHolder<TSubscription, TSession> : Disposable, IDisposable where TSubscription : class, ISecurityIdMessage, IDataTypeMessage, ISubscription<TSession> where TSession : class

Type Parameters

TSubscription

Subscription type.

TSession

Session type.

Inheritance
SubscriptionHolder<TSubscription, TSession>
Implements
Inherited Members
Extension Methods

Remarks

Initializes a new instance of the SubscriptionHolder<TSubscription, TSession>.

Constructors

SubscriptionHolder(ILogReceiver)

Subscription holder.

public SubscriptionHolder(ILogReceiver logs)

Parameters

logs ILogReceiver

Logs.

Remarks

Initializes a new instance of the SubscriptionHolder<TSubscription, TSession>.

Properties

MaxTrackedItems

Maximum number of tracked helper entries.

public int MaxTrackedItems { get; set; }

Property Value

int

Methods

Add(TSubscription)

Add new subscription.

public void Add(TSubscription info)

Parameters

info TSubscription

Subscription.

AddUnsubscribeRequest(long, long)

Add unsubscribe request identifier.

public void AddUnsubscribeRequest(long transactionId, long originalTransactionId)

Parameters

transactionId long

Request identifier.

originalTransactionId long

ID of the original message TransactionId for which this message is a response.

Clear()

Clear state.

public void Clear()

DisposeManaged()

Disposes the managed resources. Override this method to add custom clean up of managed resources.

protected override void DisposeManaged()

GetSubscriptions(Message)

Get subscription for the specified message.

public IEnumerable<TSubscription> GetSubscriptions(Message message)

Parameters

message Message

Message.

Returns

IEnumerable<TSubscription>

Subscriptions.

GetSubscriptions(TSession)

Get subscriptions for the specified session.

public IEnumerable<TSubscription> GetSubscriptions(TSession session)

Parameters

session TSession

Session.

Returns

IEnumerable<TSubscription>

Subscriptions.

HasSubscriptions(DataType, SecurityId)

Determines whether any subscription exists for the specified data type and security.

public bool HasSubscriptions(DataType dataType, SecurityId securityId)

Parameters

dataType DataType

Data type info.

securityId SecurityId

Security ID.

Returns

bool

true if any subscription exists; otherwise, false.

Remove(TSubscription)

Remove subscription.

public void Remove(TSubscription info)

Parameters

info TSubscription

Subscription.

Remove(TSession)

Remove all subscriptions for the specified session.

public IEnumerable<TSubscription> Remove(TSession session)

Parameters

session TSession

Session.

Returns

IEnumerable<TSubscription>

Subscriptions.

TryGetById(long, out TSubscription)

Try to get a subscription by the specified identifier.

public bool TryGetById(long id, out TSubscription info)

Parameters

id long

Identifier.

info TSubscription

The found subscription, if any.

Returns

bool

true if a subscription with the specified identifier exists; otherwise, false.

TryGetSubscription(long, SubscriptionStates?, out TSubscription)

Try to get the subscription by the specified identifier and switch to a new state if specified.

public bool TryGetSubscription(long id, SubscriptionStates? state, out TSubscription info)

Parameters

id long

Identifier.

state SubscriptionStates?

The state to set for the subscription, or null to leave unchanged.

info TSubscription

The found subscription, if any.

Returns

bool

true if the subscription was found; otherwise, false.

TryGetSubscriptionAndStop(long, out TSubscription)

Try to get the subscription by the specified identifier and set its state to Stopped.

public bool TryGetSubscriptionAndStop(long id, out TSubscription info)

Parameters

id long

Identifier.

info TSubscription

The found subscription, if any.

Returns

bool

true if the subscription was found; otherwise, false.

Events

SubscriptionChanged

Subscription changed event.

public event Action<TSubscription> SubscriptionChanged

Event Type

Action<TSubscription>