Method GetNewerTickerAsync

Namespace: WhalesSecret.TradeScriptLib.API.TradingV1.MarketData

Assembly: WhalesSecret.TradeScriptLib.dll

GetNewerTickerAsync(SymbolPair, CancellationToken)

Gets a newer ticker than the last one previously returned by this method or by GetLatestTicker(SymbolPair) from the subscription specified by the given symbol pair. If no such ticker is available, the method waits until a new ticker update arrives.

Task<Ticker> GetNewerTickerAsync(SymbolPair symbolPair, CancellationToken cancellationToken = default)

Parameters

symbolPair SymbolPair: Symbol pair of the subscription whose ticker to get.
cancellationToken CancellationToken: Cancellation token that allows the caller to cancel the operation.

Returns

Task<Ticker>: Up-to-date ticker.

Remarks

This method is useful, for example, if one wants to get a ticker every N seconds.

The method is not suitable to give you all ticker updates.

Exceptions

InvalidArgumentException: Thrown if the set does not contain a subscription for the given symbol pair.
InvalidStateException: Thrown if the method is called while batch monitoring operation is active.
OperationCanceledException: Thrown if the operation was cancelled, including cancellation during the shutdown.
NotFoundException: Thrown if the method is called after the ticker subscription was disposed.
OperationCanceledException: Thrown if the operation was cancelled, including cancellation during the shutdown.
NotFoundException: Thrown if the method is called after the ticker subscription was disposed.
NotConnectedTimeoutException: Thrown if the connection strategy associated with this instance is BlockUntilReconnectedOrTimeout with non-infinite timeout value and this timeout expired while the connection to the exchange is interrupted. That is, this exception does not limit the request itself, it rather limits the period of time that allows the client to recover from the interruption of the connection to the exchange.
NotConnectedException: Thrown if the connection strategy is FailInstantlyIfNotConnected and the connection to the exchange is interrupted.