git.sesse.net Git - casparcg/blob - dependencies64/cef/include/cef_response.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_RESPONSE_H_
  38 #define CEF_INCLUDE_CEF_RESPONSE_H_
  39 #pragma once
  40
  41 #include "include/cef_base.h"
  42 #include <map>
  43
  44 ///
  45 // Class used to represent a web response. The methods of this class may be
  46 // called on any thread.
  47 ///
  48 /*--cef(source=library,no_debugct_check)--*/
  49 class CefResponse : public virtual CefBase {
  50  public:
  51   typedef std::multimap<CefString, CefString> HeaderMap;
  52
  53   ///
  54   // Create a new CefResponse object.
  55   ///
  56   /*--cef()--*/
  57   static CefRefPtr<CefResponse> Create();
  58
  59   ///
  60   // Returns true if this object is read-only.
  61   ///
  62   /*--cef()--*/
  63   virtual bool IsReadOnly() =0;
  64
  65   ///
  66   // Get the response status code.
  67   ///
  68   /*--cef()--*/
  69   virtual int GetStatus() =0;
  70
  71   ///
  72   // Set the response status code.
  73   ///
  74   /*--cef()--*/
  75   virtual void SetStatus(int status) = 0;
  76
  77   ///
  78   // Get the response status text.
  79   ///
  80   /*--cef()--*/
  81   virtual CefString GetStatusText() =0;
  82
  83   ///
  84   // Set the response status text.
  85   ///
  86   /*--cef()--*/
  87   virtual void SetStatusText(const CefString& statusText) = 0;
  88
  89   ///
  90   // Get the response mime type.
  91   ///
  92   /*--cef()--*/
  93   virtual CefString GetMimeType() = 0;
  94
  95   ///
  96   // Set the response mime type.
  97   ///
  98   /*--cef()--*/
  99   virtual void SetMimeType(const CefString& mimeType) = 0;
 100
 101   ///
 102   // Get the value for the specified response header field.
 103   ///
 104   /*--cef()--*/
 105   virtual CefString GetHeader(const CefString& name) =0;
 106
 107   ///
 108   // Get all response header fields.
 109   ///
 110   /*--cef()--*/
 111   virtual void GetHeaderMap(HeaderMap& headerMap) =0;
 112
 113   ///
 114   // Set all response header fields.
 115   ///
 116   /*--cef()--*/
 117   virtual void SetHeaderMap(const HeaderMap& headerMap) =0;
 118 };
 119
 120 #endif  // CEF_INCLUDE_CEF_RESPONSE_H_