Notify WebSocket connection failure, chromium side

content/common/websocket_messages.h

 // Copyright 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // Multiply-included message file, hence no include guard.
 
 // This file defines the IPCs for the browser-side implementation of
 // WebSockets. For the legacy renderer-side implementation, see
 // socket_stream_messages.h.
 // TODO(ricea): Fix this comment when the legacy implementation has been
@@ skipping 25 matching lines @@
 // "Subprotocols Using the WebSocket Protocol".
 //
 // The browser process will not send |channel_id| as-is to the remote server; it
 // will try to use a short id on the wire. This saves the renderer from
 // having to try to choose the ids cleverly.
 IPC_MESSAGE_ROUTED3(WebSocketHostMsg_AddChannelRequest,
                     GURL /* socket_url */,
                     std::vector<std::string> /* requested_protocols */,
                     GURL /* origin */)
 
-// Web Socket messages sent from the browser to the renderer.
+// WebSocket messages sent from the browser to the renderer.
 
 // Respond to an AddChannelRequest for channel |channel_id|. |channel_id| is
 // scoped to the renderer process; while it is unique per-renderer, the browser
 // may have multiple renderers using the same id. If |fail| is true, the channel
 // could not be established (the cause of the failure is not provided to the
 // renderer in order to limit its ability to abuse WebSockets to perform network
 // probing, etc.). If |fail| is set then the |channel_id| is available for
 // re-use. |selected_protocol| is the sub-protocol the server selected,
 // or empty if no sub-protocol was selected. |extensions| is the list of
 // extensions negotiated for the connection.
 IPC_MESSAGE_ROUTED3(WebSocketMsg_AddChannelResponse,
                     bool /* fail */,
                     std::string /* selected_protocol */,
                     std::string /* extensions */)
 
+// Notify the renderer that the browser is required to fail the connection.
+// This message will be followed by a corresponding DropChannel message and
+// hence the renderer should NOT drop the channel when it receives this
+// message.
+// |message| will be shown in the inspector and won't be passed to the

[Adam Rice, 2013/10/23 07:15:30]

If we had a way to pass the message directly to the process running the
inspector it would be preferable. But then I suppose we'd lose file & line
information.

Could you put in a TODO for "Find a way to not expose this information to the
renderer process"? Then we can worry about it when we are less busy.

[yhirano, 2013/10/23 08:10:42]

Done.

+// script.
+IPC_MESSAGE_ROUTED1(WebSocketMsg_NotifyFailure,
+                    std::string /* message */)
+
 // WebSocket messages that can be sent in either direction.
 
 IPC_ENUM_TRAITS(content::WebSocketMessageType)
 
 // Send a non-control frame on |channel_id|. If the sender is the renderer, it
 // will be sent to the remote server. If the sender is the browser, it comes
 // from the remote server. |fin| indicates that this frame is the last in the
 // current message. |type| is the type of the message. On the first frame of a
 // message, it must be set to either WEB_SOCKET_MESSAGE_TYPE_TEXT or
 // WEB_SOCKET_MESSAGE_TYPE_BINARY. On subsequent frames, it must be set to
@@ skipping 21 matching lines @@
 // and the TCP/IP connection will be closed.
 // When sent by the browser, this indicates that a Close or DropChannel has been
 // received, the connection was closed, or a network or protocol error
 // occurred. On receiving DropChannel, the renderer process may consider the
 // |channel_id| available for reuse by a new AddChannelRequest.
 // |code| is one of the reason codes specified in RFC6455 or
 // draft-ietf-hybi-websocket-multiplexing-09. |reason|, if non-empty, is a
 // UTF-8 encoded string which may be useful for debugging but is not necessarily
 // human-readable, as supplied by the server in the Close or DropChannel
 // message.
-IPC_MESSAGE_ROUTED2(WebSocketMsg_DropChannel,
+// If |was_clean| is false on a message from the browser, then the WebSocket
+// connection was not closed cleanly. If |was_clean| is false on a message from
+// the renderer, then the connection should be closed immediately without a
+// closing handshake and the renderer cannot accept any new messages about this
+// connection.
+IPC_MESSAGE_ROUTED3(WebSocketMsg_DropChannel,
+                    bool /* was_clean */,
                     unsigned short /* code */,
                     std::string /* reason */)