Upstream version 5.34.104.0
[platform/framework/web/crosswalk.git] / src / third_party / libjingle / source / talk / p2p / base / p2ptransportchannel.cc
1 /*
2  * libjingle
3  * Copyright 2004--2005, Google Inc.
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 #include "talk/p2p/base/p2ptransportchannel.h"
29
30 #include <set>
31 #include "talk/base/common.h"
32 #include "talk/base/crc32.h"
33 #include "talk/base/logging.h"
34 #include "talk/base/stringencode.h"
35 #include "talk/p2p/base/common.h"
36 #include "talk/p2p/base/relayport.h"  // For RELAY_PORT_TYPE.
37 #include "talk/p2p/base/stunport.h"  // For STUN_PORT_TYPE.
38
39 namespace {
40
41 // messages for queuing up work for ourselves
42 enum {
43   MSG_SORT = 1,
44   MSG_PING,
45 };
46
47 // When the socket is unwritable, we will use 10 Kbps (ignoring IP+UDP headers)
48 // for pinging.  When the socket is writable, we will use only 1 Kbps because
49 // we don't want to degrade the quality on a modem.  These numbers should work
50 // well on a 28.8K modem, which is the slowest connection on which the voice
51 // quality is reasonable at all.
52 static const uint32 PING_PACKET_SIZE = 60 * 8;
53 static const uint32 WRITABLE_DELAY = 1000 * PING_PACKET_SIZE / 1000;  // 480ms
54 static const uint32 UNWRITABLE_DELAY = 1000 * PING_PACKET_SIZE / 10000;  // 50ms
55
56 // If there is a current writable connection, then we will also try hard to
57 // make sure it is pinged at this rate.
58 static const uint32 MAX_CURRENT_WRITABLE_DELAY = 900;  // 2*WRITABLE_DELAY - bit
59
60 // The minimum improvement in RTT that justifies a switch.
61 static const double kMinImprovement = 10;
62
63 cricket::PortInterface::CandidateOrigin GetOrigin(cricket::PortInterface* port,
64                                          cricket::PortInterface* origin_port) {
65   if (!origin_port)
66     return cricket::PortInterface::ORIGIN_MESSAGE;
67   else if (port == origin_port)
68     return cricket::PortInterface::ORIGIN_THIS_PORT;
69   else
70     return cricket::PortInterface::ORIGIN_OTHER_PORT;
71 }
72
73 // Compares two connections based only on static information about them.
74 int CompareConnectionCandidates(cricket::Connection* a,
75                                 cricket::Connection* b) {
76   // Compare connection priority. Lower values get sorted last.
77   if (a->priority() > b->priority())
78     return 1;
79   if (a->priority() < b->priority())
80     return -1;
81
82   // If we're still tied at this point, prefer a younger generation.
83   return (a->remote_candidate().generation() + a->port()->generation()) -
84          (b->remote_candidate().generation() + b->port()->generation());
85 }
86
87 // Compare two connections based on their writability and static preferences.
88 int CompareConnections(cricket::Connection *a, cricket::Connection *b) {
89   // Sort based on write-state.  Better states have lower values.
90   if (a->write_state() < b->write_state())
91     return 1;
92   if (a->write_state() > b->write_state())
93     return -1;
94
95   // Compare the candidate information.
96   return CompareConnectionCandidates(a, b);
97 }
98
99 // Wraps the comparison connection into a less than operator that puts higher
100 // priority writable connections first.
101 class ConnectionCompare {
102  public:
103   bool operator()(const cricket::Connection *ca,
104                   const cricket::Connection *cb) {
105     cricket::Connection* a = const_cast<cricket::Connection*>(ca);
106     cricket::Connection* b = const_cast<cricket::Connection*>(cb);
107
108     ASSERT(a->port()->IceProtocol() == b->port()->IceProtocol());
109
110     // Compare first on writability and static preferences.
111     int cmp = CompareConnections(a, b);
112     if (cmp > 0)
113       return true;
114     if (cmp < 0)
115       return false;
116
117     // Otherwise, sort based on latency estimate.
118     return a->rtt() < b->rtt();
119
120     // Should we bother checking for the last connection that last received
121     // data? It would help rendezvous on the connection that is also receiving
122     // packets.
123     //
124     // TODO: Yes we should definitely do this.  The TCP protocol gains
125     // efficiency by being used bidirectionally, as opposed to two separate
126     // unidirectional streams.  This test should probably occur before
127     // comparison of local prefs (assuming combined prefs are the same).  We
128     // need to be careful though, not to bounce back and forth with both sides
129     // trying to rendevous with the other.
130   }
131 };
132
133 // Determines whether we should switch between two connections, based first on
134 // static preferences and then (if those are equal) on latency estimates.
135 bool ShouldSwitch(cricket::Connection* a_conn, cricket::Connection* b_conn) {
136   if (a_conn == b_conn)
137     return false;
138
139   if (!a_conn || !b_conn)  // don't think the latter should happen
140     return true;
141
142   int prefs_cmp = CompareConnections(a_conn, b_conn);
143   if (prefs_cmp < 0)
144     return true;
145   if (prefs_cmp > 0)
146     return false;
147
148   return b_conn->rtt() <= a_conn->rtt() + kMinImprovement;
149 }
150
151 }  // unnamed namespace
152
153 namespace cricket {
154
155 P2PTransportChannel::P2PTransportChannel(const std::string& content_name,
156                                          int component,
157                                          P2PTransport* transport,
158                                          PortAllocator *allocator) :
159     TransportChannelImpl(content_name, component),
160     transport_(transport),
161     allocator_(allocator),
162     worker_thread_(talk_base::Thread::Current()),
163     incoming_only_(false),
164     waiting_for_signaling_(false),
165     error_(0),
166     best_connection_(NULL),
167     pending_best_connection_(NULL),
168     sort_dirty_(false),
169     was_writable_(false),
170     protocol_type_(ICEPROTO_HYBRID),
171     remote_ice_mode_(ICEMODE_FULL),
172     ice_role_(ICEROLE_UNKNOWN),
173     tiebreaker_(0),
174     remote_candidate_generation_(0) {
175 }
176
177 P2PTransportChannel::~P2PTransportChannel() {
178   ASSERT(worker_thread_ == talk_base::Thread::Current());
179
180   for (uint32 i = 0; i < allocator_sessions_.size(); ++i)
181     delete allocator_sessions_[i];
182 }
183
184 // Add the allocator session to our list so that we know which sessions
185 // are still active.
186 void P2PTransportChannel::AddAllocatorSession(PortAllocatorSession* session) {
187   session->set_generation(static_cast<uint32>(allocator_sessions_.size()));
188   allocator_sessions_.push_back(session);
189
190   // We now only want to apply new candidates that we receive to the ports
191   // created by this new session because these are replacing those of the
192   // previous sessions.
193   ports_.clear();
194
195   session->SignalPortReady.connect(this, &P2PTransportChannel::OnPortReady);
196   session->SignalCandidatesReady.connect(
197       this, &P2PTransportChannel::OnCandidatesReady);
198   session->SignalCandidatesAllocationDone.connect(
199       this, &P2PTransportChannel::OnCandidatesAllocationDone);
200   session->StartGettingPorts();
201 }
202
203 void P2PTransportChannel::AddConnection(Connection* connection) {
204   connections_.push_back(connection);
205   connection->set_remote_ice_mode(remote_ice_mode_);
206   connection->SignalReadPacket.connect(
207       this, &P2PTransportChannel::OnReadPacket);
208   connection->SignalReadyToSend.connect(
209       this, &P2PTransportChannel::OnReadyToSend);
210   connection->SignalStateChange.connect(
211       this, &P2PTransportChannel::OnConnectionStateChange);
212   connection->SignalDestroyed.connect(
213       this, &P2PTransportChannel::OnConnectionDestroyed);
214   connection->SignalUseCandidate.connect(
215       this, &P2PTransportChannel::OnUseCandidate);
216 }
217
218 void P2PTransportChannel::SetIceRole(IceRole ice_role) {
219   ASSERT(worker_thread_ == talk_base::Thread::Current());
220   if (ice_role_ != ice_role) {
221     ice_role_ = ice_role;
222     for (std::vector<PortInterface *>::iterator it = ports_.begin();
223          it != ports_.end(); ++it) {
224       (*it)->SetIceRole(ice_role);
225     }
226   }
227 }
228
229 void P2PTransportChannel::SetIceTiebreaker(uint64 tiebreaker) {
230   ASSERT(worker_thread_ == talk_base::Thread::Current());
231   if (!ports_.empty()) {
232     LOG(LS_ERROR)
233         << "Attempt to change tiebreaker after Port has been allocated.";
234     return;
235   }
236
237   tiebreaker_ = tiebreaker;
238 }
239
240 bool P2PTransportChannel::GetIceProtocolType(IceProtocolType* type) const {
241   *type = protocol_type_;
242   return true;
243 }
244
245 void P2PTransportChannel::SetIceProtocolType(IceProtocolType type) {
246   ASSERT(worker_thread_ == talk_base::Thread::Current());
247
248   protocol_type_ = type;
249   for (std::vector<PortInterface *>::iterator it = ports_.begin();
250        it != ports_.end(); ++it) {
251     (*it)->SetIceProtocolType(protocol_type_);
252   }
253 }
254
255 void P2PTransportChannel::SetIceCredentials(const std::string& ice_ufrag,
256                                             const std::string& ice_pwd) {
257   ASSERT(worker_thread_ == talk_base::Thread::Current());
258   bool ice_restart = false;
259   if (!ice_ufrag_.empty() && !ice_pwd_.empty()) {
260     // Restart candidate allocation if there is any change in either
261     // ice ufrag or password.
262     ice_restart = (ice_ufrag_ != ice_ufrag) || (ice_pwd_!= ice_pwd);
263   }
264
265   ice_ufrag_ = ice_ufrag;
266   ice_pwd_ = ice_pwd;
267
268   if (ice_restart) {
269     // Restart candidate gathering.
270     Allocate();
271   }
272 }
273
274 void P2PTransportChannel::SetRemoteIceCredentials(const std::string& ice_ufrag,
275                                                   const std::string& ice_pwd) {
276   ASSERT(worker_thread_ == talk_base::Thread::Current());
277   bool ice_restart = false;
278   if (!remote_ice_ufrag_.empty() && !remote_ice_pwd_.empty()) {
279     ice_restart = (remote_ice_ufrag_ != ice_ufrag) ||
280                   (remote_ice_pwd_!= ice_pwd);
281   }
282
283   remote_ice_ufrag_ = ice_ufrag;
284   remote_ice_pwd_ = ice_pwd;
285
286   if (ice_restart) {
287     // |candidate.generation()| is not signaled in ICEPROTO_RFC5245.
288     // Therefore we need to keep track of the remote ice restart so
289     // newer connections are prioritized over the older.
290     ++remote_candidate_generation_;
291   }
292 }
293
294 void P2PTransportChannel::SetRemoteIceMode(IceMode mode) {
295   remote_ice_mode_ = mode;
296 }
297
298 // Go into the state of processing candidates, and running in general
299 void P2PTransportChannel::Connect() {
300   ASSERT(worker_thread_ == talk_base::Thread::Current());
301   if (ice_ufrag_.empty() || ice_pwd_.empty()) {
302     ASSERT(false);
303     LOG(LS_ERROR) << "P2PTransportChannel::Connect: The ice_ufrag_ and the "
304                   << "ice_pwd_ are not set.";
305     return;
306   }
307
308   // Kick off an allocator session
309   Allocate();
310
311   // Start pinging as the ports come in.
312   thread()->Post(this, MSG_PING);
313 }
314
315 // Reset the socket, clear up any previous allocations and start over
316 void P2PTransportChannel::Reset() {
317   ASSERT(worker_thread_ == talk_base::Thread::Current());
318
319   // Get rid of all the old allocators.  This should clean up everything.
320   for (uint32 i = 0; i < allocator_sessions_.size(); ++i)
321     delete allocator_sessions_[i];
322
323   allocator_sessions_.clear();
324   ports_.clear();
325   connections_.clear();
326   best_connection_ = NULL;
327
328   // Forget about all of the candidates we got before.
329   remote_candidates_.clear();
330
331   // Revert to the initial state.
332   set_readable(false);
333   set_writable(false);
334
335   // Reinitialize the rest of our state.
336   waiting_for_signaling_ = false;
337   sort_dirty_ = false;
338
339   // If we allocated before, start a new one now.
340   if (transport_->connect_requested())
341     Allocate();
342
343   // Start pinging as the ports come in.
344   thread()->Clear(this);
345   thread()->Post(this, MSG_PING);
346 }
347
348 // A new port is available, attempt to make connections for it
349 void P2PTransportChannel::OnPortReady(PortAllocatorSession *session,
350                                       PortInterface* port) {
351   ASSERT(worker_thread_ == talk_base::Thread::Current());
352
353   // Set in-effect options on the new port
354   for (OptionMap::const_iterator it = options_.begin();
355        it != options_.end();
356        ++it) {
357     int val = port->SetOption(it->first, it->second);
358     if (val < 0) {
359       LOG_J(LS_WARNING, port) << "SetOption(" << it->first
360                               << ", " << it->second
361                               << ") failed: " << port->GetError();
362     }
363   }
364
365   // Remember the ports and candidates, and signal that candidates are ready.
366   // The session will handle this, and send an initiate/accept/modify message
367   // if one is pending.
368
369   port->SetIceProtocolType(protocol_type_);
370   port->SetIceRole(ice_role_);
371   port->SetIceTiebreaker(tiebreaker_);
372   ports_.push_back(port);
373   port->SignalUnknownAddress.connect(
374       this, &P2PTransportChannel::OnUnknownAddress);
375   port->SignalDestroyed.connect(this, &P2PTransportChannel::OnPortDestroyed);
376   port->SignalRoleConflict.connect(
377       this, &P2PTransportChannel::OnRoleConflict);
378
379   // Attempt to create a connection from this new port to all of the remote
380   // candidates that we were given so far.
381
382   std::vector<RemoteCandidate>::iterator iter;
383   for (iter = remote_candidates_.begin(); iter != remote_candidates_.end();
384        ++iter) {
385     CreateConnection(port, *iter, iter->origin_port(), false);
386   }
387
388   SortConnections();
389 }
390
391 // A new candidate is available, let listeners know
392 void P2PTransportChannel::OnCandidatesReady(
393     PortAllocatorSession *session, const std::vector<Candidate>& candidates) {
394   ASSERT(worker_thread_ == talk_base::Thread::Current());
395   for (size_t i = 0; i < candidates.size(); ++i) {
396     SignalCandidateReady(this, candidates[i]);
397   }
398 }
399
400 void P2PTransportChannel::OnCandidatesAllocationDone(
401     PortAllocatorSession* session) {
402   ASSERT(worker_thread_ == talk_base::Thread::Current());
403   SignalCandidatesAllocationDone(this);
404 }
405
406 // Handle stun packets
407 void P2PTransportChannel::OnUnknownAddress(
408     PortInterface* port,
409     const talk_base::SocketAddress& address, ProtocolType proto,
410     IceMessage* stun_msg, const std::string &remote_username,
411     bool port_muxed) {
412   ASSERT(worker_thread_ == talk_base::Thread::Current());
413
414   // Port has received a valid stun packet from an address that no Connection
415   // is currently available for. See if we already have a candidate with the
416   // address. If it isn't we need to create new candidate for it.
417
418   // Determine if the remote candidates use shared ufrag.
419   bool ufrag_per_port = false;
420   std::vector<RemoteCandidate>::iterator it;
421   if (remote_candidates_.size() > 0) {
422     it = remote_candidates_.begin();
423     std::string username = it->username();
424     for (; it != remote_candidates_.end(); ++it) {
425       if (it->username() != username) {
426         ufrag_per_port = true;
427         break;
428       }
429     }
430   }
431
432   const Candidate* candidate = NULL;
433   bool known_username = false;
434   std::string remote_password;
435   for (it = remote_candidates_.begin(); it != remote_candidates_.end(); ++it) {
436     if (it->username() == remote_username) {
437       remote_password = it->password();
438       known_username = true;
439       if (ufrag_per_port ||
440           (it->address() == address &&
441            it->protocol() == ProtoToString(proto))) {
442         candidate = &(*it);
443         break;
444       }
445       // We don't want to break here because we may find a match of the address
446       // later.
447     }
448   }
449
450   if (!known_username) {
451     if (port_muxed) {
452       // When Ports are muxed, SignalUnknownAddress is delivered to all
453       // P2PTransportChannel belong to a session. Return from here will
454       // save us from sending stun binding error message from incorrect channel.
455       return;
456     }
457     // Don't know about this username, the request is bogus
458     // This sometimes happens if a binding response comes in before the ACCEPT
459     // message.  It is totally valid; the retry state machine will try again.
460     port->SendBindingErrorResponse(stun_msg, address,
461         STUN_ERROR_STALE_CREDENTIALS, STUN_ERROR_REASON_STALE_CREDENTIALS);
462     return;
463   }
464
465   Candidate new_remote_candidate;
466   if (candidate != NULL) {
467     new_remote_candidate = *candidate;
468     if (ufrag_per_port) {
469       new_remote_candidate.set_address(address);
470     }
471   } else {
472     // Create a new candidate with this address.
473
474     std::string type;
475     if (port->IceProtocol() == ICEPROTO_RFC5245) {
476       type = PRFLX_PORT_TYPE;
477     } else {
478       // G-ICE doesn't support prflx candidate.
479       // We set candidate type to STUN_PORT_TYPE if the binding request comes
480       // from a relay port or the shared socket is used. Otherwise we use the
481       // port's type as the candidate type.
482       if (port->Type() == RELAY_PORT_TYPE || port->SharedSocket()) {
483         type = STUN_PORT_TYPE;
484       } else {
485         type = port->Type();
486       }
487     }
488
489     std::string id = talk_base::CreateRandomString(8);
490     new_remote_candidate = Candidate(
491         id, component(), ProtoToString(proto), address,
492         0, remote_username, remote_password, type,
493         port->Network()->name(), 0U,
494         talk_base::ToString<uint32>(talk_base::ComputeCrc32(id)));
495     new_remote_candidate.set_priority(
496         new_remote_candidate.GetPriority(ICE_TYPE_PREFERENCE_SRFLX,
497                                          port->Network()->preference()));
498   }
499
500   if (port->IceProtocol() == ICEPROTO_RFC5245) {
501     // RFC 5245
502     // If the source transport address of the request does not match any
503     // existing remote candidates, it represents a new peer reflexive remote
504     // candidate.
505
506     // The priority of the candidate is set to the PRIORITY attribute
507     // from the request.
508     const StunUInt32Attribute* priority_attr =
509         stun_msg->GetUInt32(STUN_ATTR_PRIORITY);
510     if (!priority_attr) {
511       LOG(LS_WARNING) << "P2PTransportChannel::OnUnknownAddress - "
512                       << "No STUN_ATTR_PRIORITY found in the "
513                       << "stun request message";
514       port->SendBindingErrorResponse(stun_msg, address,
515                                      STUN_ERROR_BAD_REQUEST,
516                                      STUN_ERROR_REASON_BAD_REQUEST);
517       return;
518     }
519     new_remote_candidate.set_priority(priority_attr->value());
520
521     // RFC5245, the agent constructs a pair whose local candidate is equal to
522     // the transport address on which the STUN request was received, and a
523     // remote candidate equal to the source transport address where the
524     // request came from.
525
526     // There shouldn't be an existing connection with this remote address.
527     // When ports are muxed, this channel might get multiple unknown address
528     // signals. In that case if the connection is already exists, we should
529     // simply ignore the signal othewise send server error.
530     if (port->GetConnection(new_remote_candidate.address())) {
531       if (port_muxed) {
532         LOG(LS_INFO) << "Connection already exists for peer reflexive "
533                      << "candidate: " << new_remote_candidate.ToString();
534         return;
535       } else {
536         ASSERT(false);
537         port->SendBindingErrorResponse(stun_msg, address,
538                                        STUN_ERROR_SERVER_ERROR,
539                                        STUN_ERROR_REASON_SERVER_ERROR);
540         return;
541       }
542     }
543
544     Connection* connection = port->CreateConnection(
545         new_remote_candidate, cricket::PortInterface::ORIGIN_THIS_PORT);
546     if (!connection) {
547       ASSERT(false);
548       port->SendBindingErrorResponse(stun_msg, address,
549                                      STUN_ERROR_SERVER_ERROR,
550                                      STUN_ERROR_REASON_SERVER_ERROR);
551       return;
552     }
553
554     AddConnection(connection);
555     connection->ReceivedPing();
556
557     // Send the pinger a successful stun response.
558     port->SendBindingResponse(stun_msg, address);
559
560     // Update the list of connections since we just added another.  We do this
561     // after sending the response since it could (in principle) delete the
562     // connection in question.
563     SortConnections();
564   } else {
565     // Check for connectivity to this address. Create connections
566     // to this address across all local ports. First, add this as a new remote
567     // address
568     if (!CreateConnections(new_remote_candidate, port, true)) {
569       // Hopefully this won't occur, because changing a destination address
570       // shouldn't cause a new connection to fail
571       ASSERT(false);
572       port->SendBindingErrorResponse(stun_msg, address, STUN_ERROR_SERVER_ERROR,
573           STUN_ERROR_REASON_SERVER_ERROR);
574       return;
575     }
576
577     // Send the pinger a successful stun response.
578     port->SendBindingResponse(stun_msg, address);
579
580     // Update the list of connections since we just added another.  We do this
581     // after sending the response since it could (in principle) delete the
582     // connection in question.
583     SortConnections();
584   }
585 }
586
587 void P2PTransportChannel::OnRoleConflict(PortInterface* port) {
588   SignalRoleConflict(this);  // STUN ping will be sent when SetRole is called
589                              // from Transport.
590 }
591
592 // When the signalling channel is ready, we can really kick off the allocator
593 void P2PTransportChannel::OnSignalingReady() {
594   ASSERT(worker_thread_ == talk_base::Thread::Current());
595   if (waiting_for_signaling_) {
596     waiting_for_signaling_ = false;
597     AddAllocatorSession(allocator_->CreateSession(
598         SessionId(), content_name(), component(), ice_ufrag_, ice_pwd_));
599   }
600 }
601
602 void P2PTransportChannel::OnUseCandidate(Connection* conn) {
603   ASSERT(worker_thread_ == talk_base::Thread::Current());
604   ASSERT(ice_role_ == ICEROLE_CONTROLLED);
605   ASSERT(protocol_type_ == ICEPROTO_RFC5245);
606   if (conn->write_state() == Connection::STATE_WRITABLE) {
607     if (best_connection_ != conn) {
608       pending_best_connection_ = NULL;
609       SwitchBestConnectionTo(conn);
610       // Now we have selected the best connection, time to prune other existing
611       // connections and update the read/write state of the channel.
612       RequestSort();
613     }
614   } else {
615     pending_best_connection_ = conn;
616   }
617 }
618
619 void P2PTransportChannel::OnCandidate(const Candidate& candidate) {
620   ASSERT(worker_thread_ == talk_base::Thread::Current());
621
622   // Create connections to this remote candidate.
623   CreateConnections(candidate, NULL, false);
624
625   // Resort the connections list, which may have new elements.
626   SortConnections();
627 }
628
629 // Creates connections from all of the ports that we care about to the given
630 // remote candidate.  The return value is true if we created a connection from
631 // the origin port.
632 bool P2PTransportChannel::CreateConnections(const Candidate &remote_candidate,
633                                             PortInterface* origin_port,
634                                             bool readable) {
635   ASSERT(worker_thread_ == talk_base::Thread::Current());
636
637   Candidate new_remote_candidate(remote_candidate);
638   new_remote_candidate.set_generation(
639       GetRemoteCandidateGeneration(remote_candidate));
640   // ICE candidates don't need to have username and password set, but
641   // the code below this (specifically, ConnectionRequest::Prepare in
642   // port.cc) uses the remote candidates's username.  So, we set it
643   // here.
644   if (remote_candidate.username().empty()) {
645     new_remote_candidate.set_username(remote_ice_ufrag_);
646   }
647   if (remote_candidate.password().empty()) {
648     new_remote_candidate.set_password(remote_ice_pwd_);
649   }
650
651   // Add a new connection for this candidate to every port that allows such a
652   // connection (i.e., if they have compatible protocols) and that does not
653   // already have a connection to an equivalent candidate.  We must be careful
654   // to make sure that the origin port is included, even if it was pruned,
655   // since that may be the only port that can create this connection.
656
657   bool created = false;
658
659   std::vector<PortInterface *>::reverse_iterator it;
660   for (it = ports_.rbegin(); it != ports_.rend(); ++it) {
661     if (CreateConnection(*it, new_remote_candidate, origin_port, readable)) {
662       if (*it == origin_port)
663         created = true;
664     }
665   }
666
667   if ((origin_port != NULL) &&
668       std::find(ports_.begin(), ports_.end(), origin_port) == ports_.end()) {
669     if (CreateConnection(
670         origin_port, new_remote_candidate, origin_port, readable))
671       created = true;
672   }
673
674   // Remember this remote candidate so that we can add it to future ports.
675   RememberRemoteCandidate(new_remote_candidate, origin_port);
676
677   return created;
678 }
679
680 // Setup a connection object for the local and remote candidate combination.
681 // And then listen to connection object for changes.
682 bool P2PTransportChannel::CreateConnection(PortInterface* port,
683                                            const Candidate& remote_candidate,
684                                            PortInterface* origin_port,
685                                            bool readable) {
686   // Look for an existing connection with this remote address.  If one is not
687   // found, then we can create a new connection for this address.
688   Connection* connection = port->GetConnection(remote_candidate.address());
689   if (connection != NULL) {
690     // It is not legal to try to change any of the parameters of an existing
691     // connection; however, the other side can send a duplicate candidate.
692     if (!remote_candidate.IsEquivalent(connection->remote_candidate())) {
693       LOG(INFO) << "Attempt to change a remote candidate";
694       return false;
695     }
696   } else {
697     PortInterface::CandidateOrigin origin = GetOrigin(port, origin_port);
698
699     // Don't create connection if this is a candidate we received in a
700     // message and we are not allowed to make outgoing connections.
701     if (origin == cricket::PortInterface::ORIGIN_MESSAGE && incoming_only_)
702       return false;
703
704     connection = port->CreateConnection(remote_candidate, origin);
705     if (!connection)
706       return false;
707
708     AddConnection(connection);
709
710     LOG_J(LS_INFO, this) << "Created connection with origin=" << origin << ", ("
711                          << connections_.size() << " total)";
712   }
713
714   // If we are readable, it is because we are creating this in response to a
715   // ping from the other side.  This will cause the state to become readable.
716   if (readable)
717     connection->ReceivedPing();
718
719   return true;
720 }
721
722 bool P2PTransportChannel::FindConnection(
723     cricket::Connection* connection) const {
724   std::vector<Connection*>::const_iterator citer =
725       std::find(connections_.begin(), connections_.end(), connection);
726   return citer != connections_.end();
727 }
728
729 uint32 P2PTransportChannel::GetRemoteCandidateGeneration(
730     const Candidate& candidate) {
731   if (protocol_type_ == ICEPROTO_GOOGLE) {
732     // The Candidate.generation() can be trusted. Nothing needs to be done.
733     return candidate.generation();
734   }
735   // |candidate.generation()| is not signaled in ICEPROTO_RFC5245.
736   // Therefore we need to keep track of the remote ice restart so
737   // newer connections are prioritized over the older.
738   ASSERT(candidate.generation() == 0 ||
739          candidate.generation() == remote_candidate_generation_);
740   return remote_candidate_generation_;
741 }
742
743 // Maintain our remote candidate list, adding this new remote one.
744 void P2PTransportChannel::RememberRemoteCandidate(
745     const Candidate& remote_candidate, PortInterface* origin_port) {
746   // Remove any candidates whose generation is older than this one.  The
747   // presence of a new generation indicates that the old ones are not useful.
748   uint32 i = 0;
749   while (i < remote_candidates_.size()) {
750     if (remote_candidates_[i].generation() < remote_candidate.generation()) {
751       LOG(INFO) << "Pruning candidate from old generation: "
752                 << remote_candidates_[i].address().ToSensitiveString();
753       remote_candidates_.erase(remote_candidates_.begin() + i);
754     } else {
755       i += 1;
756     }
757   }
758
759   // Make sure this candidate is not a duplicate.
760   for (uint32 i = 0; i < remote_candidates_.size(); ++i) {
761     if (remote_candidates_[i].IsEquivalent(remote_candidate)) {
762       LOG(INFO) << "Duplicate candidate: "
763                 << remote_candidate.address().ToSensitiveString();
764       return;
765     }
766   }
767
768   // Try this candidate for all future ports.
769   remote_candidates_.push_back(RemoteCandidate(remote_candidate, origin_port));
770 }
771
772 // Set options on ourselves is simply setting options on all of our available
773 // port objects.
774 int P2PTransportChannel::SetOption(talk_base::Socket::Option opt, int value) {
775   OptionMap::iterator it = options_.find(opt);
776   if (it == options_.end()) {
777     options_.insert(std::make_pair(opt, value));
778   } else if (it->second == value) {
779     return 0;
780   } else {
781     it->second = value;
782   }
783
784   for (uint32 i = 0; i < ports_.size(); ++i) {
785     int val = ports_[i]->SetOption(opt, value);
786     if (val < 0) {
787       // Because this also occurs deferred, probably no point in reporting an
788       // error
789       LOG(WARNING) << "SetOption(" << opt << ", " << value << ") failed: "
790                    << ports_[i]->GetError();
791     }
792   }
793   return 0;
794 }
795
796 // Send data to the other side, using our best connection.
797 int P2PTransportChannel::SendPacket(const char *data, size_t len,
798                                     const talk_base::PacketOptions& options,
799                                     int flags) {
800   ASSERT(worker_thread_ == talk_base::Thread::Current());
801   if (flags != 0) {
802     error_ = EINVAL;
803     return -1;
804   }
805   if (best_connection_ == NULL) {
806     error_ = EWOULDBLOCK;
807     return -1;
808   }
809
810   int sent = best_connection_->Send(data, len, options);
811   if (sent <= 0) {
812     ASSERT(sent < 0);
813     error_ = best_connection_->GetError();
814   }
815   return sent;
816 }
817
818 bool P2PTransportChannel::GetStats(ConnectionInfos *infos) {
819   ASSERT(worker_thread_ == talk_base::Thread::Current());
820   // Gather connection infos.
821   infos->clear();
822
823   std::vector<Connection *>::const_iterator it;
824   for (it = connections_.begin(); it != connections_.end(); ++it) {
825     Connection *connection = *it;
826     ConnectionInfo info;
827     info.best_connection = (best_connection_ == connection);
828     info.readable =
829         (connection->read_state() == Connection::STATE_READABLE);
830     info.writable =
831         (connection->write_state() == Connection::STATE_WRITABLE);
832     info.timeout =
833         (connection->write_state() == Connection::STATE_WRITE_TIMEOUT);
834     info.new_connection = !connection->reported();
835     connection->set_reported(true);
836     info.rtt = connection->rtt();
837     info.sent_total_bytes = connection->sent_total_bytes();
838     info.sent_bytes_second = connection->sent_bytes_second();
839     info.recv_total_bytes = connection->recv_total_bytes();
840     info.recv_bytes_second = connection->recv_bytes_second();
841     info.local_candidate = connection->local_candidate();
842     info.remote_candidate = connection->remote_candidate();
843     info.key = connection;
844     infos->push_back(info);
845   }
846
847   return true;
848 }
849
850 talk_base::DiffServCodePoint P2PTransportChannel::DefaultDscpValue() const {
851   OptionMap::const_iterator it = options_.find(talk_base::Socket::OPT_DSCP);
852   if (it == options_.end()) {
853     return talk_base::DSCP_NO_CHANGE;
854   }
855   return static_cast<talk_base::DiffServCodePoint> (it->second);
856 }
857
858 // Begin allocate (or immediately re-allocate, if MSG_ALLOCATE pending)
859 void P2PTransportChannel::Allocate() {
860   // Time for a new allocator, lets make sure we have a signalling channel
861   // to communicate candidates through first.
862   waiting_for_signaling_ = true;
863   SignalRequestSignaling(this);
864 }
865
866 // Monitor connection states.
867 void P2PTransportChannel::UpdateConnectionStates() {
868   uint32 now = talk_base::Time();
869
870   // We need to copy the list of connections since some may delete themselves
871   // when we call UpdateState.
872   for (uint32 i = 0; i < connections_.size(); ++i)
873     connections_[i]->UpdateState(now);
874 }
875
876 // Prepare for best candidate sorting.
877 void P2PTransportChannel::RequestSort() {
878   if (!sort_dirty_) {
879     worker_thread_->Post(this, MSG_SORT);
880     sort_dirty_ = true;
881   }
882 }
883
884 // Sort the available connections to find the best one.  We also monitor
885 // the number of available connections and the current state.
886 void P2PTransportChannel::SortConnections() {
887   ASSERT(worker_thread_ == talk_base::Thread::Current());
888
889   // Make sure the connection states are up-to-date since this affects how they
890   // will be sorted.
891   UpdateConnectionStates();
892
893   if (protocol_type_ == ICEPROTO_HYBRID) {
894     // If we are in hybrid mode, we are not sending any ping requests, so there
895     // is no point in sorting the connections. In hybrid state, ports can have
896     // different protocol than hybrid and protocol may differ from one another.
897     // Instead just update the state of this channel
898     UpdateChannelState();
899     return;
900   }
901
902   // Any changes after this point will require a re-sort.
903   sort_dirty_ = false;
904
905   // Get a list of the networks that we are using.
906   std::set<talk_base::Network*> networks;
907   for (uint32 i = 0; i < connections_.size(); ++i)
908     networks.insert(connections_[i]->port()->Network());
909
910   // Find the best alternative connection by sorting.  It is important to note
911   // that amongst equal preference, writable connections, this will choose the
912   // one whose estimated latency is lowest.  So it is the only one that we
913   // need to consider switching to.
914
915   ConnectionCompare cmp;
916   std::stable_sort(connections_.begin(), connections_.end(), cmp);
917   LOG(LS_VERBOSE) << "Sorting available connections:";
918   for (uint32 i = 0; i < connections_.size(); ++i) {
919     LOG(LS_VERBOSE) << connections_[i]->ToString();
920   }
921
922   Connection* top_connection = NULL;
923   if (connections_.size() > 0)
924     top_connection = connections_[0];
925
926   // We don't want to pick the best connections if channel is using RFC5245
927   // and it's mode is CONTROLLED, as connections will be selected by the
928   // CONTROLLING agent.
929
930   // If necessary, switch to the new choice.
931   if (protocol_type_ != ICEPROTO_RFC5245 || ice_role_ == ICEROLE_CONTROLLING) {
932     if (ShouldSwitch(best_connection_, top_connection))
933       SwitchBestConnectionTo(top_connection);
934   }
935
936   // We can prune any connection for which there is a writable connection on
937   // the same network with better or equal priority.  We leave those with
938   // better priority just in case they become writable later (at which point,
939   // we would prune out the current best connection).  We leave connections on
940   // other networks because they may not be using the same resources and they
941   // may represent very distinct paths over which we can switch.
942   std::set<talk_base::Network*>::iterator network;
943   for (network = networks.begin(); network != networks.end(); ++network) {
944     Connection* primier = GetBestConnectionOnNetwork(*network);
945     if (!primier || (primier->write_state() != Connection::STATE_WRITABLE))
946       continue;
947
948     for (uint32 i = 0; i < connections_.size(); ++i) {
949       if ((connections_[i] != primier) &&
950           (connections_[i]->port()->Network() == *network) &&
951           (CompareConnectionCandidates(primier, connections_[i]) >= 0)) {
952         connections_[i]->Prune();
953       }
954     }
955   }
956
957   // Check if all connections are timedout.
958   bool all_connections_timedout = true;
959   for (uint32 i = 0; i < connections_.size(); ++i) {
960     if (connections_[i]->write_state() != Connection::STATE_WRITE_TIMEOUT) {
961       all_connections_timedout = false;
962       break;
963     }
964   }
965
966   // Now update the writable state of the channel with the information we have
967   // so far.
968   if (best_connection_ && best_connection_->writable()) {
969     HandleWritable();
970   } else if (all_connections_timedout) {
971     HandleAllTimedOut();
972   } else {
973     HandleNotWritable();
974   }
975
976   // Update the state of this channel.  This method is called whenever the
977   // state of any connection changes, so this is a good place to do this.
978   UpdateChannelState();
979 }
980
981
982 // Track the best connection, and let listeners know
983 void P2PTransportChannel::SwitchBestConnectionTo(Connection* conn) {
984   // Note: if conn is NULL, the previous best_connection_ has been destroyed,
985   // so don't use it.
986   Connection* old_best_connection = best_connection_;
987   best_connection_ = conn;
988   if (best_connection_) {
989     if (old_best_connection) {
990       LOG_J(LS_INFO, this) << "Previous best connection: "
991                            << old_best_connection->ToString();
992     }
993     LOG_J(LS_INFO, this) << "New best connection: "
994                          << best_connection_->ToString();
995     SignalRouteChange(this, best_connection_->remote_candidate());
996   } else {
997     LOG_J(LS_INFO, this) << "No best connection";
998   }
999 }
1000
1001 void P2PTransportChannel::UpdateChannelState() {
1002   // The Handle* functions already set the writable state.  We'll just double-
1003   // check it here.
1004   bool writable = ((best_connection_ != NULL)  &&
1005       (best_connection_->write_state() ==
1006       Connection::STATE_WRITABLE));
1007   ASSERT(writable == this->writable());
1008   if (writable != this->writable())
1009     LOG(LS_ERROR) << "UpdateChannelState: writable state mismatch";
1010
1011   bool readable = false;
1012   for (uint32 i = 0; i < connections_.size(); ++i) {
1013     if (connections_[i]->read_state() == Connection::STATE_READABLE) {
1014       readable = true;
1015       break;
1016     }
1017   }
1018   set_readable(readable);
1019 }
1020
1021 // We checked the status of our connections and we had at least one that
1022 // was writable, go into the writable state.
1023 void P2PTransportChannel::HandleWritable() {
1024   ASSERT(worker_thread_ == talk_base::Thread::Current());
1025   if (!writable()) {
1026     for (uint32 i = 0; i < allocator_sessions_.size(); ++i) {
1027       if (allocator_sessions_[i]->IsGettingPorts()) {
1028         allocator_sessions_[i]->StopGettingPorts();
1029       }
1030     }
1031   }
1032
1033   was_writable_ = true;
1034   set_writable(true);
1035 }
1036
1037 // Notify upper layer about channel not writable state, if it was before.
1038 void P2PTransportChannel::HandleNotWritable() {
1039   ASSERT(worker_thread_ == talk_base::Thread::Current());
1040   if (was_writable_) {
1041     was_writable_ = false;
1042     set_writable(false);
1043   }
1044 }
1045
1046 void P2PTransportChannel::HandleAllTimedOut() {
1047   // Currently we are treating this as channel not writable.
1048   HandleNotWritable();
1049 }
1050
1051 // If we have a best connection, return it, otherwise return top one in the
1052 // list (later we will mark it best).
1053 Connection* P2PTransportChannel::GetBestConnectionOnNetwork(
1054     talk_base::Network* network) {
1055   // If the best connection is on this network, then it wins.
1056   if (best_connection_ && (best_connection_->port()->Network() == network))
1057     return best_connection_;
1058
1059   // Otherwise, we return the top-most in sorted order.
1060   for (uint32 i = 0; i < connections_.size(); ++i) {
1061     if (connections_[i]->port()->Network() == network)
1062       return connections_[i];
1063   }
1064
1065   return NULL;
1066 }
1067
1068 // Handle any queued up requests
1069 void P2PTransportChannel::OnMessage(talk_base::Message *pmsg) {
1070   switch (pmsg->message_id) {
1071     case MSG_SORT:
1072       OnSort();
1073       break;
1074     case MSG_PING:
1075       OnPing();
1076       break;
1077     default:
1078       ASSERT(false);
1079       break;
1080   }
1081 }
1082
1083 // Handle queued up sort request
1084 void P2PTransportChannel::OnSort() {
1085   // Resort the connections based on the new statistics.
1086   SortConnections();
1087 }
1088
1089 // Handle queued up ping request
1090 void P2PTransportChannel::OnPing() {
1091   // Make sure the states of the connections are up-to-date (since this affects
1092   // which ones are pingable).
1093   UpdateConnectionStates();
1094
1095   // Find the oldest pingable connection and have it do a ping.
1096   Connection* conn = FindNextPingableConnection();
1097   if (conn)
1098     PingConnection(conn);
1099
1100   // Post ourselves a message to perform the next ping.
1101   uint32 delay = writable() ? WRITABLE_DELAY : UNWRITABLE_DELAY;
1102   thread()->PostDelayed(delay, this, MSG_PING);
1103 }
1104
1105 // Is the connection in a state for us to even consider pinging the other side?
1106 bool P2PTransportChannel::IsPingable(Connection* conn) {
1107   // An unconnected connection cannot be written to at all, so pinging is out
1108   // of the question.
1109   if (!conn->connected())
1110     return false;
1111
1112   if (writable()) {
1113     // If we are writable, then we only want to ping connections that could be
1114     // better than this one, i.e., the ones that were not pruned.
1115     return (conn->write_state() != Connection::STATE_WRITE_TIMEOUT);
1116   } else {
1117     // If we are not writable, then we need to try everything that might work.
1118     // This includes both connections that do not have write timeout as well as
1119     // ones that do not have read timeout.  A connection could be readable but
1120     // be in write-timeout if we pruned it before.  Since the other side is
1121     // still pinging it, it very well might still work.
1122     return (conn->write_state() != Connection::STATE_WRITE_TIMEOUT) ||
1123            (conn->read_state() != Connection::STATE_READ_TIMEOUT);
1124   }
1125 }
1126
1127 // Returns the next pingable connection to ping.  This will be the oldest
1128 // pingable connection unless we have a writable connection that is past the
1129 // maximum acceptable ping delay.
1130 Connection* P2PTransportChannel::FindNextPingableConnection() {
1131   uint32 now = talk_base::Time();
1132   if (best_connection_ &&
1133       (best_connection_->write_state() == Connection::STATE_WRITABLE) &&
1134       (best_connection_->last_ping_sent()
1135        + MAX_CURRENT_WRITABLE_DELAY <= now)) {
1136     return best_connection_;
1137   }
1138
1139   Connection* oldest_conn = NULL;
1140   uint32 oldest_time = 0xFFFFFFFF;
1141   for (uint32 i = 0; i < connections_.size(); ++i) {
1142     if (IsPingable(connections_[i])) {
1143       if (connections_[i]->last_ping_sent() < oldest_time) {
1144         oldest_time = connections_[i]->last_ping_sent();
1145         oldest_conn = connections_[i];
1146       }
1147     }
1148   }
1149   return oldest_conn;
1150 }
1151
1152 // Apart from sending ping from |conn| this method also updates
1153 // |use_candidate_attr| flag. The criteria to update this flag is
1154 // explained below.
1155 // Set USE-CANDIDATE if doing ICE AND this channel is in CONTROLLING AND
1156 //    a) Channel is in FULL ICE AND
1157 //      a.1) |conn| is the best connection OR
1158 //      a.2) there is no best connection OR
1159 //      a.3) the best connection is unwritable OR
1160 //      a.4) |conn| has higher priority than best_connection.
1161 //    b) we're doing LITE ICE AND
1162 //      b.1) |conn| is the best_connection AND
1163 //      b.2) |conn| is writable.
1164 void P2PTransportChannel::PingConnection(Connection* conn) {
1165   bool use_candidate = false;
1166   if (protocol_type_ == ICEPROTO_RFC5245) {
1167     if (remote_ice_mode_ == ICEMODE_FULL && ice_role_ == ICEROLE_CONTROLLING) {
1168       use_candidate = (conn == best_connection_) ||
1169                       (best_connection_ == NULL) ||
1170                       (!best_connection_->writable()) ||
1171                       (conn->priority() > best_connection_->priority());
1172     } else if (remote_ice_mode_ == ICEMODE_LITE && conn == best_connection_) {
1173       use_candidate = best_connection_->writable();
1174     }
1175   }
1176   conn->set_use_candidate_attr(use_candidate);
1177   conn->Ping(talk_base::Time());
1178 }
1179
1180 // When a connection's state changes, we need to figure out who to use as
1181 // the best connection again.  It could have become usable, or become unusable.
1182 void P2PTransportChannel::OnConnectionStateChange(Connection* connection) {
1183   ASSERT(worker_thread_ == talk_base::Thread::Current());
1184
1185   // Update the best connection if the state change is from pending best
1186   // connection and role is controlled.
1187   if (protocol_type_ == ICEPROTO_RFC5245 && ice_role_ == ICEROLE_CONTROLLED) {
1188     if (connection == pending_best_connection_ && connection->writable()) {
1189       pending_best_connection_ = NULL;
1190       SwitchBestConnectionTo(connection);
1191     }
1192   }
1193
1194   // We have to unroll the stack before doing this because we may be changing
1195   // the state of connections while sorting.
1196   RequestSort();
1197 }
1198
1199 // When a connection is removed, edit it out, and then update our best
1200 // connection.
1201 void P2PTransportChannel::OnConnectionDestroyed(Connection* connection) {
1202   ASSERT(worker_thread_ == talk_base::Thread::Current());
1203
1204   // Note: the previous best_connection_ may be destroyed by now, so don't
1205   // use it.
1206
1207   // Remove this connection from the list.
1208   std::vector<Connection*>::iterator iter =
1209       std::find(connections_.begin(), connections_.end(), connection);
1210   ASSERT(iter != connections_.end());
1211   connections_.erase(iter);
1212
1213   LOG_J(LS_INFO, this) << "Removed connection ("
1214     << static_cast<int>(connections_.size()) << " remaining)";
1215
1216   if (pending_best_connection_ == connection) {
1217     pending_best_connection_ = NULL;
1218   }
1219
1220   // If this is currently the best connection, then we need to pick a new one.
1221   // The call to SortConnections will pick a new one.  It looks at the current
1222   // best connection in order to avoid switching between fairly similar ones.
1223   // Since this connection is no longer an option, we can just set best to NULL
1224   // and re-choose a best assuming that there was no best connection.
1225   if (best_connection_ == connection) {
1226     SwitchBestConnectionTo(NULL);
1227     RequestSort();
1228   }
1229
1230   SignalConnectionRemoved(this);
1231 }
1232
1233 // When a port is destroyed remove it from our list of ports to use for
1234 // connection attempts.
1235 void P2PTransportChannel::OnPortDestroyed(PortInterface* port) {
1236   ASSERT(worker_thread_ == talk_base::Thread::Current());
1237
1238   // Remove this port from the list (if we didn't drop it already).
1239   std::vector<PortInterface*>::iterator iter =
1240       std::find(ports_.begin(), ports_.end(), port);
1241   if (iter != ports_.end())
1242     ports_.erase(iter);
1243
1244   LOG(INFO) << "Removed port from p2p socket: "
1245             << static_cast<int>(ports_.size()) << " remaining";
1246 }
1247
1248 // We data is available, let listeners know
1249 void P2PTransportChannel::OnReadPacket(
1250     Connection *connection, const char *data, size_t len,
1251     const talk_base::PacketTime& packet_time) {
1252   ASSERT(worker_thread_ == talk_base::Thread::Current());
1253
1254   // Do not deliver, if packet doesn't belong to the correct transport channel.
1255   if (!FindConnection(connection))
1256     return;
1257
1258   // Let the client know of an incoming packet
1259   SignalReadPacket(this, data, len, packet_time, 0);
1260 }
1261
1262 void P2PTransportChannel::OnReadyToSend(Connection* connection) {
1263   if (connection == best_connection_ && writable()) {
1264     SignalReadyToSend(this);
1265   }
1266 }
1267
1268 }  // namespace cricket