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 WebSharedWorker_h 32 #define WebSharedWorker_h 33 34 #include "WebCommon.h" 35 36 namespace WebCore { 37 class ScriptExecutionContext; 38 } 39 40 namespace WebKit { 41 42 class WebString; 43 class WebMessagePortChannel; 44 class WebCommonWorkerClient; 45 class WebURL; 46 47 // This is the interface to a SharedWorker thread. 48 // Since SharedWorkers communicate entirely through MessagePorts this interface only contains APIs for starting up a SharedWorker. 49 class WebSharedWorker { 50 public: 51 // Invoked from the worker thread to instantiate a WebSharedWorker that interacts with the WebKit worker components. 52 WEBKIT_API static WebSharedWorker* create(WebCommonWorkerClient*); 53 ~WebSharedWorker()54 virtual ~WebSharedWorker() {}; 55 56 // Returns false if the thread hasn't been started yet (script loading has not taken place). 57 // FIXME(atwilson): Remove this when we move the initial script loading into the worker process. 58 virtual bool isStarted() = 0; 59 60 virtual void startWorkerContext(const WebURL& scriptURL, 61 const WebString& name, 62 const WebString& userAgent, 63 const WebString& sourceCode, 64 long long scriptResourceAppCacheID) = 0; 65 66 class ConnectListener { 67 public: 68 // Invoked once the connect event has been sent so the caller can free this object. 69 virtual void connected() = 0; 70 }; 71 72 // Sends a connect event to the SharedWorker context. The listener is invoked when this async operation completes. 73 virtual void connect(WebMessagePortChannel*, ConnectListener*) = 0; 74 75 // Invoked to shutdown the worker when there are no more associated documents. 76 virtual void terminateWorkerContext() = 0; 77 78 // Notification when the WebCommonWorkerClient is destroyed. 79 virtual void clientDestroyed() = 0; 80 }; 81 82 } // namespace WebKit 83 84 #endif 85