pubsub: clarify subscriber shutdown doc (#2487)

pongad · web-flow · commit 1dad07a79392 · 2017-10-10T11:16:29.000+11:00
In the doc, we just wait for done.get() to return before closing the Subscriber. This commit makes clear that done.get() in the doc is an example condition. Updates #2485.
diff --git a/google-cloud-examples/src/main/java/com/google/cloud/examples/pubsub/snippets/SubscriberSnippets.java b/google-cloud-examples/src/main/java/com/google/cloud/examples/pubsub/snippets/SubscriberSnippets.java
@@ -82,7 +82,10 @@ public void failed(Subscriber.State from, Throwable failure) {
     subscriber.startAsync();
 
     // Wait for a stop signal.
+    // In a server, this might be a signal to stop serving.
+    // In this example, the signal is just a dummy Future.
     done.get();
+
     subscriber.stopAsync().awaitTerminated();
   }
 
diff --git a/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/Subscriber.java b/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/Subscriber.java
@@ -222,7 +222,10 @@ public FlowControlSettings getFlowControlSettings() {
    * subscriber.startAsync();
    *
    * // Wait for a stop signal.
+   * // In a server, this might be a signal to stop serving.
+   * // In this example, the signal is just a dummy Future.
    * done.get();
+   *
    * subscriber.stopAsync().awaitTerminated();
    * }</pre>
    */

Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,10 @@ public void failed(Subscriber.State from, Throwable failure) {`
`82`	`82`	`subscriber.startAsync();`
`83`	`83`
`84`	`84`	`// Wait for a stop signal.`
	`85`	`+ // In a server, this might be a signal to stop serving.`
	`86`	`+ // In this example, the signal is just a dummy Future.`
`85`	`87`	`done.get();`
	`88`	`+`
`86`	`89`	`subscriber.stopAsync().awaitTerminated();`
`87`	`90`	`}`
`88`	`91`