Prevent timeout from occuring while a request is being sent.

koush · koush · commit 647ec73d0b11 · 2013-07-12T13:31:14.000-07:00
Resume the timeout once sent and while waiting for a header.
Add a completion callback to AsyncRequestBody.

Change-Id: I3995452a5d21707ef217fb7478caee6569038be7
diff --git a/AndroidAsync/src/com/koushikdutta/async/http/AsyncHttpClient.java b/AndroidAsync/src/com/koushikdutta/async/http/AsyncHttpClient.java
@@ -81,6 +81,7 @@ public Future<AsyncHttpResponse> execute(final AsyncHttpRequest request, final H
     private class FutureAsyncHttpResponse extends SimpleFuture<AsyncHttpResponse> {
         public AsyncSocket socket;
         public Object scheduled;
+        public Runnable timeoutRunnable;
 
         @Override
         public boolean cancel() {
@@ -135,6 +136,10 @@ public void run() {
         }
     }
 
+    private static long getTimeoutRemaining(AsyncHttpRequest request) {
+        return Math.max(System.currentTimeMillis() - request.executionTime + request.getTimeout(), 1);
+    }
+
     private void executeAffinity(final AsyncHttpRequest request, final int redirectCount, final FutureAsyncHttpResponse cancel, final HttpConnectCallback callback) {
         assert mServer.isAffinityThread();
         if (redirectCount > 5) {
@@ -148,9 +153,19 @@ private void executeAffinity(final AsyncHttpRequest request, final int redirectC
 
         request.logd("Executing request.");
 
-        final Object scheduled;
+        // flow:
+        // 1) set a connect timeout
+        // 2) wait for connect
+        // 3) on connect, cancel timeout
+        // 4) wait for request to be sent fully
+        // 5) after request is sent, set a header timeout
+        // 6) wait for headers
+        // 7) on headers, cancel timeout
+        // 8) TODO: response can take as long as it wants to arrive?
+
         if (request.getTimeout() > 0) {
-            cancel.scheduled = scheduled = mServer.postDelayed(new Runnable() {
+            // set connect timeout
+            cancel.timeoutRunnable = new Runnable() {
                 @Override
                 public void run() {
                     // we've timed out, kill the connections
@@ -161,12 +176,11 @@ public void run() {
                     }
                     reportConnectedCompleted(cancel, new TimeoutException(), null, request, callback);
                 }
-            }, request.getTimeout());
-        }
-        else {
-            scheduled = null;
+            };
+            cancel.scheduled = mServer.postDelayed(cancel.timeoutRunnable, getTimeoutRemaining(request));
         }
 
+        // 2) wait for a connect
         data.connectCallback = new ConnectCallback() {
             @Override
             public void onConnectCompleted(Exception ex, AsyncSocket socket) {
@@ -176,6 +190,10 @@ public void onConnectCompleted(Exception ex, AsyncSocket socket) {
                     return;
                 }
 
+                // 3) on connect, cancel timeout
+                if (cancel.timeoutRunnable != null)
+                    mServer.removeAllCallbacks(cancel.scheduled);
+
                 data.socket = socket;
                 for (AsyncHttpClientMiddleware middleware: mMiddleware) {
                     middleware.onSocket(data);
@@ -188,7 +206,21 @@ public void onConnectCompleted(Exception ex, AsyncSocket socket) {
                     return;
                 }
 
+                // 4) wait for request to be sent fully
+                // and
+                // 6) wait for headers
                 final AsyncHttpResponseImpl ret = new AsyncHttpResponseImpl(request) {
+                    @Override
+                    protected void onRequestCompleted(Exception ex) {
+                        if (cancel.isCancelled())
+                            return;
+                        // 5) after request is sent, set a header timeout
+                        if (cancel.timeoutRunnable != null && data.headers == null) {
+                            mServer.removeAllCallbacks(cancel.scheduled);
+                            cancel.scheduled = mServer.postDelayed(cancel.timeoutRunnable, getTimeoutRemaining(request));
+                        }
+                    }
+
                     @Override
                     public void setDataEmitter(DataEmitter emitter) {
                         data.bodyEmitter = emitter;
@@ -228,8 +260,9 @@ protected void onHeadersReceived() {
                             if (cancel.isCancelled())
                                 return;
 
-                            if (scheduled != null)
-                                mServer.removeAllCallbacks(scheduled);
+                            // 7) on headers, cancel timeout
+                            if (cancel.timeoutRunnable != null)
+                                mServer.removeAllCallbacks(cancel.scheduled);
 
                             // allow the middleware to massage the headers before the body is decoded
                             request.logv("Received headers: " + mHeaders.getHeaders().toHeaderString());
diff --git a/AndroidAsync/src/com/koushikdutta/async/http/AsyncHttpRequestBody.java b/AndroidAsync/src/com/koushikdutta/async/http/AsyncHttpRequestBody.java
@@ -5,7 +5,7 @@
 import com.koushikdutta.async.callback.CompletedCallback;
 
 public interface AsyncHttpRequestBody<T> {
-    public void write(AsyncHttpRequest request, DataSink sink);
+    public void write(AsyncHttpRequest request, DataSink sink, CompletedCallback completed);
     public void parse(DataEmitter emitter, CompletedCallback completed);
     public String getContentType();
     public boolean readFullyOnRequest();
diff --git a/AndroidAsync/src/com/koushikdutta/async/http/AsyncHttpResponseImpl.java b/AndroidAsync/src/com/koushikdutta/async/http/AsyncHttpResponseImpl.java
@@ -51,15 +51,27 @@ public void onCompleted(Exception ex) {
         com.koushikdutta.async.Util.writeAll(exchange, rs.getBytes(), new CompletedCallback() {
             @Override
             public void onCompleted(Exception ex) {
-                if (mWriter != null)
-                    mWriter.write(mRequest, AsyncHttpResponseImpl.this);
+                if (mWriter != null) {
+                    mWriter.write(mRequest, AsyncHttpResponseImpl.this, new CompletedCallback() {
+                        @Override
+                        public void onCompleted(Exception ex) {
+                            onRequestCompleted(ex);
+                        }
+                    });
+                }
+                else {
+                    onRequestCompleted(null);
+                }
             }
         });
 
         LineEmitter liner = new LineEmitter();
         exchange.setDataCallback(liner);
         liner.setLineCallback(mHeaderCallback);
     }
+
+    protected void onRequestCompleted(Exception ex) {
+    }
     
     private CompletedCallback mReporter = new CompletedCallback() {
         @Override
@@ -161,6 +173,7 @@ public void write(ByteBufferList bb) {
 
     @Override
     public void end() {
+
         write(ByteBuffer.wrap(new byte[0]));
     }
 
diff --git a/AndroidAsync/src/com/koushikdutta/async/http/JSONArrayBody.java b/AndroidAsync/src/com/koushikdutta/async/http/JSONArrayBody.java
@@ -32,8 +32,8 @@ public void onCompleted(Exception e, JSONArray result) {
     }
 
     @Override
-    public void write(AsyncHttpRequest request, DataSink sink) {
-        Util.writeAll(sink, mBodyBytes, null);
+    public void write(AsyncHttpRequest request, DataSink sink, final CompletedCallback completed) {
+        Util.writeAll(sink, mBodyBytes, completed);
     }
 
     @Override
diff --git a/AndroidAsync/src/com/koushikdutta/async/http/JSONObjectBody.java b/AndroidAsync/src/com/koushikdutta/async/http/JSONObjectBody.java
@@ -32,8 +32,8 @@ public void onCompleted(Exception e, JSONObject result) {
     }
 
     @Override
-    public void write(AsyncHttpRequest request, DataSink sink) {
-        Util.writeAll(sink, mBodyBytes, null);
+    public void write(AsyncHttpRequest request, DataSink sink, final CompletedCallback completed) {
+        Util.writeAll(sink, mBodyBytes, completed);
     }
 
     @Override
diff --git a/AndroidAsync/src/com/koushikdutta/async/http/MultipartFormDataBody.java b/AndroidAsync/src/com/koushikdutta/async/http/MultipartFormDataBody.java
@@ -122,7 +122,7 @@ public MultipartCallback getMultipartCallback() {
 
     int written;
     @Override
-    public void write(AsyncHttpRequest request, final DataSink sink) {
+    public void write(AsyncHttpRequest request, final DataSink sink, final CompletedCallback completed) {
         if (mParts == null) {
             sink.end();
             return;
@@ -131,6 +131,7 @@ public void write(AsyncHttpRequest request, final DataSink sink) {
         Continuation c = new Continuation(new CompletedCallback() {
             @Override
             public void onCompleted(Exception ex) {
+                completed.onCompleted(ex);
 //                if (ex == null)
 //                    sink.end();
 //                else
diff --git a/AndroidAsync/src/com/koushikdutta/async/http/StringBody.java b/AndroidAsync/src/com/koushikdutta/async/http/StringBody.java
@@ -32,10 +32,10 @@ public void onCompleted(Exception e, String result) {
     public static final String CONTENT_TYPE = "text/plain";
 
     @Override
-    public void write(AsyncHttpRequest request, DataSink sink) {
+    public void write(AsyncHttpRequest request, DataSink sink, final CompletedCallback completed) {
         if (mBodyBytes == null)
             mBodyBytes = string.getBytes();
-        Util.writeAll(sink, mBodyBytes, null);
+        Util.writeAll(sink, mBodyBytes, completed);
     }
 
     @Override
diff --git a/AndroidAsync/src/com/koushikdutta/async/http/UrlEncodedFormBody.java b/AndroidAsync/src/com/koushikdutta/async/http/UrlEncodedFormBody.java
@@ -45,10 +45,10 @@ private void buildData() {
     }
     
     @Override
-    public void write(AsyncHttpRequest request, final DataSink response) {
+    public void write(AsyncHttpRequest request, final DataSink response, final CompletedCallback completed) {
         if (mBodyBytes == null)
             buildData();
-        Util.writeAll(response, mBodyBytes, null);
+        Util.writeAll(response, mBodyBytes, completed);
     }
 
     public static final String CONTENT_TYPE = "application/x-www-form-urlencoded";
diff --git a/AndroidAsync/src/com/koushikdutta/async/http/server/UnknownRequestBody.java b/AndroidAsync/src/com/koushikdutta/async/http/server/UnknownRequestBody.java
@@ -13,7 +13,7 @@ public UnknownRequestBody(String contentType) {
     }
 
     @Override
-    public void write(AsyncHttpRequest request, DataSink sink) {
+    public void write(AsyncHttpRequest request, DataSink sink, final CompletedCallback completed) {
         assert false;
     }
 

Original file line number	Diff line number	Diff line change
`@@ -32,8 +32,8 @@ public void onCompleted(Exception e, JSONArray result) {`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`@Override`
`35`		`- public void write(AsyncHttpRequest request, DataSink sink) {`
`36`		`- Util.writeAll(sink, mBodyBytes, null);`
	`35`	`+ public void write(AsyncHttpRequest request, DataSink sink, final CompletedCallback completed) {`
	`36`	`+ Util.writeAll(sink, mBodyBytes, completed);`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -45,10 +45,10 @@ private void buildData() {`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`@Override`
`48`		`- public void write(AsyncHttpRequest request, final DataSink response) {`
	`48`	`+ public void write(AsyncHttpRequest request, final DataSink response, final CompletedCallback completed) {`
`49`	`49`	`if (mBodyBytes == null)`
`50`	`50`	`buildData();`
`51`		`- Util.writeAll(response, mBodyBytes, null);`
	`51`	`+ Util.writeAll(response, mBodyBytes, completed);`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`public static final String CONTENT_TYPE = "application/x-www-form-urlencoded";`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ public UnknownRequestBody(String contentType) {`
`13`	`13`	`}`
`14`	`14`
`15`	`15`	`@Override`
`16`		`- public void write(AsyncHttpRequest request, DataSink sink) {`
	`16`	`+ public void write(AsyncHttpRequest request, DataSink sink, final CompletedCallback completed) {`
`17`	`17`	`assert false;`
`18`	`18`	`}`
`19`	`19`