third_party/WebKit/public/platform/WebMessagePortChannel.h

   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 WebMessagePortChannel_h
  32 #define WebMessagePortChannel_h
  33
  34 #include "WebCommon.h"
  35 #include "WebVector.h"
  36
  37 namespace blink {
  38
  39 class WebMessagePortChannelClient;
  40 class WebString;
  41
  42 typedef WebVector<class WebMessagePortChannel*> WebMessagePortChannelArray;
  43
  44 // Provides an interface to a Message Port Channel implementation. The object owns itself and
  45 // is signalled that its not needed anymore with the destroy() call.
  46 class WebMessagePortChannel {
  47 public:
  48     virtual void setClient(WebMessagePortChannelClient*) = 0;
  49     virtual void destroy() = 0;
  50     // Callee receives ownership of the passed vector.
  51     // FIXME: Blob refs should be passed to maintain ref counts. crbug.com/351753
  52     virtual void postMessage(const WebString&, WebMessagePortChannelArray*) = 0;
  53     virtual bool tryGetMessage(WebString*, WebMessagePortChannelArray&) = 0;
  54
  55 protected:
  56     ~WebMessagePortChannel() { }
  57 };
  58
  59 } // namespace blink
  60
  61 #if INSIDE_BLINK
  62
  63 namespace WTF {
  64
  65 template<typename T> struct OwnedPtrDeleter;
  66 template<> struct OwnedPtrDeleter<blink::WebMessagePortChannel> {
  67     static void deletePtr(blink::WebMessagePortChannel* channel)
  68     {
  69         if (channel)
  70             channel->destroy();
  71     }
  72 };
  73
  74 } // namespace WTF
  75
  76 #endif // INSIDE_BLINK
  77
  78 #endif // WebMessagePortChannel_h