package com.google.gwt.dev.shell.remoteui

Get desktop application:
View/edit binary Protocol Buffers messages

Outer envelope for all messages

• optional string protocolVersion = 1

  In the first release, we'll ignore this field. In the future, we can make use of it to detect protocol incompatibilities

• optional Message.MessageType messageType = 2

• required uint32 messageId = 3

• optional Message.Request request = 4

• optional Message.Response response = 5

• optional Message.Failure failure = 6

Used in: Message

• optional string message = 1

• optional string stackTrace = 2

Two types of messages - either a request, or a response

Used in: Message

• REQUEST = 0

• RESPONSE = 1

• FAILURE = 2

A request message. This is the root type for all request messages

Used in: Message

• optional Request.ServiceType serviceType = 1

• optional Request.ViewerRequest viewerRequest = 2

• optional Request.DevModeRequest devModeRequest = 3

The root type for all requests for the DevModeService

Used in: Request

• optional DevModeRequest.RequestType requestType = 1

• optional DevModeRequest.CapabilityExchange capabilityExchange = 2

• optional DevModeRequest.RestartWebServer restartWebServer = 3

Request the capabilities of the DevModeService. No additional information is needed at this time.

Used in: DevModeRequest

(message has no fields)

The different types of requests for the DevModeService

Used in: DevModeRequest, Response.DevModeResponse.CapabilityExchange.Capability

• CAPABILITY_EXCHANGE = 0

• RESTART_WEB_SERVER = 1

Restart the web server. No additional information is needed at this time.

Used in: DevModeRequest

(message has no fields)

Every request must be addressed to a service. The two types of services are the ViewerService, and the DevModeService. The ViewerService accepts commands for a Viewer. The DevModeService accepts requests for the Development Mode Server.

Used in: Request

• VIEWER = 0

• DEV_MODE = 1

The root type for all requests for the ViewerService

Used in: Request

• optional ViewerRequest.RequestType requestType = 1

• optional ViewerRequest.CapabilityExchange capabilityExchange = 2

• optional ViewerRequest.AddLog addLog = 3

• optional ViewerRequest.AddLogBranch addLogBranch = 4

• optional ViewerRequest.AddLogEntry addLogEntry = 5

• optional ViewerRequest.DisconnectLog disconnectLog = 6

• optional ViewerRequest.Initialize initialize = 7

Add a log message to the view

Used in: ViewerRequest

• optional AddLog.LogType type = 1

• optional AddLog.ModuleLog moduleLog = 2

• optional AddLog.ServerLog serverLog = 3

• optional AddLog.MainLog mainLog = 4

The type of log - either a web server log, a module log, or the main log

Used in: AddLog

• MAIN = 0

• MODULE = 1

• WEB_SERVER = 2

Information needed for creating the Main Log. At this time, no additional information is needed.

Used in: AddLog

(message has no fields)

Information needed for creating a Module Log

Used in: AddLog

• required string name = 1

• optional bytes icon = 2

• optional string sessionKey = 3

• optional string userAgent = 4

• optional string url = 5

• optional string tabKey = 6

• optional string remoteHost = 7

Information needed for creating a Server Log

Used in: AddLog

• required string name = 1

• optional bytes icon = 2

Add a new log branch to an existing log

Used in: ViewerRequest

• required uint32 parentLogHandle = 1

• required uint32 indexInParent = 2

• required LogData logData = 3

Add a log entry to a log

Used in: ViewerRequest

• required uint32 logHandle = 1

• required uint32 indexInLog = 2

• required LogData logData = 3

Request the capabilities of the ViewerService. No additional information is needed at this time.

Used in: ViewerRequest

(message has no fields)

Disconnect the given log (i.e. process for which information was being logged is dead)

Used in: ViewerRequest

• required uint32 logHandle = 1

Used in: ViewerRequest

• optional string clientId = 1

• repeated string startupURLs = 2

The data for a log entry

Used in: AddLogBranch, AddLogEntry

• required string summary = 1

• optional string level = 2

• optional bool needsAttention = 3

• optional string details = 4

• optional LogData.HelpInfo helpInfo = 5

The HelpInfo portion of the log entry

Used in: LogData

• optional string url = 1

• optional string text = 2

The different types of requests for a ViewerService

Used in: ViewerRequest, Response.ViewerResponse.CapabilityExchange.Capability

• CAPABILITY_EXCHANGE = 0

• ADD_LOG = 1

• ADD_LOG_BRANCH = 2

• ADD_LOG_ENTRY = 3

• DISCONNECT_LOG = 4

• INITIALIZE = 5

A response message for a request. This is the root type for all response messages.

Used in: Message

• optional Response.ViewerResponse viewerResponse = 1

• optional Response.DevModeResponse devModeResponse = 2

The root type for all response messages from the DevModeService

Used in: Response

• optional DevModeResponse.ResponseType responseType = 1

• optional DevModeResponse.CapabilityExchange capabilityExchange = 2

• optional DevModeResponse.RestartWebServer restartWebServer = 3

Response for the capabilities of the DevModeService

Used in: DevModeResponse

• repeated CapabilityExchange.Capability capabilities = 2

Used in: CapabilityExchange

• optional Request.DevModeRequest.RequestType capability = 1

The different types of response messages from the DevModeService

Used in: DevModeResponse

• CAPABILITY_EXCHANGE = 0

• RESTART_WEB_SERVER = 1

Response to a RestartWebServer request. Right now, there is no information that needs to be passed back

Used in: DevModeResponse

(message has no fields)

The root type for all response messages from the ViewerService

Used in: Response

• optional ViewerResponse.ResponseType responseType = 1

• optional ViewerResponse.CapabilityExchange capabilityExchange = 2

• optional ViewerResponse.AddLog addLog = 3

• optional ViewerResponse.AddLogBranch addLogBranch = 4

Response to an AddLog request

Used in: ViewerResponse

• required uint32 logHandle = 1

Response to an AddLogBranch request

Used in: ViewerResponse

• required uint32 logHandle = 1

Response for the capabilities of the ViewerService

Used in: ViewerResponse

• repeated CapabilityExchange.Capability capabilities = 2

Used in: CapabilityExchange

• optional Request.ViewerRequest.RequestType capability = 1

The different types of response messages that can come from the ViewerService

Used in: ViewerResponse

• CAPABILITY_EXCHANGE = 0

• ADD_LOG = 1

• ADD_LOG_BRANCH = 2