1/* 2 * Copyright (C) 2012 Google Inc. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: 7 * 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above 11 * copyright notice, this list of conditions and the following disclaimer 12 * in the documentation and/or other materials provided with the 13 * distribution. 14 * * Neither the name of Google Inc. nor the names of its 15 * contributors may be used to endorse or promote products derived from 16 * this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31#ifndef WebSocketFrame_h 32#define WebSocketFrame_h 33 34#if ENABLE(WEB_SOCKETS) 35 36#include <wtf/text/WTFString.h> 37 38namespace WebCore { 39 40struct WebSocketFrame { 41 // RFC6455 opcodes. 42 enum OpCode { 43 OpCodeContinuation = 0x0, 44 OpCodeText = 0x1, 45 OpCodeBinary = 0x2, 46 OpCodeClose = 0x8, 47 OpCodePing = 0x9, 48 OpCodePong = 0xA, 49 OpCodeInvalid = 0x10 50 }; 51 52 enum ParseFrameResult { 53 FrameOK, 54 FrameIncomplete, 55 FrameError 56 }; 57 58 static bool isNonControlOpCode(OpCode opCode) { return opCode == OpCodeContinuation || opCode == OpCodeText || opCode == OpCodeBinary; } 59 static bool isControlOpCode(OpCode opCode) { return opCode == OpCodeClose || opCode == OpCodePing || opCode == OpCodePong; } 60 static bool isReservedOpCode(OpCode opCode) { return !isNonControlOpCode(opCode) && !isControlOpCode(opCode); } 61 static bool needsExtendedLengthField(size_t payloadLength); 62 static ParseFrameResult parseFrame(char* data, size_t dataLength, WebSocketFrame&, const char*& frameEnd, String& errorString); // May modify part of data to unmask the frame. 63 64 WebSocketFrame(OpCode = OpCodeInvalid, bool final = false, bool compress = false, bool masked = false, const char* payload = 0, size_t payloadLength = 0); 65 void makeFrameData(Vector<char>& frameData); 66 67 OpCode opCode; 68 bool final; 69 bool compress; 70 bool reserved2; 71 bool reserved3; 72 bool masked; 73 const char* payload; 74 size_t payloadLength; 75}; 76 77} // namespace WebCore 78 79#endif // ENABLE(WEB_SOCKETS) 80 81#endif // WebSocketFrame_h 82