Move PseudoTCP and channel auth out of LibjingleTransportFactory.

remoting/protocol/libjingle_transport_factory.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "remoting/protocol/libjingle_transport_factory.h"
 
 #include "base/callback.h"
 #include "base/single_thread_task_runner.h"
 #include "base/thread_task_runner_handle.h"
 #include "base/timer/timer.h"
 #include "jingle/glue/channel_socket_adapter.h"
-#include "jingle/glue/pseudotcp_adapter.h"
 #include "jingle/glue/utils.h"
 #include "net/base/net_errors.h"
-#include "remoting/base/constants.h"
-#include "remoting/protocol/channel_authenticator.h"
 #include "remoting/protocol/network_settings.h"
 #include "remoting/signaling/jingle_info_request.h"
 #include "third_party/libjingle/source/talk/p2p/base/constants.h"
 #include "third_party/libjingle/source/talk/p2p/base/p2ptransportchannel.h"
 #include "third_party/libjingle/source/talk/p2p/base/port.h"
 #include "third_party/libjingle/source/talk/p2p/client/basicportallocator.h"
 #include "third_party/libjingle/source/talk/p2p/client/httpportallocator.h"
 #include "third_party/webrtc/base/network.h"
 
 namespace remoting {
 namespace protocol {
 
 namespace {
 
-// Value is chosen to balance the extra latency against the reduced
-// load due to ACK traffic.
-const int kTcpAckDelayMilliseconds = 10;
-
-// Values for the TCP send and receive buffer size. This should be tuned to
-// accommodate high latency network but not backlog the decoding pipeline.
-const int kTcpReceiveBufferSize = 256 * 1024;
-const int kTcpSendBufferSize = kTcpReceiveBufferSize + 30 * 1024;
-
 // Try connecting ICE twice with timeout of 15 seconds for each attempt.
 const int kMaxReconnectAttempts = 2;
 const int kReconnectDelaySeconds = 15;
 
 // Get fresh STUN/Relay configuration every hour.
 const int kJingleInfoUpdatePeriodSeconds = 3600;
 
-class LibjingleStreamTransport
-    : public StreamTransport,
-      public base::SupportsWeakPtr<LibjingleStreamTransport>,
+class LibjingleTransport
+    : public Transport,
+      public base::SupportsWeakPtr<LibjingleTransport>,
       public sigslot::has_slots<> {
  public:
-  LibjingleStreamTransport(cricket::PortAllocator* port_allocator,
+  LibjingleTransport(cricket::PortAllocator* port_allocator,
                            const NetworkSettings& network_settings);
-  virtual ~LibjingleStreamTransport();
+  virtual ~LibjingleTransport();
 
   // Called by JingleTransportFactory when it has fresh Jingle info.
   void OnCanStart();
 
-  // StreamTransport interface.
-  virtual void Initialize(
+  // Transport interface.
+  virtual void Connect(
       const std::string& name,
       Transport::EventHandler* event_handler,
-      scoped_ptr<ChannelAuthenticator> authenticator) OVERRIDE;
-  virtual void Connect(
-      const StreamTransport::ConnectedCallback& callback) OVERRIDE;
+      const Transport::ConnectedCallback& callback) OVERRIDE;
   virtual void AddRemoteCandidate(const cricket::Candidate& candidate) OVERRIDE;
   virtual const std::string& name() const OVERRIDE;
   virtual bool is_connected() const OVERRIDE;
 
  private:
   void DoStart();
 
   // Signal handlers for cricket::TransportChannel.
   void OnRequestSignaling(cricket::TransportChannelImpl* channel);
   void OnCandidateReady(cricket::TransportChannelImpl* channel,
                         const cricket::Candidate& candidate);
   void OnRouteChange(cricket::TransportChannel* channel,
                      const cricket::Candidate& candidate);
   void OnWritableState(cricket::TransportChannel* channel);
 
-  // Callback for PseudoTcpAdapter::Connect().
-  void OnTcpConnected(int result);
-
-  // Callback for Authenticator::SecureAndAuthenticate();
-  void OnAuthenticationDone(net::Error error,
-                            scoped_ptr<net::StreamSocket> socket);
-
   // Callback for jingle_glue::TransportChannelSocketAdapter to notify when the
   // socket is destroyed.
   void OnChannelDestroyed();
 
   // Tries to connect by restarting ICE. Called by |reconnect_timer_|.
   void TryReconnect();
 
-  // Helper methods to call |callback_|.
-  void NotifyConnected(scoped_ptr<net::StreamSocket> socket);
-  void NotifyConnectFailed();
-
   cricket::PortAllocator* port_allocator_;
   NetworkSettings network_settings_;
 
   std::string name_;
   EventHandler* event_handler_;
-  StreamTransport::ConnectedCallback callback_;
-  scoped_ptr<ChannelAuthenticator> authenticator_;
+  Transport::ConnectedCallback callback_;
   std::string ice_username_fragment_;
   std::string ice_password_;
 
   bool can_start_;
 
   std::list<cricket::Candidate> pending_candidates_;
   scoped_ptr<cricket::P2PTransportChannel> channel_;
   bool channel_was_writable_;
   int connect_attempts_left_;
-  base::RepeatingTimer<LibjingleStreamTransport> reconnect_timer_;
+  base::RepeatingTimer<LibjingleTransport> reconnect_timer_;
 
-  // We own |socket_| until it is connected.
-  scoped_ptr<jingle_glue::PseudoTcpAdapter> socket_;
-
-  DISALLOW_COPY_AND_ASSIGN(LibjingleStreamTransport);
+  DISALLOW_COPY_AND_ASSIGN(LibjingleTransport);
 };
 
-LibjingleStreamTransport::LibjingleStreamTransport(
+LibjingleTransport::LibjingleTransport(
     cricket::PortAllocator* port_allocator,
     const NetworkSettings& network_settings)
     : port_allocator_(port_allocator),
       network_settings_(network_settings),
       event_handler_(NULL),
       ice_username_fragment_(
           rtc::CreateRandomString(cricket::ICE_UFRAG_LENGTH)),
       ice_password_(rtc::CreateRandomString(cricket::ICE_PWD_LENGTH)),
       can_start_(false),
       channel_was_writable_(false),
       connect_attempts_left_(kMaxReconnectAttempts) {
   DCHECK(!ice_username_fragment_.empty());
   DCHECK(!ice_password_.empty());
 }
 
-LibjingleStreamTransport::~LibjingleStreamTransport() {
+LibjingleTransport::~LibjingleTransport() {
   DCHECK(event_handler_);
+
   event_handler_->OnTransportDeleted(this);
-  // Channel should be already destroyed if we were connected.
-  DCHECK(!is_connected() || socket_.get() == NULL);
 
   if (channel_.get()) {
     base::ThreadTaskRunnerHandle::Get()->DeleteSoon(
         FROM_HERE, channel_.release());
   }
 }
 
-void LibjingleStreamTransport::OnCanStart() {
+void LibjingleTransport::OnCanStart() {
   DCHECK(CalledOnValidThread());
 
   DCHECK(!can_start_);
   can_start_ = true;
 
   // If Connect() has been called then start connection.
   if (!callback_.is_null())
     DoStart();
 
   while (!pending_candidates_.empty()) {
     channel_->OnCandidate(pending_candidates_.front());
     pending_candidates_.pop_front();
   }
 }
 
-void LibjingleStreamTransport::Initialize(
+void LibjingleTransport::Connect(
     const std::string& name,
     Transport::EventHandler* event_handler,
-    scoped_ptr<ChannelAuthenticator> authenticator) {
+    const Transport::ConnectedCallback& callback) {
   DCHECK(CalledOnValidThread());
-
   DCHECK(!name.empty());
   DCHECK(event_handler);
+  DCHECK(!callback.is_null());
 
-  // Can be initialized only once.
   DCHECK(name_.empty());
-
   name_ = name;
   event_handler_ = event_handler;
-  authenticator_ = authenticator.Pass();
-}
-
-void LibjingleStreamTransport::Connect(
-    const StreamTransport::ConnectedCallback& callback) {
-  DCHECK(CalledOnValidThread());
   callback_ = callback;
 
   if (can_start_)
     DoStart();
 }
 
-void LibjingleStreamTransport::DoStart() {
+void LibjingleTransport::DoStart() {
   DCHECK(!channel_.get());
 
   // Create P2PTransportChannel, attach signal handlers and connect it.
   // TODO(sergeyu): Specify correct component ID for the channel.
   channel_.reset(new cricket::P2PTransportChannel(
       std::string(), 0, NULL, port_allocator_));
   channel_->SetIceProtocolType(cricket::ICEPROTO_GOOGLE);
   channel_->SetIceCredentials(ice_username_fragment_, ice_password_);
   channel_->SignalRequestSignaling.connect(
-      this, &LibjingleStreamTransport::OnRequestSignaling);
+      this, &LibjingleTransport::OnRequestSignaling);
   channel_->SignalCandidateReady.connect(
-      this, &LibjingleStreamTransport::OnCandidateReady);
+      this, &LibjingleTransport::OnCandidateReady);
   channel_->SignalRouteChange.connect(
-      this, &LibjingleStreamTransport::OnRouteChange);
+      this, &LibjingleTransport::OnRouteChange);
   channel_->SignalWritableState.connect(
-      this, &LibjingleStreamTransport::OnWritableState);
+      this, &LibjingleTransport::OnWritableState);
   channel_->set_incoming_only(
       !(network_settings_.flags & NetworkSettings::NAT_TRAVERSAL_OUTGOING));
 
   channel_->Connect();
 
   --connect_attempts_left_;
 
   // Start reconnection timer.
   reconnect_timer_.Start(
       FROM_HERE, base::TimeDelta::FromSeconds(kReconnectDelaySeconds),
-      this, &LibjingleStreamTransport::TryReconnect);
+      this, &LibjingleTransport::TryReconnect);
 
   // Create net::Socket adapter for the P2PTransportChannel.
-  scoped_ptr<jingle_glue::TransportChannelSocketAdapter> channel_adapter(
+  scoped_ptr<jingle_glue::TransportChannelSocketAdapter> socket(
       new jingle_glue::TransportChannelSocketAdapter(channel_.get()));
+  socket->SetOnDestroyedCallback(base::Bind(
+      &LibjingleTransport::OnChannelDestroyed, base::Unretained(this)));
 
-  channel_adapter->SetOnDestroyedCallback(base::Bind(
-      &LibjingleStreamTransport::OnChannelDestroyed, base::Unretained(this)));
-
-  // Configure and connect PseudoTCP adapter.
-  socket_.reset(
-      new jingle_glue::PseudoTcpAdapter(channel_adapter.release()));
-  socket_->SetSendBufferSize(kTcpSendBufferSize);
-  socket_->SetReceiveBufferSize(kTcpReceiveBufferSize);
-  socket_->SetNoDelay(true);
-  socket_->SetAckDelay(kTcpAckDelayMilliseconds);
-
-  // TODO(sergeyu): This is a hack to improve latency of the video
-  // channel. Consider removing it once we have better flow control
-  // implemented.
-  if (name_ == kVideoChannelName)
-    socket_->SetWriteWaitsForSend(true);
-
-  int result = socket_->Connect(
-      base::Bind(&LibjingleStreamTransport::OnTcpConnected,
-                 base::Unretained(this)));
-  if (result != net::ERR_IO_PENDING)
-    OnTcpConnected(result);
+  Transport::ConnectedCallback callback = callback_;
+  callback_.Reset();
+  callback.Run(socket.PassAs<net::Socket>());
 }
 
-void LibjingleStreamTransport::AddRemoteCandidate(
+void LibjingleTransport::AddRemoteCandidate(
     const cricket::Candidate& candidate) {
   DCHECK(CalledOnValidThread());
 
   // To enforce the no-relay setting, it's not enough to not produce relay
   // candidates. It's also necessary to discard remote relay candidates.
   bool relay_allowed = (network_settings_.flags &
                         NetworkSettings::NAT_TRAVERSAL_RELAY) != 0;
   if (!relay_allowed && candidate.type() == cricket::RELAY_PORT_TYPE)
     return;
 
   if (channel_) {
     channel_->OnCandidate(candidate);
   } else {
     pending_candidates_.push_back(candidate);
   }
 }
 
-const std::string& LibjingleStreamTransport::name() const {
+const std::string& LibjingleTransport::name() const {
   DCHECK(CalledOnValidThread());
   return name_;
 }
 
-bool LibjingleStreamTransport::is_connected() const {
+bool LibjingleTransport::is_connected() const {
   DCHECK(CalledOnValidThread());
   return callback_.is_null();
 }
 
-void LibjingleStreamTransport::OnRequestSignaling(
+void LibjingleTransport::OnRequestSignaling(
     cricket::TransportChannelImpl* channel) {
   DCHECK(CalledOnValidThread());
   channel_->OnSignalingReady();
 }
 
-void LibjingleStreamTransport::OnCandidateReady(
+void LibjingleTransport::OnCandidateReady(
     cricket::TransportChannelImpl* channel,
     const cricket::Candidate& candidate) {
   DCHECK(CalledOnValidThread());
   event_handler_->OnTransportCandidate(this, candidate);
 }
 
-void LibjingleStreamTransport::OnRouteChange(
+void LibjingleTransport::OnRouteChange(
     cricket::TransportChannel* channel,
     const cricket::Candidate& candidate) {
   TransportRoute route;
 
   if (candidate.type() == "local") {
     route.type = TransportRoute::DIRECT;
   } else if (candidate.type() == "stun") {
     route.type = TransportRoute::STUN;
   } else if (candidate.type() == "relay") {
     route.type = TransportRoute::RELAY;
@@ skipping 10 matching lines @@
   const cricket::Candidate& local_candidate =
       channel_->best_connection()->local_candidate();
   if (!jingle_glue::SocketAddressToIPEndPoint(
           local_candidate.address(), &route.local_address)) {
     LOG(FATAL) << "Failed to convert local IP address.";
   }
 
   event_handler_->OnTransportRouteChange(this, route);
 }
 
-void LibjingleStreamTransport::OnWritableState(
+void LibjingleTransport::OnWritableState(
     cricket::TransportChannel* channel) {
   DCHECK_EQ(channel, channel_.get());
 
   if (channel->writable()) {
     channel_was_writable_ = true;
     connect_attempts_left_ = kMaxReconnectAttempts;
     reconnect_timer_.Stop();
   } else if (!channel->writable() && channel_was_writable_) {
     reconnect_timer_.Reset();
     TryReconnect();
   }
 }
 
-void LibjingleStreamTransport::OnTcpConnected(int result) {
-  DCHECK(CalledOnValidThread());
-
-  if (result != net::OK) {
-    NotifyConnectFailed();
-    return;
-  }
-
-  authenticator_->SecureAndAuthenticate(
-      socket_.PassAs<net::StreamSocket>(),
-      base::Bind(&LibjingleStreamTransport::OnAuthenticationDone,
-                 base::Unretained(this)));
-}
-
-void LibjingleStreamTransport::OnAuthenticationDone(
-    net::Error error,
-    scoped_ptr<net::StreamSocket> socket) {
-  if (error != net::OK) {
-    NotifyConnectFailed();
-    return;
-  }
-
-  NotifyConnected(socket.Pass());
-}
-
-void LibjingleStreamTransport::OnChannelDestroyed() {
+void LibjingleTransport::OnChannelDestroyed() {
   if (is_connected()) {
     // The connection socket is being deleted, so delete the transport too.
     delete this;
   }
 }
 
-void LibjingleStreamTransport::TryReconnect() {
+void LibjingleTransport::TryReconnect() {
   DCHECK(!channel_->writable());
 
   if (connect_attempts_left_ <= 0) {
     reconnect_timer_.Stop();
 
     // Notify the caller that ICE connection has failed - normally that will
     // terminate Jingle connection (i.e. the transport will be destroyed).
     event_handler_->OnTransportFailed(this);
     return;
   }
   --connect_attempts_left_;
 
   // Restart ICE by resetting ICE password.
   ice_password_ = rtc::CreateRandomString(cricket::ICE_PWD_LENGTH);
   channel_->SetIceCredentials(ice_username_fragment_, ice_password_);
 }
 
-void LibjingleStreamTransport::NotifyConnected(
-    scoped_ptr<net::StreamSocket> socket) {
-  DCHECK(!is_connected());
-  StreamTransport::ConnectedCallback callback = callback_;
-  callback_.Reset();
-  callback.Run(socket.Pass());
-}
-
-void LibjingleStreamTransport::NotifyConnectFailed() {
-  DCHECK(!is_connected());
-
-  socket_.reset();
-
-  // This method may be called in response to a libjingle signal, so
-  // libjingle objects must be deleted asynchronously.
-  if (channel_.get()) {
-    base::ThreadTaskRunnerHandle::Get()->DeleteSoon(
-        FROM_HERE, channel_.release());
-  }
-
-  authenticator_.reset();
-
-  NotifyConnected(scoped_ptr<net::StreamSocket>());
-}
-
 }  // namespace
 
 LibjingleTransportFactory::LibjingleTransportFactory(
     SignalStrategy* signal_strategy,
     scoped_ptr<cricket::HttpPortAllocatorBase> port_allocator,
     const NetworkSettings& network_settings)
     : signal_strategy_(signal_strategy),
       port_allocator_(port_allocator.Pass()),
       network_settings_(network_settings) {
 }
 
 LibjingleTransportFactory::~LibjingleTransportFactory() {
   // This method may be called in response to a libjingle signal, so
   // libjingle objects must be deleted asynchronously.
   scoped_refptr<base::SingleThreadTaskRunner> task_runner =
       base::ThreadTaskRunnerHandle::Get();
   task_runner->DeleteSoon(FROM_HERE, port_allocator_.release());
 }
 
 void LibjingleTransportFactory::PrepareTokens() {
   EnsureFreshJingleInfo();
 }
 
-scoped_ptr<StreamTransport> LibjingleTransportFactory::CreateStreamTransport() {
-  scoped_ptr<LibjingleStreamTransport> result(
-      new LibjingleStreamTransport(port_allocator_.get(), network_settings_));
+scoped_ptr<Transport> LibjingleTransportFactory::CreateTransport() {
+  scoped_ptr<LibjingleTransport> result(
+      new LibjingleTransport(port_allocator_.get(), network_settings_));
 
   EnsureFreshJingleInfo();
 
   // If there is a pending |jingle_info_request_| delay starting the new
   // transport until the request is finished.
   if (jingle_info_request_) {
     on_jingle_info_callbacks_.push_back(
-        base::Bind(&LibjingleStreamTransport::OnCanStart,
+        base::Bind(&LibjingleTransport::OnCanStart,
                    result->AsWeakPtr()));
   } else {
     result->OnCanStart();
   }
 
-  return result.PassAs<StreamTransport>();
-}
-
-scoped_ptr<DatagramTransport>
-LibjingleTransportFactory::CreateDatagramTransport() {
-  NOTIMPLEMENTED();
-  return scoped_ptr<DatagramTransport>();
+  return result.PassAs<Transport>();
 }
 
 void LibjingleTransportFactory::EnsureFreshJingleInfo() {
   uint32 stun_or_relay_flags = NetworkSettings::NAT_TRAVERSAL_STUN |
       NetworkSettings::NAT_TRAVERSAL_RELAY;
   if (!(network_settings_.flags & stun_or_relay_flags) ||
       jingle_info_request_) {
     return;
   }
 
@@ skipping 22 matching lines @@
     last_jingle_info_update_time_ = base::TimeTicks::Now();
 
   while (!on_jingle_info_callbacks_.empty()) {
     on_jingle_info_callbacks_.begin()->Run();
     on_jingle_info_callbacks_.pop_front();
   }
 }
 
 }  // namespace protocol
 }  // namespace remoting