com.google.gwt.dev.shell.remoteui

Class MessageTransport

java.lang.Object

com.google.gwt.dev.shell.remoteui.MessageTransport

public class MessageTransport
extends Object

Responsible for exchanging requests and responses between services.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MessageTransport.ErrorCallback A callback that is invoked when errors occur at the transport level.
class	MessageTransport.RequestException An exception that is generated by the transport when it receives a failure message from the server in response to executing a client request.

Constructor Summary

Constructors

Constructor and Description
MessageTransport(InputStream inputStream, OutputStream outputStream, RequestProcessor requestProcessor, MessageTransport.ErrorCallback errorCallback) Create a new instance using the given streams and request processor.

Method Summary

Modifier and Type	Method and Description
Future<RemoteMessageProto.Message.Response>	executeRequestAsync(RemoteMessageProto.Message.Request requestMessage) Asynchronously executes the request on a remote server.
void	executeRequestAsync(RemoteMessageProto.Message.Request requestMessage, Callback<RemoteMessageProto.Message.Response> callback) Asynchronously executes the request on a remote server.
void	start() Starts up the message transport.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Constructor Detail

MessageTransport

public MessageTransport(InputStream inputStream,
                        OutputStream outputStream,
                        RequestProcessor requestProcessor,
                        MessageTransport.ErrorCallback errorCallback)

Create a new instance using the given streams and request processor.

Parameters:

inputStream - an input stream for reading messages

outputStream - an output stream for writing messages

requestProcessor - a callback interface for handling remote client requests

terminationCallback - a callback that is invoked when the transport terminates

Method Detail

executeRequestAsync

public Future<RemoteMessageProto.Message.Response> executeRequestAsync(RemoteMessageProto.Message.Request requestMessage)

Asynchronously executes the request on a remote server.

Parameters:

requestMessage - The request to execute

Returns:

a Future that can be used to access the server's response

executeRequestAsync

public void executeRequestAsync(RemoteMessageProto.Message.Request requestMessage,
                                Callback<RemoteMessageProto.Message.Response> callback)

Asynchronously executes the request on a remote server. The callback will generally be called by another thread. Memory consistency effects: actions in a thread prior to calling this method happen-before the callback is invoked.

Parameters:

requestMessage - The request to execute

callback - The callback to invoke when the response is received

start

public void start()

Starts up the message transport. The message transport creates its own threads, so it is not necessary to invoke this method from a separate thread. Closing either stream will cause the termination of the transport.