src/third_party/WebKit/public/platform/WebRTCSessionDescription.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 WebRTCSessionDescription_h
  32 #define WebRTCSessionDescription_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 WebRTCSessionDescriptionPrivate;
  42
  43 //  In order to establish the media plane, PeerConnection needs specific
  44 //  parameters to indicate what to transmit to the remote side, as well
  45 //  as how to handle the media that is received. These parameters are
  46 //  determined by the exchange of session descriptions in offers and
  47 //  answers, and there are certain details to this process that must be
  48 //  handled in the JSEP APIs.
  49 //
  50 //  Whether a session description was sent or received affects the
  51 //  meaning of that description. For example, the list of codecs sent to
  52 //  a remote party indicates what the local side is willing to decode,
  53 //  and what the remote party should send.
  54
  55 class WebRTCSessionDescription {
  56 public:
  57     WebRTCSessionDescription() { }
  58     WebRTCSessionDescription(const WebRTCSessionDescription& other) { assign(other); }
  59     ~WebRTCSessionDescription() { reset(); }
  60
  61     WebRTCSessionDescription& operator=(const WebRTCSessionDescription& other)
  62     {
  63         assign(other);
  64         return *this;
  65     }
  66
  67     BLINK_PLATFORM_EXPORT void assign(const WebRTCSessionDescription&);
  68
  69     BLINK_PLATFORM_EXPORT void initialize(const WebString& type, const WebString& sdp);
  70     BLINK_PLATFORM_EXPORT void reset();
  71     bool isNull() const { return m_private.isNull(); }
  72
  73     BLINK_PLATFORM_EXPORT WebString type() const;
  74     BLINK_PLATFORM_EXPORT void setType(const WebString&);
  75     BLINK_PLATFORM_EXPORT WebString sdp() const;
  76     BLINK_PLATFORM_EXPORT void setSDP(const WebString&);
  77
  78 #if BLINK_IMPLEMENTATION
  79     WebRTCSessionDescription(WebString type, WebString sdp)
  80     {
  81         this->initialize(type, sdp);
  82     }
  83 #endif
  84
  85 private:
  86     WebPrivatePtr<WebRTCSessionDescriptionPrivate> m_private;
  87 };
  88
  89 } // namespace blink
  90
  91 #endif // WebRTCSessionDescription_h