WebCore/Worker.h

   1 /*
   2  * Copyright (C) 2008 Apple 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
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  *
  25  */
  26
  27 #ifndef Worker_h
  28 #define Worker_h
  29
  30 #if ENABLE(WORKERS)
  31
  32 #include "AtomicStringHash.h"
  33 #include "ActiveDOMObject.h"
  34 #include "CachedResourceClient.h"
  35 #include "CachedResourceHandle.h"
  36 #include "EventListener.h"
  37 #include "EventTarget.h"
  38 #include <wtf/PassRefPtr.h>
  39 #include <wtf/RefCounted.h>
  40 #include <wtf/RefPtr.h>
  41
  42 namespace WebCore {
  43
  44     class CachedResource;
  45     class CachedScript;
  46     class Document;
  47     class ScriptExecutionContext;
  48     class String;
  49     class WorkerMessagingProxy;
  50     class WorkerTask;
  51
  52     typedef int ExceptionCode;
  53
  54     class Worker : public RefCounted<Worker>, public ActiveDOMObject, private CachedResourceClient, public EventTarget {
  55     public:
  56         static PassRefPtr<Worker> create(const String& url, Document* document, ExceptionCode& ec) { return adoptRef(new Worker(url, document, ec)); }
  57         ~Worker();
  58
  59         virtual ScriptExecutionContext* scriptExecutionContext() const { return ActiveDOMObject::scriptExecutionContext(); }
  60         Document* document() const;
  61
  62         virtual Worker* toWorker() { return this; }
  63
  64         void postMessage(const String& message);
  65
  66         void terminate();
  67
  68         virtual bool canSuspend() const;
  69         virtual void stop();
  70         virtual bool hasPendingActivity() const;
  71
  72         virtual void addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture);
  73         virtual void removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture);
  74         virtual bool dispatchEvent(PassRefPtr<Event>, ExceptionCode&);
  75
  76         typedef Vector<RefPtr<EventListener> > ListenerVector;
  77         typedef HashMap<AtomicString, ListenerVector> EventListenersMap;
  78         EventListenersMap& eventListeners() { return m_eventListeners; }
  79
  80         using RefCounted<Worker>::ref;
  81         using RefCounted<Worker>::deref;
  82
  83         void setOnmessage(PassRefPtr<EventListener> eventListener) { m_onMessageListener = eventListener; }
  84         EventListener* onmessage() const { return m_onMessageListener.get(); }
  85
  86         void setOnerror(PassRefPtr<EventListener> eventListener) { m_onErrorListener = eventListener; }
  87         EventListener* onerror() const { return m_onErrorListener.get(); }
  88
  89     private:
  90         Worker(const String&, Document*, ExceptionCode&);
  91
  92         virtual void notifyFinished(CachedResource*);
  93
  94         void dispatchErrorEvent();
  95
  96         virtual void refEventTarget() { ref(); }
  97         virtual void derefEventTarget() { deref(); }
  98
  99         KURL m_scriptURL;
 100         CachedResourceHandle<CachedScript> m_cachedScript;
 101
 102         WorkerMessagingProxy* m_messagingProxy; // The proxy outlives the worker to perform thread shutdown.
 103
 104         RefPtr<EventListener> m_onMessageListener;
 105         RefPtr<EventListener> m_onErrorListener;
 106         EventListenersMap m_eventListeners;
 107     };
 108
 109 } // namespace WebCore
 110
 111 #endif // ENABLE(WORKERS)
 112
 113 #endif // Worker_h