src/third_party/WebKit/public/platform/WebRTCVoidRequest.h

   1 /*
   2  * Copyright (C) 2012 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 WebRTCVoidRequest_h
  32 #define WebRTCVoidRequest_h
  33
  34 #include "WebCommon.h"
  35 #include "WebNonCopyable.h"
  36 #include "WebPrivatePtr.h"
  37 #include "WebString.h"
  38
  39 namespace blink {
  40
  41 class RTCVoidRequest;
  42
  43 class WebRTCVoidRequest {
  44 public:
  45     class ExtraData {
  46     public:
  47         virtual ~ExtraData() { }
  48     };
  49
  50     WebRTCVoidRequest() { }
  51     WebRTCVoidRequest(const WebRTCVoidRequest& other) { assign(other); }
  52     ~WebRTCVoidRequest() { reset(); }
  53
  54     WebRTCVoidRequest& operator=(const WebRTCVoidRequest& other)
  55     {
  56         assign(other);
  57         return *this;
  58     }
  59
  60     BLINK_PLATFORM_EXPORT void assign(const WebRTCVoidRequest&);
  61
  62     BLINK_PLATFORM_EXPORT void reset();
  63     bool isNull() const { return m_private.isNull(); }
  64
  65     BLINK_PLATFORM_EXPORT void requestSucceeded() const;
  66     BLINK_PLATFORM_EXPORT void requestFailed(const WebString& error) const;
  67
  68     // Extra data associated with this object.
  69     // If non-null, the extra data pointer will be deleted when the object is destroyed.
  70     // Setting the extra data pointer will cause any existing non-null
  71     // extra data pointer to be deleted.
  72     BLINK_PLATFORM_EXPORT ExtraData* extraData() const;
  73     BLINK_PLATFORM_EXPORT void setExtraData(ExtraData*);
  74
  75 #if INSIDE_BLINK
  76     BLINK_PLATFORM_EXPORT WebRTCVoidRequest(const WTF::PassRefPtr<RTCVoidRequest>&);
  77 #endif
  78
  79 private:
  80     WebPrivatePtr<RTCVoidRequest> m_private;
  81 };
  82
  83 } // namespace blink
  84
  85 #endif // WebRTCVoidRequest_h