public/platform/WebServiceWorker.h

/*
 * Copyright (C) 2013 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 WebServiceWorker_h
#define WebServiceWorker_h

#include "WebCommon.h"
#include "WebMessagePortChannel.h"
#include "WebServiceWorkerState.h"
#include "WebString.h"
#include "WebURL.h"
#include "WebVector.h"

namespace blink {

class WebServiceWorkerProxy;
typedef WebVector<class WebMessagePortChannel*> WebMessagePortChannelArray;

class WebServiceWorker {
public:
    virtual ~WebServiceWorker() { }

    // Sets ServiceWorkerProxy, with which callee can start making upcalls
    // to the ServiceWorker object via the client. This doesn't pass the
    // ownership to the callee, and the proxy's lifetime is same as that of
    // WebServiceWorker.
    virtual void setProxy(WebServiceWorkerProxy*) { }
    virtual WebServiceWorkerProxy* proxy() { return 0; }

    // Called by this worker's ServiceWorkerProxy when it has become ready or
    // not ready for state change notifications.
    virtual void proxyReadyChanged() { }

    virtual WebURL scope() const { return WebURL(); }
    virtual WebURL url() const { return WebURL(); }
    virtual WebServiceWorkerState state() const { return WebServiceWorkerStateUnknown; }

    // Callee receives ownership of the passed vector.
    // FIXME: Blob refs should be passed to maintain ref counts. crbug.com/351753
    virtual void postMessage(const WebString&, WebMessagePortChannelArray*) { BLINK_ASSERT_NOT_REACHED(); }
};

}

#endif // WebServiceWorker_h