com.google.gwt.dev.shell

Class BrowserChannel

java.lang.Object

com.google.gwt.dev.shell.BrowserChannel

Direct Known Subclasses:

BrowserChannelClient, BrowserChannelServer

public abstract class BrowserChannel
extends Object

A base class for communication between Dev-mode client and server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BrowserChannel.CheckVersionsMessage The initial request from the client, supplies a range of supported versions and the version from hosted.html (so stale copies on an external server can be detected).
protected static class	BrowserChannel.ChooseTransportMessage A message from the client giving a list of supported connection methods and requesting the server choose one of them to switch protocol traffic to.
protected static class	BrowserChannel.FatalErrorMessage A message reporting a connection error to the client.
protected static class	BrowserChannel.FreeMessage A message asking the other side to free object references.
protected static class	BrowserChannel.InvokeOnClientMessage A request from the server to invoke a function on the client.
protected static class	BrowserChannel.InvokeOnServerMessage A request from the client to invoke a function on the server.
protected static class	BrowserChannel.InvokeSpecialMessage A request from the to invoke a function on the other side.
static class	BrowserChannel.JavaObjectRef Class representing a reference to a Java object.
static class	BrowserChannel.JsObjectRef Class representing a reference to a JS object.
protected static class	BrowserChannel.LoadJsniMessage A message sending JSNI code to be evaluated.
protected static class	BrowserChannel.LoadModuleMessage A request from the client that the server load and initialize a given module.
protected static class	BrowserChannel.Message Abstract base class of OOPHM messages.
static class	BrowserChannel.MessageType Enumeration of message type ids.
protected static interface	BrowserChannel.ObjectRefFactory Provides a way of allocating JS and Java object ids without knowing which one is the remote type, so code can be shared between client and server.
protected static class	BrowserChannel.OldLoadModuleMessage A request from the client that the server load and initialize a given module (original v1 version).
protected static class	BrowserChannel.ProtocolVersionMessage Reports the selected protocol version.
protected static class	BrowserChannel.QuitMessage A message signifying a soft close of the communications channel.
static class	BrowserChannel.RemoteDeathError An error indicating that the remote side died and we should unroll the call stack as painlessly as possible to allow cleanup.
static interface	BrowserChannel.RemoteObjectRef Represents an object on the other side of the channel, known to this side by an reference ID.
protected static class	BrowserChannel.RequestIconMessage A message asking the client to send an icon suitable for use in the UI.
protected static class	BrowserChannel.ReturnMessage Signifies a return from a previous invoke.
static class	BrowserChannel.SessionHandler<T extends BrowserChannel> Hook interface for responding to messages.
protected static class	BrowserChannel.SwitchTransportMessage A response to ChooseTransport telling the client which transport should be used for the remainder of the protocol.
protected static class	BrowserChannel.UserAgentIconMessage A message supplying an icon, which fits in 24x24 and in a standard image format such as PNG or GIF, suitable for use in the UI.
static class	BrowserChannel.Value Represents a value for BrowserChannel.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PROTOCOL_VERSION_CURRENT The current version of the protocol.
static int	PROTOCOL_VERSION_GET_ICON The protocol version that added the GetIcon message.
static int	PROTOCOL_VERSION_OLDEST The oldest protocol version supported by this code.
static int	SPECIAL_CLIENTMETHODS_OBJECT
static int	SPECIAL_SERVERMETHODS_OBJECT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BrowserChannel(InputStream inputStream, OutputStream outputStream, BrowserChannel.ObjectRefFactory objectRefFactory)
	BrowserChannel(Socket socket, BrowserChannel.ObjectRefFactory objectRefFactory)

Method Summary

Modifier and Type	Method and Description
void	endSession()
protected static BrowserChannel.JavaObjectRef	getJavaObjectRef(int refId)
Set<Integer>	getRefIdsForCleanup()
String	getRemoteEndpoint()
protected DataInputStream	getStreamFromOtherSide()
protected DataOutputStream	getStreamToOtherSide()
protected static String	readUtf8String(DataInputStream stream)
protected BrowserChannel.Value	readValue(DataInputStream stream)
protected static BrowserChannel.Value.ValueType	readValueType(DataInputStream stream)
protected void	sendFreedValues()
protected static void	writeJavaObject(DataOutputStream stream, BrowserChannel.JavaObjectRef value)
protected static void	writeJsObject(DataOutputStream stream, BrowserChannel.JsObjectRef value)
protected static void	writeNull(DataOutputStream stream)
protected static void	writeTaggedBoolean(DataOutputStream stream, boolean value)
protected static void	writeTaggedByte(DataOutputStream stream, byte value)
protected static void	writeTaggedChar(DataOutputStream stream, char value)
protected static void	writeTaggedDouble(DataOutputStream stream, double value)
protected static void	writeTaggedInt(DataOutputStream stream, int value)
protected static void	writeTaggedShort(DataOutputStream stream, short value)
protected static void	writeTaggedString(DataOutputStream stream, String data)
protected static void	writeUtf8String(DataOutputStream stream, String data)
protected void	writeValue(DataOutputStream stream, BrowserChannel.Value value)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Field Detail

PROTOCOL_VERSION_CURRENT

public static final int PROTOCOL_VERSION_CURRENT

The current version of the protocol.

See Also:

Constant Field Values

PROTOCOL_VERSION_OLDEST

public static final int PROTOCOL_VERSION_OLDEST

The oldest protocol version supported by this code.

See Also:

Constant Field Values

PROTOCOL_VERSION_GET_ICON

public static final int PROTOCOL_VERSION_GET_ICON

The protocol version that added the GetIcon message.

See Also:

Constant Field Values

SPECIAL_CLIENTMETHODS_OBJECT

public static final int SPECIAL_CLIENTMETHODS_OBJECT

See Also:

Constant Field Values

SPECIAL_SERVERMETHODS_OBJECT

public static final int SPECIAL_SERVERMETHODS_OBJECT

See Also:

Constant Field Values

Constructor Detail

BrowserChannel

public BrowserChannel(Socket socket,
                      BrowserChannel.ObjectRefFactory objectRefFactory)
               throws IOException

Throws:

IOException

BrowserChannel

protected BrowserChannel(InputStream inputStream,
                         OutputStream outputStream,
                         BrowserChannel.ObjectRefFactory objectRefFactory)

Method Detail

getJavaObjectRef

protected static BrowserChannel.JavaObjectRef getJavaObjectRef(int refId)

readUtf8String

protected static String readUtf8String(DataInputStream stream)
                                throws IOException

Throws:

IOException

readValueType

protected static BrowserChannel.Value.ValueType readValueType(DataInputStream stream)
                                                       throws IOException,
                                                              BrowserChannelException

Throws:

IOException

BrowserChannelException

writeJavaObject

protected static void writeJavaObject(DataOutputStream stream,
                                      BrowserChannel.JavaObjectRef value)
                               throws IOException

Throws:

IOException

writeJsObject

protected static void writeJsObject(DataOutputStream stream,
                                    BrowserChannel.JsObjectRef value)
                             throws IOException

Throws:

IOException

writeNull

protected static void writeNull(DataOutputStream stream)
                         throws IOException

Throws:

IOException

writeTaggedBoolean

protected static void writeTaggedBoolean(DataOutputStream stream,
                                         boolean value)
                                  throws IOException

Throws:

IOException

writeTaggedByte

protected static void writeTaggedByte(DataOutputStream stream,
                                      byte value)
                               throws IOException

Throws:

IOException

writeTaggedChar

protected static void writeTaggedChar(DataOutputStream stream,
                                      char value)
                               throws IOException

Throws:

IOException

writeTaggedDouble

protected static void writeTaggedDouble(DataOutputStream stream,
                                        double value)
                                 throws IOException

Throws:

IOException

writeTaggedInt

protected static void writeTaggedInt(DataOutputStream stream,
                                     int value)
                              throws IOException

Throws:

IOException

writeTaggedShort

protected static void writeTaggedShort(DataOutputStream stream,
                                       short value)
                                throws IOException

Throws:

IOException

writeTaggedString

protected static void writeTaggedString(DataOutputStream stream,
                                        String data)
                                 throws IOException

Throws:

IOException

writeUtf8String

protected static void writeUtf8String(DataOutputStream stream,
                                      String data)
                               throws IOException

Throws:

IOException

endSession

public void endSession()

getRefIdsForCleanup

public Set<Integer> getRefIdsForCleanup()

Returns:

a set of remote object reference IDs to be freed.

getRemoteEndpoint

public String getRemoteEndpoint()

getStreamFromOtherSide

protected DataInputStream getStreamFromOtherSide()

getStreamToOtherSide

protected DataOutputStream getStreamToOtherSide()

readValue

protected BrowserChannel.Value readValue(DataInputStream stream)
                                  throws IOException

Throws:

IOException

sendFreedValues

protected void sendFreedValues()
                        throws IOException

Throws:

IOException

writeValue

protected void writeValue(DataOutputStream stream,
                          BrowserChannel.Value value)
                   throws IOException

Throws:

IOException