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#ifndef ThreadableWebSocketChannel_h
32#define ThreadableWebSocketChannel_h
33
34#if ENABLE(WEB_SOCKETS)
35
36#include <wtf/Forward.h>
37#include <wtf/Noncopyable.h>
38#include <wtf/PassRefPtr.h>
39
40namespace WebCore {
41
42class KURL;
43class ScriptExecutionContext;
44class WebSocketChannelClient;
45
46class ThreadableWebSocketChannel {
47    WTF_MAKE_NONCOPYABLE(ThreadableWebSocketChannel);
48public:
49    ThreadableWebSocketChannel() { }
50    static PassRefPtr<ThreadableWebSocketChannel> create(ScriptExecutionContext*, WebSocketChannelClient*, const KURL&, const String& protocol);
51
52    virtual void connect() = 0;
53    virtual bool send(const String& message) = 0;
54    virtual unsigned long bufferedAmount() const = 0;
55    virtual void close() = 0;
56    virtual void disconnect() = 0; // Will suppress didClose().
57
58    virtual void suspend() = 0;
59    virtual void resume() = 0;
60
61    void ref() { refThreadableWebSocketChannel(); }
62    void deref() { derefThreadableWebSocketChannel(); }
63
64protected:
65    virtual ~ThreadableWebSocketChannel() { }
66    virtual void refThreadableWebSocketChannel() = 0;
67    virtual void derefThreadableWebSocketChannel() = 0;
68};
69
70} // namespace WebCore
71
72#endif // ENABLE(WEB_SOCKETS)
73
74#endif // ThreadableWebSocketChannel_h
75