Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebCore / Modules / websockets / ThreadableWebSocketChannel.h
1 /*
2  * Copyright (C) 2009 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 #pragma once
32
33 #include <wtf/Forward.h>
34 #include <wtf/Noncopyable.h>
35
36 namespace JSC {
37 class ArrayBuffer;
38 }
39
40 namespace WebCore {
41
42 class Blob;
43 class ScriptExecutionContext;
44 class SocketProvider;
45 class WebSocketChannelClient;
46
47 class ThreadableWebSocketChannel {
48     WTF_MAKE_NONCOPYABLE(ThreadableWebSocketChannel);
49 public:
50     static Ref<ThreadableWebSocketChannel> create(ScriptExecutionContext&, WebSocketChannelClient&, SocketProvider&);
51     ThreadableWebSocketChannel() = default;
52
53     virtual bool isWebSocketChannel() const { return false; }
54
55     enum SendResult {
56         SendSuccess,
57         SendFail
58     };
59
60     virtual void connect(const URL&, const String& protocol) = 0;
61     virtual String subprotocol() = 0; // Will be available after didConnect() callback is invoked.
62     virtual String extensions() = 0; // Will be available after didConnect() callback is invoked.
63     virtual SendResult send(const String& message) = 0;
64     virtual SendResult send(const JSC::ArrayBuffer&, unsigned byteOffset, unsigned byteLength) = 0;
65     virtual SendResult send(Blob&) = 0;
66     virtual unsigned bufferedAmount() const = 0;
67     virtual void close(int code, const String& reason) = 0;
68     // Log the reason text and close the connection. Will call didClose().
69     virtual void fail(const String& reason) = 0;
70     virtual void disconnect() = 0; // Will suppress didClose().
71
72     virtual void suspend() = 0;
73     virtual void resume() = 0;
74
75     void ref() { refThreadableWebSocketChannel(); }
76     void deref() { derefThreadableWebSocketChannel(); }
77
78 protected:
79     virtual ~ThreadableWebSocketChannel() = default;
80     virtual void refThreadableWebSocketChannel() = 0;
81     virtual void derefThreadableWebSocketChannel() = 0;
82 };
83
84 } // namespace WebCore