RTCIceCandidatePairStats.nominated collected.

webrtc/p2p/base/port.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.
  */
 
@@ skipping 513 matching lines @@
   // side stops using it as well.
   bool pruned() const { return pruned_; }
   void Prune();
 
   bool use_candidate_attr() const { return use_candidate_attr_; }
   void set_use_candidate_attr(bool enable);
 
   void set_nomination(uint32_t value) { nomination_ = value; }
 
   uint32_t remote_nomination() const { return remote_nomination_; }
-  bool nominated() const { return remote_nomination_ > 0; }
+  bool nominated() const { return acked_nomination_ || remote_nomination_; }

[hbos, 2017/02/23 13:38:56]

According to https://tools.ietf.org/html/rfc5245#section-8 one or several pairs
may me nominated depending on if Regular or Aggressive Nomination is used.
Lacking background I'm having trouble understanding the RFC, or if we want a
controlling agent to be "nominated" if |acked_nomination_ > 0| or if
|nomination_ > 0| (before acked).

In my discussion with deadbeef we concluded to use |acked_nomination_|. I think
it makes sense to unify the stats' idea of "nominated" with
Connection::nominated(), which is currently only used for controlled agents, so
changing its meaning for controlling agents should be safe.

[Taylor Brandstetter, 2017/02/24 05:38:31]

webrtc-stats refers to the "nominated" flag from ICE, and ICE definitely says
the nominated flag is only updated on a binding response. So this seems correct.

Could you add a comment above "nominated()" in the code, summarizing this?

[hbos, 2017/02/24 11:09:13]

Done.

   // Public for unit tests.
   void set_remote_nomination(uint32_t remote_nomination) {
     remote_nomination_ = remote_nomination;
   }
   // Public for unit tests.
   uint32_t acked_nomination() const { return acked_nomination_; }
 
   void set_remote_ice_mode(IceMode mode) {
     remote_ice_mode_ = mode;
   }
@@ skipping 183 matching lines @@
            const rtc::PacketOptions& options) override;
   int GetError() override { return error_; }
 
  private:
   int error_ = 0;
 };
 
 }  // namespace cricket
 
 #endif  // WEBRTC_P2P_BASE_PORT_H_