src/third_party/libjingle/source/talk/p2p/base/transportdescriptionfactory.h

   1 /*
   2  * libjingle
   3  * Copyright 2012 Google Inc. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  *  1. Redistributions of source code must retain the above copyright notice,
   9  *     this list of conditions and the following disclaimer.
  10  *  2. Redistributions in binary form must reproduce the above copyright notice,
  11  *     this list of conditions and the following disclaimer in the documentation
  12  *     and/or other materials provided with the distribution.
  13  *  3. The name of the author may not be used to endorse or promote products
  14  *     derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
  19  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef WEBRTC_P2P_BASE_TRANSPORTDESCRIPTIONFACTORY_H_
  29 #define WEBRTC_P2P_BASE_TRANSPORTDESCRIPTIONFACTORY_H_
  30
  31 #include "webrtc/p2p/base/transportdescription.h"
  32
  33 namespace rtc {
  34 class SSLIdentity;
  35 }
  36
  37 namespace cricket {
  38
  39 struct TransportOptions {
  40   TransportOptions() : ice_restart(false), prefer_passive_role(false) {}
  41   bool ice_restart;
  42   bool prefer_passive_role;
  43 };
  44
  45 // Creates transport descriptions according to the supplied configuration.
  46 // When creating answers, performs the appropriate negotiation
  47 // of the various fields to determine the proper result.
  48 class TransportDescriptionFactory {
  49  public:
  50   // Default ctor; use methods below to set configuration.
  51   TransportDescriptionFactory();
  52   SecurePolicy secure() const { return secure_; }
  53   // The identity to use when setting up DTLS.
  54   rtc::SSLIdentity* identity() const { return identity_; }
  55
  56   // Specifies the transport protocol to be use.
  57   void set_protocol(TransportProtocol protocol) { protocol_ = protocol; }
  58   // Specifies the transport security policy to use.
  59   void set_secure(SecurePolicy s) { secure_ = s; }
  60   // Specifies the identity to use (only used when secure is not SEC_DISABLED).
  61   void set_identity(rtc::SSLIdentity* identity) { identity_ = identity; }
  62
  63   // Creates a transport description suitable for use in an offer.
  64   TransportDescription* CreateOffer(const TransportOptions& options,
  65       const TransportDescription* current_description) const;
  66   // Create a transport description that is a response to an offer.
  67   TransportDescription* CreateAnswer(
  68       const TransportDescription* offer,
  69       const TransportOptions& options,
  70       const TransportDescription* current_description) const;
  71
  72  private:
  73   bool SetSecurityInfo(TransportDescription* description,
  74                        ConnectionRole role) const;
  75
  76   TransportProtocol protocol_;
  77   SecurePolicy secure_;
  78   rtc::SSLIdentity* identity_;
  79 };
  80
  81 }  // namespace cricket
  82
  83 #endif  // WEBRTC_P2P_BASE_TRANSPORTDESCRIPTIONFACTORY_H_