Added connection timeout functionality to CastSocket.

chrome/browser/extensions/api/cast_channel/cast_socket.cc

 // Copyright 2013 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 "chrome/browser/extensions/api/cast_channel/cast_socket.h"
 
 #include <stdlib.h>
 #include <string.h>
 
 #include "base/bind.h"
@@ skipping 49 matching lines @@
   return g_factory.Pointer();
 }
 
 namespace api {
 namespace cast_channel {
 
 CastSocket::CastSocket(const std::string& owner_extension_id,
                        const net::IPEndPoint& ip_endpoint,
                        ChannelAuthType channel_auth,
                        CastSocket::Delegate* delegate,
-                       net::NetLog* net_log) :
+                       net::NetLog* net_log,
+                       int64 timeout_ms) :
     ApiResource(owner_extension_id),
     channel_id_(0),
     ip_endpoint_(ip_endpoint),
     channel_auth_(channel_auth),
     delegate_(delegate),
     current_message_size_(0),
     current_message_(new CastMessage()),
     net_log_(net_log),
     connect_state_(CONN_STATE_NONE),
     write_state_(WRITE_STATE_NONE),
     read_state_(READ_STATE_NONE),
     error_state_(CHANNEL_ERROR_NONE),
-    ready_state_(READY_STATE_NONE) {
+    ready_state_(READY_STATE_NONE),
+    timeout_interval_ms_(timeout_ms),
+    timed_out_(false) {
   DCHECK(net_log_);
   DCHECK(channel_auth_ == CHANNEL_AUTH_TYPE_SSL ||
          channel_auth_ == CHANNEL_AUTH_TYPE_SSL_VERIFIED);
   net_log_source_.type = net::NetLog::SOURCE_SOCKET;
   net_log_source_.id = net_log_->NextID();
 
   // Reuse these buffers for each message.
   header_read_buffer_ = new net::GrowableIOBuffer();
   header_read_buffer_->SetCapacity(MessageHeader::header_size());
   body_read_buffer_ = new net::GrowableIOBuffer();
@@ skipping 70 matching lines @@
 void CastSocket::Connect(const net::CompletionCallback& callback) {
   DCHECK(CalledOnValidThread());
   VLOG_WITH_CONNECTION(1) << "Connect readyState = " << ready_state_;
   if (ready_state_ != READY_STATE_NONE) {
     callback.Run(net::ERR_CONNECTION_FAILED);
     return;
   }
   ready_state_ = READY_STATE_CONNECTING;
   connect_callback_ = callback;
   connect_state_ = CONN_STATE_TCP_CONNECT;
+
+  timeout_callback_.Reset(base::Bind(&CastSocket::Timeout, AsWeakPtr()));
+  base::MessageLoop::current()->PostDelayedTask(
+      FROM_HERE,
+      timeout_callback_.callback(),
+      base::TimeDelta::FromMilliseconds(timeout_interval_ms_));
+
   DoConnectLoop(net::OK);
 }
 
 void CastSocket::PostTaskToStartConnectLoop(int result) {
   DCHECK(CalledOnValidThread());
   base::MessageLoop::current()->PostTask(
       FROM_HERE,
       base::Bind(&CastSocket::DoConnectLoop, AsWeakPtr(), result));
 }
 
+void CastSocket::Timeout() {
+  VLOG(1) << "Timeout while establishing connection.";
+  CloseWithError(CHANNEL_ERROR_CONNECT_ERROR);

[mark a. foltz, 2014/07/15 22:18:15]

I would be in favor of adding an error enum CHANNEL_ERROR_CONNECT_TIMEOUT.

[Kevin M, 2014/07/16 22:59:41]

Done.

+  timed_out_ = true;

[mark a. foltz, 2014/07/15 22:18:15]

Is timed_out_ used anywhere?

[Kevin M, 2014/07/16 22:59:41]

No, I ended up using the error state instead. Removed.

+  DoConnectCallback(net::ERR_TIMED_OUT);
+}
+
 // This method performs the state machine transitions for connection flow.
 // There are two entry points to this method:
 // 1. Connect method: this starts the flow
 // 2. Callback from network operations that finish asynchronously
 void CastSocket::DoConnectLoop(int result) {
+  if (error_state_ != CHANNEL_ERROR_NONE) {
+     VLOG(1) << "Connection timeout; DoConnectLoop aborted.";

[mark a. foltz, 2014/07/15 22:18:15]

Is this the only possible way error_state_ can be set?
Seems safer to log the error_state_ than assume it's one value.

[Kevin M, 2014/07/16 22:59:41]

Good idea, done.

+     return;
+  }
+
   // Network operations can either finish synchronously or asynchronously.
   // This method executes the state machine transitions in a loop so that
   // correct state transitions happen even when network operations finish
   // synchronously.
   int rv = result;
   do {
     ConnectionState state = connect_state_;
     // Default to CONN_STATE_NONE, which breaks the processing loop if any
     // handler fails to transition to another state to continue processing.
     connect_state_ = CONN_STATE_NONE;
@@ skipping 23 matching lines @@
       default:
         NOTREACHED() << "BUG in connect flow. Unknown state: " << state;
         break;
     }
   } while (rv != net::ERR_IO_PENDING && connect_state_ != CONN_STATE_NONE);
   // Get out of the loop either when:
   // a. A network operation is pending, OR
   // b. The Do* method called did not change state
 
   // Connect loop is finished: if there is no pending IO invoke the callback.
-  if (rv != net::ERR_IO_PENDING)
+  if (rv != net::ERR_IO_PENDING) {
+    timeout_callback_.Cancel();
     DoConnectCallback(rv);
+  }
 }
 
 int CastSocket::DoTcpConnect() {
   VLOG_WITH_CONNECTION(1) << "DoTcpConnect";
   connect_state_ = CONN_STATE_TCP_CONNECT_COMPLETE;
   tcp_socket_ = CreateTcpSocket();
   return tcp_socket_->Connect(
       base::Bind(&CastSocket::DoConnectLoop, AsWeakPtr()));
 }
 
@@ skipping 431 matching lines @@
   message_proto.SerializeToString(message_data);
   size_t message_size = message_data->size();
   if (message_size > MessageHeader::max_message_size()) {
     message_data->clear();
     return false;
   }
   CastSocket::MessageHeader header;
   header.SetMessageSize(message_size);
   header.PrependToString(message_data);
   return true;
-};
+}
 
 void CastSocket::CloseWithError(ChannelError error) {
   DCHECK(CalledOnValidThread());
   socket_.reset(NULL);
   ready_state_ = READY_STATE_CLOSED;
   error_state_ = error;
   if (delegate_)
     delegate_->OnError(this, error);
 }
 
@@ skipping 55 matching lines @@
   return true;
 }
 
 CastSocket::WriteRequest::~WriteRequest() { }
 
 }  // namespace cast_channel
 }  // namespace api
 }  // namespace extensions
 
 #undef VLOG_WITH_CONNECTION