Add WebSocketError to indicate decoding failure reason

net/websockets/websocket_frame_parser.h

 // Copyright (c) 2012 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.
 
 #ifndef NET_WEBSOCKETS_WEBSOCKET_FRAME_PARSER_H_
 #define NET_WEBSOCKETS_WEBSOCKET_FRAME_PARSER_H_
 
 #include <vector>
 
 #include "base/basictypes.h"
@@ skipping 23 matching lines @@
   // any more data and future invocations of Decode() will simply return false.
   //
   // Payload data of parsed WebSocket frames may be incomplete; see comments in
   // websocket_frame.h for more details.
   bool Decode(const char* data,
               size_t length,
               ScopedVector<WebSocketFrameChunk>* frame_chunks);
 
   // Returns true if the parser has ever failed to decode a WebSocket frame.
   // TODO(yutak): Provide human-readable description of failure.
   bool failed() const { return failed_; }

[mmenke, 2012/08/01 14:44:59]

Do we still need this?  If so, think we should be returning "error_code_ !=
WS_OK", and just get rid of the bool.  That way, shouldn't get any bugs where we
forget to set one or the other.

[Takashi Toyoshima, 2012/08/02 08:11:35]

Ah, that is right.
I'll remove this function and member.

+  WebSocketError error_code() const { return error_code_; }

[mmenke, 2012/08/01 14:44:59]

Suggest calling this websocket_error instead, to make it clearer that this isn't
a generic net error code.

[Takashi Toyoshima, 2012/08/02 08:11:35]

Done.

 
  private:
   // Tries to decode a frame header from |current_read_pos_|.
   // If successful, this function updates |current_read_pos_|,
   // |current_frame_header_|, and |masking_key_| (if available).
   // This function may set |failed_| to true if it observes a corrupt frame.
   // If there is not enough data in the remaining buffer to parse a frame
   // header, this function returns without doing anything.
   void DecodeFrameHeader();
 
@@ skipping 13 matching lines @@
 
   // Frame header and masking key of the current frame.
   // |masking_key_| is filled with zeros if the current frame is not masked.
   scoped_ptr<WebSocketFrameHeader> current_frame_header_;
   char masking_key_[WebSocketFrameHeader::kMaskingKeyLength];
 
   // Amount of payload data read so far for the current frame.
   uint64 frame_offset_;
 
   bool failed_;
+  WebSocketError error_code_;
 
   DISALLOW_COPY_AND_ASSIGN(WebSocketFrameParser);
 };
 
 }  // namespace net
 
 #endif  // NET_WEBSOCKETS_WEBSOCKET_FRAME_PARSER_H_