feat: add Timeout example to README

Kaushik Gopal · Kaushik Gopal · commit 41516468d8cc · 2016-11-27T20:45:05.000-08:00
diff --git a/README.md b/README.md
@@ -26,6 +26,7 @@ I've also been giving talks about Learning Rx using many of the examples listed
 13. [Networking with Volley](https://github.com/kaushikgopal/RxJava-Android-Samples/blob/master/README.md#13-networking-with-volley)
 14. [Pagination with Rx (using Subjects)](https://github.com/kaushikgopal/RxJava-Android-Samples/blob/master/README.md#14-pagination-with-rx-using-subjects)
 15. [Orchestrating Observable: make parallel network calls, then combine the result into a single data point (using flatmap & zip)](https://github.com/kaushikgopal/RxJava-Android-Samples/blob/master/README.md#15-orchestrating-observable-make-parallel-network-calls-then-combine-the-result-into-a-single-data-point-using-flatmap--zip)
+16. [Simple Timeout example (using timeout)]()
 
 ## Description
 
@@ -215,6 +216,12 @@ The below ascii diagram expresses the intention of our next example with panache
 
 The code for this example has already been written by one Mr.skehlet in the interwebs. Head over to [the gist](https://gist.github.com/skehlet/9418379) for the code. It's written in pure Java (6) so it's pretty comprehensible if you've understood the previous examples. I'll flush it out here again when time permits or I've run out of other compelling examples.
 
+### 16. Simple Timeout example (using timeout)
+
+This is a simple example demonstrating the use of the `.timeout` operator. Button 1 will complete the task before the timeout constraint, while Button 2 will force a timeout error.
+
+Notice how we can provide a custom Observable that indicates how to react under a timeout Exception.
+
 ## Work in Progress:
 
 _Examples that I would like to have here, but haven't found the time yet to flush out_
diff --git a/app/src/main/java/com/morihacky/android/rxjava/fragments/MainFragment.java b/app/src/main/java/com/morihacky/android/rxjava/fragments/MainFragment.java
@@ -82,6 +82,11 @@ void demoTimerIntervalDelays() {
         clickedOn(new TimingDemoFragment());
     }
 
+    @OnClick(R.id.btn_demo_timeout)
+    void demoTimeout() {
+        clickedOn(new TimeoutDemoFragment());
+    }
+
     @OnClick(R.id.btn_demo_exponential_backoff)
     void demoExponentialBackoff() {
         clickedOn(new ExponentialBackoffFragment());
diff --git a/app/src/main/java/com/morihacky/android/rxjava/fragments/TimeoutDemoFragment.java b/app/src/main/java/com/morihacky/android/rxjava/fragments/TimeoutDemoFragment.java
@@ -64,6 +64,8 @@ public void onStart2sTask() {
         _disposable = _getEventCompletionObserver();
 
         _getObservableTask_2sToComplete()
+              .timeout(3, TimeUnit.SECONDS)
+              .subscribeOn(Schedulers.computation())
               .observeOn(AndroidSchedulers.mainThread())
               .subscribe(_disposable);
     }
@@ -72,8 +74,8 @@ public void onStart2sTask() {
     public void onStart5sTask() {
         _disposable = _getEventCompletionObserver();
 
-        _getObservableFor5sTask()
-              .timeout(2, TimeUnit.SECONDS, _getTimeoutObservable())
+        _getObservableTask_5sToComplete()
+              .timeout(3, TimeUnit.SECONDS, _onTimeoutObservable())
               .subscribeOn(Schedulers.computation())
               .observeOn(AndroidSchedulers.mainThread())
               .subscribe(_disposable);
@@ -82,14 +84,14 @@ public void onStart5sTask() {
     // -----------------------------------------------------------------------------------
     // Main Rx entities
 
-    private Observable<String> _getObservableFor5sTask() {
+    private Observable<String> _getObservableTask_5sToComplete() {
         return Observable.create(new ObservableOnSubscribe<String>() {
             @Override
             public void subscribe(ObservableEmitter<String> subscriber) throws Exception {
                 _log(String.format("Starting a 5s task"));
                 subscriber.onNext("5 s");
                 try {
-                    Thread.sleep(1200);
+                    Thread.sleep(5_000);
                 } catch (InterruptedException e) {
                     e.printStackTrace();
                 }
@@ -106,24 +108,22 @@ public void subscribe(ObservableEmitter<String> subscriber) throws Exception {
                       _log(String.format("Starting a 2s task"));
                       subscriber.onNext("2 s");
                       try {
-                          Thread.sleep(2000);
+                          Thread.sleep(2_000);
                       } catch (InterruptedException e) {
                           e.printStackTrace();
                       }
                       subscriber.onComplete();
                   }
-              })
-              .subscribeOn(Schedulers.computation())
-              .timeout(3, TimeUnit.SECONDS);
+              });
     }
 
-    private Observable<? extends String> _getTimeoutObservable() {
+    private Observable<? extends String> _onTimeoutObservable() {
         return Observable.create(new ObservableOnSubscribe<String>() {
 
             @Override
             public void subscribe(ObservableEmitter<String> subscriber) throws Exception {
                 _log("Timing out this task ...");
-                subscriber.onComplete();
+                subscriber.onError(new Throwable("Timeout Error"));
             }
         });
     }
diff --git a/app/src/main/res/layout/fragment_main.xml b/app/src/main/res/layout/fragment_main.xml
@@ -86,6 +86,13 @@
             android:text="@string/btn_demo_timing"
             />
 
+        <Button
+            android:id="@+id/btn_demo_timeout"
+            android:layout_height="wrap_content"
+            android:layout_width="match_parent"
+            android:text="@string/btn_demo_timeout"
+            />
+
         <Button
             android:id="@+id/btn_demo_exponential_backoff"
             android:layout_height="wrap_content"
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
@@ -9,7 +9,7 @@
     <string name="btn_demo_schedulers">bg work (schedulers &amp; concurrency)</string>
     <string name="btn_demo_buffer">accumulate calls (buffer)</string>
     <string name="btn_demo_debounce">search text listener(debounce)</string>
-    <string name="btn_demo_timeout">delayed jobs (timeout)</string>
+    <string name="btn_demo_timeout">Timeout long running jobs</string>
     <string name="btn_demo_retrofit">Retrofit + RxJava</string>
     <string name="btn_demo_double_binding_textview">Double binding (PublishSubject)</string>
     <string name="btn_demo_polling">Polling with RxJava</string>
