QUIC - minor reorg of QuicCryptoClientStream::DoHandshakeLoop.

net/quic/quic_crypto_client_stream.h

 // 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.
 
 #ifndef NET_QUIC_QUIC_CRYPTO_CLIENT_STREAM_H_
 #define NET_QUIC_QUIC_CRYPTO_CLIENT_STREAM_H_
 
 #include <string>
 
 #include "net/quic/crypto/channel_id.h"
@@ skipping 89 matching lines @@
     STATE_IDLE,
     STATE_INITIALIZE,
     STATE_SEND_CHLO,
     STATE_RECV_REJ,
     STATE_VERIFY_PROOF,
     STATE_VERIFY_PROOF_COMPLETE,
     STATE_GET_CHANNEL_ID,
     STATE_GET_CHANNEL_ID_COMPLETE,
     STATE_RECV_SHLO,
     STATE_INITIALIZE_SCUP,
-    STATE_VERIFY_PROOF_DONE,
+    STATE_DONE,
   };
 
   // Handles new server config and optional source-address token provided by the
   // server during a connection.
   void HandleServerConfigUpdateMessage(
       const CryptoHandshakeMessage& server_config_update);
 
   // DoHandshakeLoop performs a step of the handshake state machine. Note that
   // |in| may be NULL if the call did not result from a received message.
   void DoHandshakeLoop(const CryptoHandshakeMessage* in);
 
+  // Start the handshake process.
+  void DoInitialize(QuicCryptoClientConfig::CachedState* cached);

[ramant (doing other things), 2014/09/19 03:13:07]

Hi Ryan and Adam,
  Added crude comments. Would appreciate help in documenting code better.

Thanks much.

[Ryan Hamilton, 2014/09/24 15:36:47]

These seem fine. We often don't even comment our various DoFoo() method.

+
+  // Send either InchoateClientHello or ClientHello message to the server.
+  void DoSendCHLO(const CryptoHandshakeMessage* in,
+                  QuicCryptoClientConfig::CachedState* cached);
+
+  // Process REJ message from the server.
+  void DoReceiveREJ(const CryptoHandshakeMessage* in,
+                    QuicCryptoClientConfig::CachedState* cached);
+
+  // Start the proof verification process. Returns the QuicAsyncStatus returned
+  // by the ProofVerifier's VerifyProof.
+  QuicAsyncStatus DoVerifyProof(
+      QuicCryptoClientConfig::CachedState* cached);
+
+  // If proof is valid then it sets the proof as valid (which persists the
+  // server config). If not, it closes the connection.
+  void DoVerifyProofComplete(QuicCryptoClientConfig::CachedState* cached);
+
+  // Start the look up of Channel ID process. Returns either QUIC_SUCCESS if
+  // RequiresChannelID returns false or QuicAsyncStatus returned by
+  // GetChannelIDKey.
+  QuicAsyncStatus DoGetChannelID(QuicCryptoClientConfig::CachedState* cached);
+
+  // If there is no channel ID, then close the connection otherwise transtion to
+  // STATE_SEND_CHLO state.
+  void DoGetChannelIDComplete();
+
+  // Process SHLO message from the server.
+  void DoReceiveSHLO(const CryptoHandshakeMessage* in,
+                     QuicCryptoClientConfig::CachedState* cached);
+
   // Start the proof verification if |server_id_| is https and |cached| has
   // signature.
   void DoInitializeServerConfigUpdate(
       QuicCryptoClientConfig::CachedState* cached);
 
-  // Starts the proof verification. Returns the QuicAsyncStatus returned by the
-  // ProofVerifier's VerifyProof.
-  QuicAsyncStatus DoVerifyProof(QuicCryptoClientConfig::CachedState* cached);
-
-  // If proof is valid then it sets the proof as valid (which persists the
-  // server config) and returns QUIC_NO_ERROR. If not, it closes the connection
-  // and returns QUIC_PROOF_INVALID.
-  QuicErrorCode DoVerifyProofComplete(
-      QuicCryptoClientConfig::CachedState* cached);
-
   // Called to set the proof of |cached| valid.  Also invokes the session's
   // OnProofValid() method.
   void SetCachedProofValid(QuicCryptoClientConfig::CachedState* cached);
 
   // Returns true if the server crypto config in |cached| requires a ChannelID
   // and the client config settings also allow sending a ChannelID.
   bool RequiresChannelID(QuicCryptoClientConfig::CachedState* cached);
 
   QuicClientSessionBase* client_session();
 
@@ skipping 42 matching lines @@
   bool verify_ok_;
   string verify_error_details_;
   scoped_ptr<ProofVerifyDetails> verify_details_;
 
   DISALLOW_COPY_AND_ASSIGN(QuicCryptoClientStream);
 };
 
 }  // namespace net
 
 #endif  // NET_QUIC_QUIC_CRYPTO_CLIENT_STREAM_H_