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