Method WaitNextCandlestickUpdateAsync

Namespace

WhalesSecret.TradeScriptLib.API.TradingV1.MarketData

Assembly

WhalesSecret.TradeScriptLib.dll

WaitNextCandlestickUpdateAsync(CandleWidth, CancellationToken)

Waits for a candlestick update newer than the last consumed candlestick update for the given candle width and the exchange symbol pair of this subscription.

Task<CandleUpdate> WaitNextCandlestickUpdateAsync(CandleWidth candleWidth, CancellationToken cancellationToken = default)

Parameters

candleWidth CandleWidth

Width of the candle to retrieve.

cancellationToken CancellationToken

Cancellation token that allows the caller to cancel the operation.

Returns

Task<CandleUpdate>

Returns a candlestick update newer than the last consumed candlestick update.

Exceptions

OperationCanceledException

Thrown if the operation was cancelled, including cancellation during the shutdown.

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.

NotFoundException

Thrown if the method is called after the candlestick subscription was disposed.