Method GetOrdersUpdateAsync

Namespace

WhalesSecret.TradeScriptLib.API.TradingV1

Assembly

WhalesSecret.TradeScriptLib.dll

GetOrdersUpdateAsync(CancellationToken)

Starts receiving orders' updates and returns a series of orders' updates received since the creation of the iterator. If no update is available, the method waits until the next update is received.

IAsyncEnumerable<IOrdersUpdate> GetOrdersUpdateAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token that allows the caller to cancel the operation.

Returns

IAsyncEnumerable<IOrdersUpdate>

Asynchronous iterator over order updates.

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.

OperationFailedException

Thrown if the request failed for an unknown reason with an unknown outcome.