Operator: throttleWithTimeout

[benjchristensen]

Another take on throttle … I believe this matches Rx.Net behavior.

This will wait until timeout value has passed without any further values before emitting the received value.

[benjchristensen]

This example will throttle by waiting until timeout value has passed without any other onNext calls before emitting. If anything else is emitted it will throw away the previous value and restart the timer.

This will not emit anything if events keep firing shorter than the timeout.

        PublishSubject<Integer> o = PublishSubject.create();
        o.throttleWithTimeout(500, TimeUnit.MILLISECONDS, s).subscribe(observer);

        // send events with simulated time increments
        s.advanceTimeTo(0, TimeUnit.MILLISECONDS);
        o.onNext(1); // skip
        o.onNext(2); // deliver
        s.advanceTimeTo(501, TimeUnit.MILLISECONDS);
        o.onNext(3); // skip
        s.advanceTimeTo(600, TimeUnit.MILLISECONDS);
        o.onNext(4); // skip
        s.advanceTimeTo(700, TimeUnit.MILLISECONDS);
        o.onNext(5); // skip
        o.onNext(6); // deliver at 1300 after 500ms has passed since onNext(5)
        s.advanceTimeTo(1300, TimeUnit.MILLISECONDS);
        o.onNext(7); // deliver
        s.advanceTimeTo(1800, TimeUnit.MILLISECONDS);
        o.onCompleted();

Compare with #365

[benjchristensen]

Please review this behavior and let me know if it is accurate and if the name is explanatory.

[cloudbees-pull-request-builder]

RxJava-pull-requests #259 SUCCESS
This pull request looks good

[samuelgruetter]

throttleLast and throttleWithTimeout both have the same javadoc, that's confusing...

[samuelgruetter]

that was fast :D

[benjchristensen]

Javadoc:

Throttles by dropping all values that are followed by newer values before the timeout value expires. The timer reset on each onNext call.
NOTE: If the timeout is set higher than the rate of traffic then this will drop all data.

[benjchristensen]

I have submitted 3 separate pull requests with different variants of throttle. I would appreciate feedback on them:

• is the name and javadoc descriptive?
• does the throttling strategy make sense?

Variants are:

• throttleWithTimeout: Operator: throttleWithTimeout #366
• throttleLast: Operation throttleLast #365
• throttleFirst: Operator: throttleFirst #367

[samuelgruetter]

• throttleWithTimeout: the really interesting one, not easily implemented using other operators, corresponds to the C# version
• throttleLast: easily obtained combining window, flatMap, and takeLast
• throttleFirst: easily obtained combining window, flatMap, and takeFirst

Is this correct?

[benjchristensen]

Yes.