Add 16-bit network id to the candidate signaling.

webrtc/p2p/base/candidate.h

 /*
  *  Copyright 2004 The WebRTC Project Authors. All rights reserved.
  *
  *  Use of this source code is governed by a BSD-style license
  *  that can be found in the LICENSE file in the root of the source
  *  tree. An additional intellectual property rights grant can be found
  *  in the file PATENTS.  All contributing project authors may
  *  be found in the AUTHORS file in the root of the source tree.
  */
 
 #ifndef WEBRTC_P2P_BASE_CANDIDATE_H_
 #define WEBRTC_P2P_BASE_CANDIDATE_H_
 
 #include <limits.h>
 #include <math.h>
 
 #include <algorithm>
 #include <iomanip>
 #include <sstream>
 #include <string>
 
 #include "webrtc/p2p/base/p2pconstants.h"
 #include "webrtc/base/basictypes.h"
 #include "webrtc/base/helpers.h"
 #include "webrtc/base/network.h"
 #include "webrtc/base/socketaddress.h"
 
 namespace cricket {
 
-const uint32_t kMaxNetworkCost = 999;
+const uint16_t kMaxNetworkCost = 999;
 
 // Candidate for ICE based connection discovery.
 
 class Candidate {
  public:
   // TODO: Match the ordering and param list as per RFC 5245
   // candidate-attribute syntax. http://tools.ietf.org/html/rfc5245#section-15.1
   Candidate()
       : id_(rtc::CreateRandomString(8)),
         component_(0),
         priority_(0),
         network_type_(rtc::ADAPTER_TYPE_UNKNOWN),
-        generation_(0) {}
+        generation_(0),
+        network_id_(0),
+        network_cost_(0) {}
 
   Candidate(int component,
             const std::string& protocol,
             const rtc::SocketAddress& address,
             uint32_t priority,
             const std::string& username,
             const std::string& password,
             const std::string& type,
             uint32_t generation,
-            const std::string& foundation)
+            const std::string& foundation,
+            uint16_t network_id = 0,
+            uint16_t network_cost = 0)
       : id_(rtc::CreateRandomString(8)),
         component_(component),
         protocol_(protocol),
         address_(address),
         priority_(priority),
         username_(username),
         password_(password),
         type_(type),
         network_type_(rtc::ADAPTER_TYPE_UNKNOWN),
         generation_(generation),
-        foundation_(foundation) {}
+        foundation_(foundation),
+        network_id_(network_id),
+        network_cost_(network_cost) {}
 
   const std::string & id() const { return id_; }
   void set_id(const std::string & id) { id_ = id; }
 
   int component() const { return component_; }
   void set_component(int component) { component_ = component; }
 
   const std::string & protocol() const { return protocol_; }
   void set_protocol(const std::string & protocol) { protocol_ = protocol; }
 
@@ skipping 61 matching lines @@
     return ost.str();
   }
   void set_generation_str(const std::string& str) {
     std::istringstream ist(str);
     ist >> generation_;
   }
 
   // |network_cost| measures the cost/penalty of using this candidate. A network
   // cost of 0 indicates this candidate can be used freely. A value of
   // |kMaxNetworkCost| indicates it should be used only as the last resort.
-  void set_network_cost(uint32_t network_cost) {
+  void set_network_cost(uint16_t network_cost) {
     ASSERT(network_cost <= kMaxNetworkCost);
     network_cost_ = network_cost;
   }
-  uint32_t network_cost() const { return network_cost_; }
+  uint16_t network_cost() const { return network_cost_; }
+
+  // An ID assigned to the network hosting the candidate.
+  uint16_t network_id() const { return network_id_; }
+  void set_network_id(uint16_t network_id) { network_id_ = network_id; }
 
   const std::string& foundation() const {
     return foundation_;
   }
 
   void set_foundation(const std::string& foundation) {
     foundation_ = foundation;
   }
 
   const rtc::SocketAddress & related_address() const {
@@ skipping 10 matching lines @@
 
   // The name of the transport channel of this candidate.
   const std::string& transport_name() const { return transport_name_; }
   void set_transport_name(const std::string& transport_name) {
     transport_name_ = transport_name;
   }
 
   // Determines whether this candidate is equivalent to the given one.
   bool IsEquivalent(const Candidate& c) const {
     // We ignore the network name, since that is just debug information, and
-    // the priority, since that should be the same if the rest is (and it's
-    // a float so equality checking is always worrisome).
+    // the priority and the network cost, since they should be the same if the
+    // rest are.
     return (component_ == c.component_) && (protocol_ == c.protocol_) &&
            (address_ == c.address_) && (username_ == c.username_) &&
            (password_ == c.password_) && (type_ == c.type_) &&
            (generation_ == c.generation_) && (foundation_ == c.foundation_) &&
-           (related_address_ == c.related_address_);
+           (related_address_ == c.related_address_) &&
+           (network_id_ == c.network_id_);
   }
 
   // Determines whether this candidate can be considered equivalent to the
   // given one when looking for a matching candidate to remove.
   bool MatchesForRemoval(const Candidate& c) const {
     return component_ == c.component_ && protocol_ == c.protocol_ &&
            address_ == c.address_;
   }
 
   std::string ToString() const {
@@ skipping 33 matching lines @@
   }
 
  private:
   std::string ToStringInternal(bool sensitive) const {
     std::ostringstream ost;
     std::string address = sensitive ? address_.ToSensitiveString() :
                                       address_.ToString();
     ost << "Cand[" << transport_name_ << ":" << foundation_ << ":" << component_
         << ":" << protocol_ << ":" << priority_ << ":" << address << ":"
         << type_ << ":" << related_address_ << ":" << username_ << ":"
-        << password_ << ":" << network_cost_ << "]";
+        << password_ << ":" << network_id_ << ":" << network_cost_ << "]";
     return ost.str();
   }
 
   std::string id_;
   int component_;
   std::string protocol_;
   std::string relay_protocol_;
   rtc::SocketAddress address_;
   uint32_t priority_;
   std::string username_;
   std::string password_;
   std::string type_;
   std::string network_name_;
   rtc::AdapterType network_type_;
   uint32_t generation_;
   std::string foundation_;
   rtc::SocketAddress related_address_;
   std::string tcptype_;
-  uint32_t network_cost_ = 0;
   std::string transport_name_;
+  uint16_t network_id_;
+  uint16_t network_cost_;
 };
 
 // Used during parsing and writing to map component to channel name
 // and back.  This is primarily for converting old G-ICE candidate
 // signalling to new ICE candidate classes.
 class CandidateTranslator {
  public:
   virtual ~CandidateTranslator() {}
   virtual bool GetChannelNameFromComponent(
       int component, std::string* channel_name) const = 0;
   virtual bool GetComponentFromChannelName(
       const std::string& channel_name, int* component) const = 0;
 };
 
 }  // namespace cricket
 
 #endif  // WEBRTC_P2P_BASE_CANDIDATE_H_