com.facebook.stetho.inspector.network

Class NetworkEventReporterImpl

java.lang.Object

com.facebook.stetho.inspector.network.NetworkEventReporterImpl

All Implemented Interfaces:

NetworkEventReporter

public class NetworkEventReporterImpl
extends java.lang.Object
implements NetworkEventReporter

Implementation of NetworkEventReporter which allows callers to inform the Stetho system of network traffic. Callers can safely eagerly access this class and store a reference if they wish. When WebKit Inspector clients are connected, the internal implementation will be automatically wired up to them.

Nested Class Summary

Nested classes/interfaces inherited from interface com.facebook.stetho.inspector.network.NetworkEventReporter

NetworkEventReporter.InspectorHeaders, NetworkEventReporter.InspectorRequest, NetworkEventReporter.InspectorResponse

Method Summary

Modifier and Type	Method and Description
void	dataReceived(java.lang.String requestId, int dataLength, int encodedDataLength) Indicates that raw data was received from the network.
void	dataSent(java.lang.String requestId, int dataLength, int encodedDataLength) Indicates that raw data was sent over the network.
static NetworkEventReporter	get() Static accessor allowing callers to easily hook into the WebKit Inspector system without creating dependencies on the main Stetho initialization code path.
void	httpExchangeFailed(java.lang.String requestId, java.lang.String errorText) Indicates that communication with the server has failed.
java.io.InputStream	interpretResponseStream(java.lang.String requestId, java.lang.String contentType, java.lang.String contentEncoding, java.io.InputStream availableInputStream, ResponseHandler responseHandler) Intercept the stream as given by the underlying HTTP library that contains the body of the response.
boolean	isEnabled() Returns true if there is at least one peer listening for network events; false otherwise.
void	requestWillBeSent(NetworkEventReporter.InspectorRequest request) Indicates that a request is about to be sent, but has not yet been delivered over the wire.
void	responseHeadersReceived(NetworkEventReporter.InspectorResponse response) Indicates that a response message was just received from the network, but the body has not yet been read.
void	responseReadFailed(java.lang.String requestId, java.lang.String errorText) Indicates that there was a failure while reading from response stream.
void	responseReadFinished(java.lang.String requestId) Indicates that the response stream has been fully exhausted and the request is now complete.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

public static NetworkEventReporter get()

Static accessor allowing callers to easily hook into the WebKit Inspector system without creating dependencies on the main Stetho initialization code path.

isEnabled

public boolean isEnabled()

Description copied from interface: NetworkEventReporter

Returns true if there is at least one peer listening for network events; false otherwise. This value is provided as an optimization to avoid expensive work when the WebKit Inspector is not being used. It is otherwise safe to invoke methods defined in this interface when the value is false.

Specified by:

isEnabled in interface NetworkEventReporter

requestWillBeSent

public void requestWillBeSent(NetworkEventReporter.InspectorRequest request)

Description copied from interface: NetworkEventReporter

Indicates that a request is about to be sent, but has not yet been delivered over the wire.

Specified by:

requestWillBeSent in interface NetworkEventReporter

Parameters:

request - Request descriptor.

responseHeadersReceived

public void responseHeadersReceived(NetworkEventReporter.InspectorResponse response)

Description copied from interface: NetworkEventReporter

Indicates that a response message was just received from the network, but the body has not yet been read.

Specified by:

responseHeadersReceived in interface NetworkEventReporter

Parameters:

response - Response descriptor.

interpretResponseStream

public java.io.InputStream interpretResponseStream(java.lang.String requestId,
                                                   java.lang.String contentType,
                                                   java.lang.String contentEncoding,
                                                   java.io.InputStream availableInputStream,
                                                   ResponseHandler responseHandler)

Description copied from interface: NetworkEventReporter

Intercept the stream as given by the underlying HTTP library that contains the body of the response. In order to have the response show up in inspector (and to have the request be completed successfully) you need to call this AND read until exhaustion/EOF of the returned stream.

We will internally signal a failure if there is an IOException received while reading from the stream.

Do not invoke NetworkEventReporter.httpExchangeFailed(String, String) after calling this method.

Specified by:

interpretResponseStream in interface NetworkEventReporter

Parameters:

requestId - Unique identifier for the request as per NetworkEventReporter.InspectorRequest.id()

contentType - The Content-Type header value that was specified in NetworkEventReporter.InspectorResponse. This header is used to determine the appropriate storage format for the body. For instance, image/* is necessary to cause images to appear in the Inspector UI.

contentEncoding - The Content-Encoding header value that was specified in NetworkEventReporter.InspectorResponse. This header is used to determine what type of decompression is to be applied when delivering the raw response stream to the debugging interface. If null, no decompression will be used.

availableInputStream - Response stream if applicable ("HEAD" for instance does not have a body). null otherwise.

responseHandler - Callback to forward stream events back to the relevant event reporter methods. Recommend using DefaultResponseHandler for most callers.

Returns:

InputStream that has been intercepted if WebkitInspector is active and enabled otherwise it will return inputStream

httpExchangeFailed

public void httpExchangeFailed(java.lang.String requestId,
                               java.lang.String errorText)

Description copied from interface: NetworkEventReporter

Indicates that communication with the server has failed. You are expected to call this for any exception before you call NetworkEventReporter.interpretResponseStream(java.lang.String, java.lang.String, java.lang.String, java.io.InputStream, com.facebook.stetho.inspector.network.ResponseHandler). After NetworkEventReporter.interpretResponseStream(java.lang.String, java.lang.String, java.lang.String, java.io.InputStream, com.facebook.stetho.inspector.network.ResponseHandler) is called we will reporting any IOException during reading from the InputStream.

Specified by:

httpExchangeFailed in interface NetworkEventReporter

Parameters:

requestId - Unique identifier for the request as per NetworkEventReporter.InspectorRequest.id()

errorText - Text to report for the error; using Throwable.toString() is recommended.

responseReadFinished

public void responseReadFinished(java.lang.String requestId)

Description copied from interface: NetworkEventReporter

Indicates that the response stream has been fully exhausted and the request is now complete. If you use NetworkEventReporter.interpretResponseStream(java.lang.String, java.lang.String, java.lang.String, java.io.InputStream, com.facebook.stetho.inspector.network.ResponseHandler) with DefaultResponseHandler (as is recommended), this method will be invoked automatically for you.

Specified by:

responseReadFinished in interface NetworkEventReporter

Parameters:

requestId - Unique identifier for the request as per NetworkEventReporter.InspectorRequest.id()

responseReadFailed

public void responseReadFailed(java.lang.String requestId,
                               java.lang.String errorText)

Description copied from interface: NetworkEventReporter

Indicates that there was a failure while reading from response stream. If you use NetworkEventReporter.interpretResponseStream(java.lang.String, java.lang.String, java.lang.String, java.io.InputStream, com.facebook.stetho.inspector.network.ResponseHandler) with DefaultResponseHandler (as is recommended), this method will be invoked automatically for you.

Specified by:

responseReadFailed in interface NetworkEventReporter

Parameters:

requestId - Unique identifier for the request as per NetworkEventReporter.InspectorRequest.id()

errorText - Text to report for the error; using Throwable.toString() is recommended.

dataSent

public void dataSent(java.lang.String requestId,
                     int dataLength,
                     int encodedDataLength)

Description copied from interface: NetworkEventReporter

Indicates that raw data was sent over the network. It is permissible to invoke this method just once after the full size of the request is known.

Invoking this method is optional and merely provides additional timing metrics and actual payload sizes to the Inspector UI.

Specified by:

dataSent in interface NetworkEventReporter

Parameters:

requestId - Unique identifier for the request as per NetworkEventReporter.InspectorRequest.id()

dataLength - Uncompressed data segment length

encodedDataLength - Compressed data segment length

dataReceived

public void dataReceived(java.lang.String requestId,
                         int dataLength,
                         int encodedDataLength)

Description copied from interface: NetworkEventReporter

Indicates that raw data was received from the network.

Specified by:

dataReceived in interface NetworkEventReporter

See Also:

NetworkEventReporter.dataSent(java.lang.String, int, int)