From 9e788b48c86fc47bcd9e03a1e867845f09526af4 Mon Sep 17 00:00:00 2001
From: Kohsuke Kawaguchi <kk@kohsuke.org>
Date: Thu, 17 Mar 2011 23:09:14 -0700
Subject: [PATCH] doc improvement

---
 remoting/src/main/java/hudson/remoting/Pipe.java | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/remoting/src/main/java/hudson/remoting/Pipe.java b/remoting/src/main/java/hudson/remoting/Pipe.java
index 22fb5c9a3c..86325c7c0e 100644
--- a/remoting/src/main/java/hudson/remoting/Pipe.java
+++ b/remoting/src/main/java/hudson/remoting/Pipe.java
@@ -71,6 +71,22 @@ import java.util.logging.Logger;
  * ... write to out ...
  * </pre>
  *
+ * Similarly, for remote to local pipe,
+ *
+ * <pre>
+ * final Pipe p = Pipe.createRemoteToLocal();
+ *
+ * channel.callAsync(new Callable() {
+ *   public Object call() {
+ *     OutputStream out = p.getOut();
+ *     ... write to out ...
+ *   }
+ * });
+ *
+ * InputStream in = p.getIn();
+ * ... read from in ...
+ * </pre>
+ *
  * <h2>Implementation Note</h2>
  * <p>
  * For better performance, {@link Pipe} uses lower-level {@link Command} abstraction
-- 
GitLab