third_party/WebKit/public/platform/WebMessagePortChannelClient.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 WebMessagePortChannelClient_h
  32 #define WebMessagePortChannelClient_h
  33
  34 #include "WebCommon.h"
  35 #include <v8.h>
  36
  37 namespace blink {
  38
  39 // Provides an interface for users of WebMessagePortChannel to be notified
  40 // when messages are available. This also gives users of WebMessagePortChannel
  41 // access to the V8 Context this message port lives in.
  42 class BLINK_PLATFORM_EXPORT WebMessagePortChannelClient {
  43 public:
  44     // Alerts that new messages have arrived, which are retrieved by calling
  45     // WebMessagePortChannel::tryGetMessage. Note that this may be called
  46     // on any thread.
  47     virtual void messageAvailable() = 0;
  48
  49     // Returns the V8 isolate this message port lives in.
  50     // Do not rely on this API, it is only exposed so content code can convert
  51     // messages to base::Value, and will be removed when this conversion can be
  52     // integrated into blink itself.
  53     virtual v8::Isolate* scriptIsolate() = 0;
  54
  55     // Returns a V8 context messages sent to this port can be (de)serialized in.
  56     // Can return null if no valid V8 context could be determined.
  57     // Do not rely on this API, it is only exposed so content code can convert
  58     // messages to base::Value, and will be removed when this conversion can be
  59     // integrated into blink itself.
  60     // FIXME: Remove this method when no longer needed (http://crbug.com/461906)
  61     virtual v8::Local<v8::Context> scriptContextForMessageConversion() = 0;
  62
  63 protected:
  64     ~WebMessagePortChannelClient() { }
  65 };
  66
  67 } // namespace blink
  68
  69 #endif