com.facebook.stetho.inspector

Class ChromeDevtoolsServer

java.lang.Object

com.facebook.stetho.inspector.ChromeDevtoolsServer

All Implemented Interfaces:

SimpleEndpoint

public class ChromeDevtoolsServer
extends java.lang.Object
implements SimpleEndpoint

Implements a limited version of the Chrome Debugger WebSocket protocol (using JSON-RPC 2.0). The most up-to-date documentation can be found in the Blink source code: protocol.json

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PATH

Constructor Summary

Constructors

Constructor and Description
ChromeDevtoolsServer(java.lang.Iterable<ChromeDevtoolsDomain> domainModules)

Method Summary

Modifier and Type	Method and Description
void	onClose(SimpleSession session, int code, java.lang.String reasonPhrase) Invoked when a remote peer closed the WebSocket session or if SimpleSession.close(int, java.lang.String) is invoked on our side.
void	onError(SimpleSession session, java.lang.Throwable ex) Invoked when errors occur out of the normal band of the WebSocket protocol.
void	onMessage(SimpleSession session, byte[] message, int messageLen) Invoked when a binary message is received from the peer.
void	onMessage(SimpleSession session, java.lang.String message) Invoked when a text-based message is received from the peer.
void	onOpen(SimpleSession session) Invoked when a new WebSocket session is established.

Methods inherited from class java.lang.Object

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

Field Detail

PATH

public static final java.lang.String PATH

See Also:

Constant Field Values

Constructor Detail

ChromeDevtoolsServer

public ChromeDevtoolsServer(java.lang.Iterable<ChromeDevtoolsDomain> domainModules)

Method Detail

onOpen

public void onOpen(SimpleSession session)

Description copied from interface: SimpleEndpoint

Invoked when a new WebSocket session is established.

Specified by:

onOpen in interface SimpleEndpoint

Parameters:

session - Unique handle for this session.

onClose

public void onClose(SimpleSession session,
                    int code,
                    java.lang.String reasonPhrase)

Description copied from interface: SimpleEndpoint

Invoked when a remote peer closed the WebSocket session or if SimpleSession.close(int, java.lang.String) is invoked on our side.

Specified by:

onClose in interface SimpleEndpoint

Parameters:

session - Unique handle for this session.

code - Close reason code (see RFC6455)

reasonPhrase - Possibly arbitrary text phrase associated with the reason code.

onMessage

public void onMessage(SimpleSession session,
                      byte[] message,
                      int messageLen)

Description copied from interface: SimpleEndpoint

Invoked when a binary message is received from the peer. May have spanned multiple WebSocket packets.

Specified by:

onMessage in interface SimpleEndpoint

Parameters:

session - Unique handle for this session.

message - Complete payload data.

messageLen - Maximum number of bytes of message to read.

onMessage

public void onMessage(SimpleSession session,
                      java.lang.String message)

Description copied from interface: SimpleEndpoint

Invoked when a text-based message is received from the peer. May have spanned multiple WebSocket packets.

Specified by:

onMessage in interface SimpleEndpoint

Parameters:

session - Unique handle for this session.

message - Complete payload data.

onError

public void onError(SimpleSession session,
                    java.lang.Throwable ex)

Description copied from interface: SimpleEndpoint

Invoked when errors occur out of the normal band of the WebSocket protocol. This is intended for debug purposes and is generally not actionable. The SimpleEndpoint.onClose(com.facebook.stetho.websocket.SimpleSession, int, java.lang.String) method will still be invoked in all cases, making it reasonable to simply log in this method.

Specified by:

onError in interface SimpleEndpoint

Parameters:

session - Unique handle for this session.

ex - Exception that occurred.