Add AUTHENTICATED session state.

remoting/protocol/session.h

 // Copyright (c) 2011 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 REMOTING_PROTOCOL_SESSION_H_
 #define REMOTING_PROTOCOL_SESSION_H_
 
 #include <string>
 
 #include "base/callback.h"
@@ skipping 17 matching lines @@
 // while it is being invoked all Session instances must be deleted
 // with a clean stack, i.e. not from event handlers, when sigslot may
 // be present in the stack.
 class Session : public base::NonThreadSafe {
  public:
   enum State {
     // Created, but not connecting yet.
     INITIALIZING,
 
     // Sent or received session-initiate, but haven't sent or received
     // session-accept.

[Wez, 2011/12/03 00:10:37]

Combining this description with those of CONNECTED and AUTHENTICATED, it's not
clear to my why the caller cares about the distinction?

[Sergey Ulanov, 2011/12/06 02:33:20]

I think we do need to distinguish between CONNECTED and AUTHENTICATED - in some
cases calling code may want to created channels in CONNECTED state to speed up
connection process.

     CONNECTING,
 
-    // Session has been accepted.
+    // Session has been accepted, but authentication is not finished yet.

[Wez, 2011/12/03 00:10:37]

nit: "... and is pending authentication."

[Sergey Ulanov, 2011/12/06 02:33:20]

Done.

     CONNECTED,
 
+    // Session has been connected and authenticated.
+    AUTHENTICATED,
+
     // Session has been closed.
     CLOSED,
 
     // Connection has failed.
     FAILED,
   };
 
   // TODO(sergeyu): Move error codes to a separate file.
   enum Error {
     OK = 0,
     PEER_IS_OFFLINE,
     SESSION_REJECTED,
     INCOMPATIBLE_PROTOCOL,
     AUTHENTICATION_FAILED,
     CHANNEL_CONNECTION_ERROR,
   };
 
-  typedef base::Callback<void(State)> StateChangeCallback;
+  // State change callbacks are called after session state has
+  // changed. Handlers can destroy session only when |state| is set to
+  // CLOSED or FAILED.

[Wez, 2011/12/03 00:10:37]

nit: "It is not safe to destroy the session from within the handler unless
|state| is CLOSED or FAILED."

[Sergey Ulanov, 2011/12/06 02:33:20]

Done.

+  typedef base::Callback<void(State state)> StateChangeCallback;
 
   // TODO(sergeyu): Specify connection error code when channel
   // connection fails.
   typedef base::Callback<void(net::StreamSocket*)> StreamChannelCallback;
   typedef base::Callback<void(net::Socket*)> DatagramChannelCallback;
 
   Session() { }
   virtual ~Session() { }
 
   // Set callback that is called when state of the connection is changed.
   // Must be called on the jingle thread only.
   virtual void SetStateChangeCallback(const StateChangeCallback& callback) = 0;
 
   // Returns error code for a failed session.
   virtual Error error() = 0;
 
   // Creates new channels for this connection. The specified callback
   // is called when then new channel is created and connected. The
   // callback is called with NULL if connection failed for any reason.
   // Ownership of the channel socket is given to the caller when the
   // callback is called. All channels must be destroyed before the
-  // session is destroyed. Can be called only when in CONNECTING or
-  // CONNECTED state.
+  // session is destroyed. Can be called only when in CONNECTING,
+  // CONNECTED or AUTHENTICATED states.
   virtual void CreateStreamChannel(
       const std::string& name, const StreamChannelCallback& callback) = 0;
   virtual void CreateDatagramChannel(
       const std::string& name, const DatagramChannelCallback& callback) = 0;
 
   // Cancels a pending CreateStreamChannel() or CreateDatagramChannel()
   // operation for the named channel. If the channel creation already
   // completed then cancelling it has no effect. When shutting down
   // this method must be called for each channel pending creation.
   virtual void CancelChannelCreation(const std::string& name) = 0;
@@ skipping 21 matching lines @@
   virtual void Close() = 0;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(Session);
 };
 
 }  // namespace protocol
 }  // namespace remoting
 
 #endif  // REMOTING_PROTOCOL_SESSION_H_