summaryrefslogtreecommitdiffstats
path: root/webkit/api/public/WebSharedWorker.h
blob: a580882396ea7e627f94453f5509d9c8273fbd73 (plain)
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
/*
 * 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 WebSharedWorker_h
#define WebSharedWorker_h

#include "WebCommon.h"

namespace WebKit {
    class ScriptExecutionContext;
    class WebString;
    class WebMessagePortChannel;
    class WebCommonWorkerClient;
    class WebURL;

    // This is the interface to a SharedWorker thread.
    // Since SharedWorkers communicate entirely through MessagePorts this interface only contains APIs for starting up a SharedWorker.
    class WebSharedWorker {
    public:
        // Invoked from the worker thread to instantiate a WebSharedWorker that interacts with the WebKit worker components.
        WEBKIT_API static WebSharedWorker* create(WebCommonWorkerClient*);

        virtual ~WebSharedWorker() {};

        // Returns false if the thread hasn't been started yet (script loading has not taken place).
        // FIXME(atwilson): Remove this when we move the initial script loading into the worker process.
        virtual bool isStarted() = 0;

        virtual void startWorkerContext(const WebURL& scriptURL,
                                        const WebString& name,
                                        const WebString& userAgent,
                                        const WebString& sourceCode) = 0;

        // Sends a connect event to the SharedWorker context.
        virtual void connect(WebMessagePortChannel*) = 0;

        // Invoked to shutdown the worker when there are no more associated documents.
        virtual void terminateWorkerContext() = 0;

        // Notification when the WebCommonWorkerClient is destroyed.
        virtual void clientDestroyed() = 0;
    };
} // namespace WebKit

#endif