1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
|
/*
* Copyright (C) 2009 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef WebSocketChannel_h
#define WebSocketChannel_h
#include "bindings/core/v8/SourceLocation.h"
#include "core/inspector/ConsoleTypes.h"
#include "modules/ModulesExport.h"
#include "platform/heap/Handle.h"
#include "wtf/Forward.h"
#include "wtf/Noncopyable.h"
#include <memory>
namespace blink {
class BlobDataHandle;
class DOMArrayBuffer;
class ExecutionContext;
class KURL;
class WebSocketChannelClient;
class MODULES_EXPORT WebSocketChannel
: public GarbageCollectedFinalized<WebSocketChannel> {
WTF_MAKE_NONCOPYABLE(WebSocketChannel);
public:
WebSocketChannel() {}
static WebSocketChannel* create(ExecutionContext*, WebSocketChannelClient*);
enum CloseEventCode {
CloseEventCodeNotSpecified = -1,
CloseEventCodeNormalClosure = 1000,
CloseEventCodeGoingAway = 1001,
CloseEventCodeProtocolError = 1002,
CloseEventCodeUnsupportedData = 1003,
CloseEventCodeFrameTooLarge = 1004,
CloseEventCodeNoStatusRcvd = 1005,
CloseEventCodeAbnormalClosure = 1006,
CloseEventCodeInvalidFramePayloadData = 1007,
CloseEventCodePolicyViolation = 1008,
CloseEventCodeMessageTooBig = 1009,
CloseEventCodeMandatoryExt = 1010,
CloseEventCodeInternalError = 1011,
CloseEventCodeTLSHandshake = 1015,
CloseEventCodeMinimumUserDefined = 3000,
CloseEventCodeMaximumUserDefined = 4999
};
virtual bool connect(const KURL&, const String& protocol) = 0;
virtual void send(const CString&) = 0;
virtual void send(const DOMArrayBuffer&,
unsigned byteOffset,
unsigned byteLength) = 0;
virtual void send(PassRefPtr<BlobDataHandle>) = 0;
// For WorkerWebSocketChannel.
virtual void sendTextAsCharVector(std::unique_ptr<Vector<char>>) = 0;
virtual void sendBinaryAsCharVector(std::unique_ptr<Vector<char>>) = 0;
// Do not call |send| after calling this method.
virtual void close(int code, const String& reason) = 0;
// Log the reason text and close the connection. Will call didClose().
// The MessageLevel parameter will be used for the level of the message
// shown at the devtools console.
// SourceLocation parameter may be shown with the reason text
// at the devtools console. Even if location is specified, it may be ignored
// and the "current" location in the sense of JavaScript execution
// may be shown if this method is called in a JS execution context.
// Location should not be null.
virtual void fail(const String& reason,
MessageLevel,
std::unique_ptr<SourceLocation>) = 0;
// Do not call any methods after calling this method.
virtual void disconnect() = 0; // Will suppress didClose().
virtual ~WebSocketChannel() {}
DEFINE_INLINE_VIRTUAL_TRACE() {}
};
} // namespace blink
#endif // WebSocketChannel_h
|