src/third_party/WebKit/public/web/WebServiceWorkerContextClient.h

   1 /*
   2  * Copyright (C) 2013 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 WebServiceWorkerContextClient_h
  32 #define WebServiceWorkerContextClient_h
  33
  34 #include "WebWorkerPermissionClientProxy.h"
  35
  36 namespace blink {
  37
  38 class WebString;
  39 class WebServiceWorkerContextProxy;
  40
  41 // This interface is implemented by the client. It is suppoed to be created
  42 // on the main thread and then passed on to the worker thread to be owned
  43 // by a newly created WorkerGlobalScope. All methods of this class, except
  44 // for workerContextFailedToStart(), are called on the worker thread.
  45 // FIXME: Split this into EmbeddedWorkerContextClient and
  46 // ServiceWorkerScriptContextClient when we decide to use EmbeddedWorker
  47 // framework for other implementation (like SharedWorker).
  48 class WebServiceWorkerContextClient {
  49 public:
  50     virtual ~WebServiceWorkerContextClient() { }
  51
  52     // A new WorkerGlobalScope is created and started to run on the
  53     // worker thread.
  54     // This also gives back a proxy to the client to talk to the
  55     // newly created WorkerGlobalScope. The proxy is held by WorkerGlobalScope
  56     // and should not be held by the caller. No proxy methods should be called
  57     // after workerContextDestroyed() is called.
  58     virtual void workerContextStarted(WebServiceWorkerContextProxy*) { }
  59
  60     // WorkerGlobalScope is destroyed. The client should clear the
  61     // WebServiceWorkerGlobalScopeProxy when this is called.
  62     virtual void workerContextDestroyed() { }
  63
  64     // Starting worker context is failed. This could happen when loading
  65     // worker script fails, or is asked to terminated before the context starts.
  66     // This is called on the main thread.
  67     virtual void workerContextFailedToStart() { }
  68
  69     // Called when the WorkerGlobalScope had an error or an exception.
  70     virtual void reportException(const WebString& errorMessage, int lineNumber, int columnNumber, const WebString& sourceURL) { }
  71
  72     // Inspector related messages.
  73     virtual void dispatchDevToolsMessage(const WebString&) { }
  74     virtual void saveDevToolsAgentState(const WebString&) { }
  75
  76     // ServiceWorker specific method. Called after InstallEvent (dispatched
  77     // via WebServiceWorkerContextProxy) is handled by the ServiceWorker's
  78     // script context.
  79     virtual void didHandleInstallEvent(int installEventID) { }
  80 };
  81
  82 } // namespace blink
  83
  84 #endif // WebWorkerContextClient_h