com.google.gwt.dev.shell.remoteui

Class ViewerServiceClient

java.lang.Object

com.google.gwt.dev.shell.remoteui.ViewerServiceClient

public class ViewerServiceClient
extends Object

Used for making requests to a remote ViewerService server. TODO: If this becomes part of the public API, we'll need to provide a level of indirection in front of the protobuf classes; We're going to be rebasing the protobuf library, and we don't want to expose the rebased API as public.

Constructor Summary

Constructors

Constructor and Description
ViewerServiceClient(MessageTransport processor, TreeLogger unexpectedErrorLogger) Create a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addLogBranch(int indexInParent, TreeLogger.Type type, String msg, Throwable caught, TreeLogger.HelpInfo helpInfo, int parentLogHandle, Callback<Integer> callback) Add an entry that also serves as a log branch.
void	addLogEntry(int indexInParent, TreeLogger.Type type, String msg, Throwable caught, TreeLogger.HelpInfo helpInfo, int logHandle) Add a log entry.
int	addModuleLog(String remoteSocket, String url, String tabKey, String moduleName, String sessionKey, String agentTag, byte[] agentIcon) Add a new Module logger.
void	checkCapabilities() Check the capabilities of the ViewerService.
void	disconnectLog(int logHandle) Disconnect the log.
void	initialize(String clientId, List<String> startupURLs)

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewerServiceClient

public ViewerServiceClient(MessageTransport processor,
                   TreeLogger unexpectedErrorLogger)

Create a new instance.

Parameters:

processor - A MessageProcessor that is used to communicate with the ViewerService server.

Method Detail

addLogBranch

public void addLogBranch(int indexInParent,
                TreeLogger.Type type,
                String msg,
                Throwable caught,
                TreeLogger.HelpInfo helpInfo,
                int parentLogHandle,
                Callback<Integer> callback)

Add an entry that also serves as a log branch.

Parameters:

indexInParent - The index of this entry/branch within the parent logger

type - The severity of the log message.

msg - The message.

caught - An exception associated with the message

helpInfo - A URL or message which directs the user to helpful information related to the log message

parentLogHandle - The log handle of the parent of this log entry/branch

callback - the callback to call when a branch handle is available

addLogEntry

public void addLogEntry(int indexInParent,
               TreeLogger.Type type,
               String msg,
               Throwable caught,
               TreeLogger.HelpInfo helpInfo,
               int logHandle)

Add a log entry.

Parameters:

indexInParent - The index of this entry within the parent logger

type - The severity of the log message.

msg - The message.

caught - An exception associated with the message

helpInfo - A URL or message which directs the user to helpful information related to the log message

logHandle - The log handle of the parent of this log entry/branch

addModuleLog

public int addModuleLog(String remoteSocket,
               String url,
               String tabKey,
               String moduleName,
               String sessionKey,
               String agentTag,
               byte[] agentIcon)

Add a new Module logger. This method should not be called multiple times with the exact same arguments (as there should only be one logger associated with that set of arguments).

Parameters:

remoteSocket - name of remote socket endpoint in host:port format

url - URL of top-level window

tabKey - stable browser tab identifier, or the empty string if no such identifier is available

moduleName - the name of the module loaded

sessionKey - a unique session key

agentTag - short-form user agent identifier, suitable for use in a label for this connection

agentIcon - icon to use for the user agent (fits inside 24x24) or null if unavailable

Returns:

the log handle for the newly-created Module logger

checkCapabilities

public void checkCapabilities()

Check the capabilities of the ViewerService. Ensures that the ViewerService supports: adding a log, adding a log branch, adding a log entry, and disconnecting a log. TODO: Should we be checking the specific capability of the ViewerService to support logs of type MAIN, SERVER, and MODULE? Right now, we assume that if they can support the addition of logs, they can handle the addition of any types of logs that we throw at them.

disconnectLog

public void disconnectLog(int logHandle)

Disconnect the log. Indicate to the log that the process which was logging messages to it is now dead, and no more messages will be logged to it. Note that the log handle should refer to a top-level log, not a branch log.

Parameters:

logHandle - the handle of the top-level log to disconnect

initialize

public void initialize(String clientId,
              List<String> startupURLs)