,System.TimeSpan)} ,System.TimeSpan,System.TimeProvider)} ,System.TimeSpan,ReactiveUI.Extensions.Async.IObservableAsync{--0})} ,System.TimeSpan,ReactiveUI.Extensions.Async.IObservableAsync{--0},System.TimeProvider)}
ObservableAsync.Timeout(IObservableAsync, TimeSpan) method¶
Defined in
Type: ObservableAsync
Namespace: ReactiveUI.Extensions.Async
Assembly: ReactiveUI.Extensions.dll
Applies to
net10.0, net10.0-browserwasm1.0, net10.0-desktop1.0, net9.0, net9.0-browserwasm1.0, net9.0-desktop1.0, net8.0, net8.0-ios17.5, net8.0-maccatalyst17.5, net8.0-macos14.2, net8.0-macos14.5, net8.0-tvos17.2, netstandard2.1, net462, net481
Overloads¶
- 1.
public static IObservableAsync<T> Timeout<T>(this IObservableAsync<T> @this, TimeSpan dueTime) - 2.
public static IObservableAsync<T> Timeout<T>(this IObservableAsync<T> @this, TimeSpan dueTime, TimeProvider? timeProvider) - 3.
public static IObservableAsync<T> Timeout<T>(this IObservableAsync<T> @this, TimeSpan dueTime, IObservableAsync<T> fallback) - 4.
public static IObservableAsync<T> Timeout<T>(this IObservableAsync<T> @this, TimeSpan dueTime, IObservableAsync<T> fallback, TimeProvider? timeProvider)
1. Overload¶
public static IObservableAsync<T> Timeout<T>(this IObservableAsync<T> @this, TimeSpan dueTime)
Summary: Applies a dueTime policy to the observable sequence. If the next element is not received within the specified time span, the sequence completes with a TimeoutException.
Type parameters
| Name | Description |
|---|---|
T | The type of elements in the sequence. |
Parameters
| Name | Type | Description |
|---|---|---|
this | [IObservableAsync | The source observable sequence. |
dueTime | TimeSpan | The maximum time span allowed between consecutive elements. Must be positive. |
Returns: IObservableAsync
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | Thrown if dueTime is negative or zero. |
2. Overload¶
public static IObservableAsync<T> Timeout<T>(this IObservableAsync<T> @this, TimeSpan dueTime, TimeProvider? timeProvider)
Summary: Applies a dueTime policy to the observable sequence. If the next element is not received within the specified time span, the sequence completes with a TimeoutException.
Type parameters
| Name | Description |
|---|---|
T | The type of elements in the sequence. |
Parameters
| Name | Type | Description |
|---|---|---|
this | [IObservableAsync | The source observable sequence. |
dueTime | TimeSpan | The maximum time span allowed between consecutive elements. Must be positive. |
timeProvider | TimeProvider? | An optional time provider for controlling timing. If null, System is used. |
Returns: IObservableAsync
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | Thrown if dueTime is negative or zero. |
3. Overload¶
public static IObservableAsync<T> Timeout<T>(this IObservableAsync<T> @this, TimeSpan dueTime, IObservableAsync<T> fallback)
Summary: Applies a dueTime policy to the observable sequence. If the next element is not received within the specified time span, the sequence switches to the specified fallback observable.
Type parameters
| Name | Description |
|---|---|
T | The type of elements in the sequence. |
Parameters
| Name | Type | Description |
|---|---|---|
this | [IObservableAsync | The source observable sequence. |
dueTime | TimeSpan | The maximum time span allowed between consecutive elements. Must be positive. |
fallback | [IObservableAsync | The fallback observable to switch to when a dueTime occurs. Cannot be null. |
Returns: IObservableAsync
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | Thrown if dueTime is negative or zero. |
| System.ArgumentNullException | Thrown if fallback is null. |
4. Overload¶
public static IObservableAsync<T> Timeout<T>(this IObservableAsync<T> @this, TimeSpan dueTime, IObservableAsync<T> fallback, TimeProvider? timeProvider)
Summary: Applies a dueTime policy to the observable sequence. If the next element is not received within the specified time span, the sequence switches to the specified fallback observable.
Type parameters
| Name | Description |
|---|---|
T | The type of elements in the sequence. |
Parameters
| Name | Type | Description |
|---|---|---|
this | [IObservableAsync | The source observable sequence. |
dueTime | TimeSpan | The maximum time span allowed between consecutive elements. Must be positive. |
fallback | [IObservableAsync | The fallback observable to switch to when a dueTime occurs. Cannot be null. |
timeProvider | TimeProvider? | An optional time provider for controlling timing. If null, System is used. |
Returns: IObservableAsync
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | Thrown if dueTime is negative or zero. |
| System.ArgumentNullException | Thrown if fallback is null. |