git.sesse.net Git - casparcg/blob - dependencies64/cef/include/cef_process_message.h

   1 // Copyright (c) 2012 Marshall A. Greenblatt. All rights reserved.
   2 //
   3 // Redistribution and use in source and binary forms, with or without
   4 // modification, are permitted provided that the following conditions are
   5 // met:
   6 //
   7 //    * Redistributions of source code must retain the above copyright
   8 // notice, this list of conditions and the following disclaimer.
   9 //    * Redistributions in binary form must reproduce the above
  10 // copyright notice, this list of conditions and the following disclaimer
  11 // in the documentation and/or other materials provided with the
  12 // distribution.
  13 //    * Neither the name of Google Inc. nor the name Chromium Embedded
  14 // Framework nor the names of its contributors may be used to endorse
  15 // or promote products derived from this software without specific prior
  16 // 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 //
  32 // The contents of this file must follow a specific format in order to
  33 // support the CEF translator tool. See the translator.README.txt file in the
  34 // tools directory for more information.
  35 //
  36
  37 #ifndef CEF_INCLUDE_CEF_MESSAGE_H_
  38 #define CEF_INCLUDE_CEF_MESSAGE_H_
  39 #pragma once
  40
  41 #include "include/cef_base.h"
  42 #include "include/cef_values.h"
  43
  44 typedef cef_process_id_t CefProcessId;
  45
  46 ///
  47 // Class representing a message. Can be used on any process and thread.
  48 ///
  49 /*--cef(source=library)--*/
  50 class CefProcessMessage : public virtual CefBase {
  51  public:
  52   ///
  53   // Create a new CefProcessMessage object with the specified name.
  54   ///
  55   /*--cef()--*/
  56   static CefRefPtr<CefProcessMessage> Create(const CefString& name);
  57
  58   ///
  59   // Returns true if this object is valid. Do not call any other methods if this
  60   // function returns false.
  61   ///
  62   /*--cef()--*/
  63   virtual bool IsValid() =0;
  64
  65   ///
  66   // Returns true if the values of this object are read-only. Some APIs may
  67   // expose read-only objects.
  68   ///
  69   /*--cef()--*/
  70   virtual bool IsReadOnly() =0;
  71
  72   ///
  73   // Returns a writable copy of this object.
  74   ///
  75   /*--cef()--*/
  76   virtual CefRefPtr<CefProcessMessage> Copy() =0;
  77
  78   ///
  79   // Returns the message name.
  80   ///
  81   /*--cef()--*/
  82   virtual CefString GetName() =0;
  83
  84   ///
  85   // Returns the list of arguments.
  86   ///
  87   /*--cef()--*/
  88   virtual CefRefPtr<CefListValue> GetArgumentList() =0;
  89 };
  90
  91 #endif  // CEF_INCLUDE_CEF_MESSAGE_H_