CronetDataSource

@UnstableApi
public static final int DEFAULT_CONNECT_TIMEOUT_MILLIS = 8000

The default connection timeout, in milliseconds.

@UnstableApi
public static final int DEFAULT_READ_TIMEOUT_MILLIS = 8000

The default read timeout, in milliseconds.

protected @Nullable UrlRequest currentUrlRequest

@UnstableApi
protected CronetDataSource(
    CronetEngine cronetEngine,
    Executor executor,
    int requestPriority,
    int connectTimeoutMs,
    int readTimeoutMs,
    boolean resetTimeoutOnRedirects,
    boolean handleSetCookieRequests,
    @Nullable String userAgent,
    @Nullable HttpDataSource.RequestProperties defaultRequestProperties,
    @Nullable Predicate<String> contentTypePredicate,
    boolean keepPostFor302Redirects
)

@UnstableApi
public void clearAllRequestProperties()

Clears all request headers that were set by setRequestProperty.

@UnstableApi
public void clearRequestProperty(String name)

Clears the value of a request header. The change will apply to subsequent connections established by the source.

@UnstableApi
synchronized public void close()

Closes the source. This method must be called even if the corresponding call to open threw an IOException.

@UnstableApi
public int getResponseCode()

When the source is open, returns the HTTP response status code associated with the last open call. Otherwise, returns a negative value.

@UnstableApi
public Map<String, List<String>> getResponseHeaders()

When the source is open, returns the response headers associated with the last open call. Otherwise, returns an empty map.

Key look-up in the returned map is case-insensitive.

@UnstableApi
public @Nullable Uri getUri()

When the source is open, returns the Uri from which data is being read. The returned Uri will be identical to the one passed open in the DataSpec unless redirection has occurred. If redirection has occurred, the Uri after redirection is returned.

@UnstableApi
public long open(DataSpec dataSpec)

Opens the source to read the specified data. If an IOException is thrown, callers must still call close to ensure that any partial effects of the invocation are cleaned up.

The following edge case behaviors apply:

• If the requested position is within the resource, but the requested length extends beyond the end of the resource, then open will succeed and data from the requested position to the end of the resource will be made available through read.
• If the requested position is equal to the length of the resource, then open will succeed, and read will immediately return RESULT_END_OF_INPUT.
• If the requested position is greater than the length of the resource, then open will throw an IOException for which isCausedByPositionOutOfRange will be true.

@UnstableApi
public int read(ByteBuffer buffer)

Reads up to buffer.remaining() bytes of data and stores them into buffer, starting at buffer.position(). Advances the position of the buffer by the number of bytes read and returns this length.

If there is an error, a HttpDataSourceException is thrown and the contents of buffer should be ignored. If the exception has error code HttpDataSourceException.TYPE_READ, note that Cronet may continue writing into buffer after the method has returned. Thus the caller should not attempt to reuse the buffer.

If buffer.remaining() is zero then 0 is returned. Otherwise, if no data is available because the end of the opened range has been reached, then RESULT_END_OF_INPUT is returned. Otherwise, the call will block until at least one byte of data has been read and the number of bytes read is returned.

Passed buffer must be direct ByteBuffer. If you have a non-direct ByteBuffer, consider the alternative read method with its backed array.

@UnstableApi
public int read(byte[] buffer, int offset, int length)

Reads up to length bytes of data from the input.

If readLength is zero then 0 is returned. Otherwise, if no data is available because the end of the opened range has been reached, then RESULT_END_OF_INPUT is returned. Otherwise, the call will block until at least one byte of data has been read and the number of bytes read is returned.

@UnstableApi
public void setContentTypePredicate(
    @Nullable Predicate<String> contentTypePredicate
)

@UnstableApi
public void setRequestProperty(String name, String value)

Sets the value of a request header. The value will be used for subsequent connections established by the source.

Note: If the same header is set as a default parameter in the Factory, then the header value set with this method should be preferred when connecting with the data source. See open.

@UnstableApi
protected UrlRequest.Builder buildRequestBuilder(DataSpec dataSpec)

@UnstableApi
protected @Nullable UrlRequest getCurrentUrlRequest()

Returns current UrlRequest. May be null if the data source is not opened.

@UnstableApi
protected @Nullable UrlResponseInfo getCurrentUrlResponseInfo()

Returns current UrlResponseInfo. May be null if the data source is not opened.