Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(140)

Side by Side Diff: components/cronet/android/java/src/org/chromium/net/UploadDataProvider.java

Issue 849903002: [Cronet] Upload support for async APIs (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Combined with Matt's CL Created 5 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
(Empty)
1 // Copyright 2014 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 package org.chromium.net;
6
7 import java.nio.ByteBuffer;
8
9 /**
10 * Interface allowing the embedder to provide an upload body to UrlRequest.
11 * It supports both non-chunked (size known in advanced) and chunked (size not
12 * known in advance) uploads. Be aware that not all servers support chunked
13 * uploads.
14 *
15 * An upload is either always chunked, across multiple uploads if the data ends
16 * up being sent more than once, or never chunked.
17 */
18 public interface UploadDataProvider {
19 /**
20 * @return if this is a non-chunked upload, returns the length of the
21 * upload. Must always return -1 if this is a chunked upload.
22 */
23 public long getLength();
24
25 /**
26 * Reads upload data into byteBuffer. Each call must be followed be a single
27 * call, either synchronous or asynchronous, to uploadDataSink:
28 * onReadSucceeded on success or onError on failure. Neither read nor rewind
29 * will be called until one of those methods or the other is called. Even if
30 * the associated UrlRequest is cancelled, one or the other must still be
31 * called before resources can be safely freed. Throwing an exception will
32 * also result in resources being freed and the request being cancelled.
33 *
34 * @param uploadDataSink The object to notify when the read has completed,
35 * successfully or otherwise.
36 * @param byteBuffer The buffer to copy the read bytes into.
37 */
38 public void read(UploadDataSink uploadDataSink, ByteBuffer byteBuffer);
39
40 /**
41 * Reads upload data into byteBuffer. Each call must be followed be a single
mef 2015/02/02 17:45:11 copy/paste comment?
xunjieli 2015/02/02 18:25:41 Done.
42 * call, either synchronous or asynchronous, to uploadDataSink:
43 * onRewindSucceeded on success or onError on failure. Neither read nor
44 * rewind will be called until one of those methods or the other is called.
45 * Even if the associated UrlRequest is cancelled, one or the other must
46 * still be called before resources can be safely freed. Throwing an
47 * exception will also result in resources being freed and the request being
48 * cancelled.
49 *
50 * If rewinding is not supported, this should call onError. Note that
51 * rewinding is required to follow redirects that preserve the upload body,
52 * and for retrying when the server times out stale sockets.
53 *
54 * @param uploadDataSink The object to notify when the rewind operation has
55 * completed, successfully or otherwise.
56 */
57 public void rewind(UploadDataSink uploadDataSink);
58 }
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698