Skip to content

Commit 46ff1a4

Browse files
committed
BlockingScheduler clarification
1 parent 6516389 commit 46ff1a4

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

src/main/java/io/reactivex/rxjava4/schedulers/BlockingScheduler.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,15 @@
1818
import io.reactivex.rxjava4.internal.functions.Functions;
1919
import io.reactivex.rxjava4.internal.schedulers.BlockingCurrentThreadScheduler;
2020

21+
/**
22+
* Holds onto a blocking scheduler instance and provides access to its {@link #execute()}
23+
* method and a way to obtain a pure {@link Scheduler} instance to be used as parameter.
24+
* @implNote No need to instantiate this record by client applications, it serves as a way to
25+
* give access to the {@code Scheduler} interface as well as the blocking-specific
26+
* {@link #execute()} methods.
27+
* @param bcts the scheduler instance
28+
* @since 4.0.0
29+
*/
2130
public record BlockingScheduler(BlockingCurrentThreadScheduler bcts) {
2231

2332
/**

0 commit comments

Comments
 (0)