Making DesktopEnvironment a factory class used by ClientSession to create audio/video capturers and…

remoting/host/client_session.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 REMOTING_HOST_CLIENT_SESSION_H_
 #define REMOTING_HOST_CLIENT_SESSION_H_
 
 #include <list>
 
 #include "base/memory/ref_counted.h"
+#include "base/memory/weak_ptr.h"
 #include "base/sequenced_task_runner_helpers.h"
 #include "base/time.h"
 #include "base/timer.h"
 #include "base/threading/non_thread_safe.h"
 #include "remoting/host/mouse_clamping_filter.h"
 #include "remoting/host/remote_input_filter.h"
 #include "remoting/protocol/clipboard_echo_filter.h"
 #include "remoting/protocol/clipboard_filter.h"
 #include "remoting/protocol/clipboard_stub.h"
 #include "remoting/protocol/connection_to_client.h"
 #include "remoting/protocol/host_stub.h"
 #include "remoting/protocol/input_event_tracker.h"
 #include "remoting/protocol/input_filter.h"
 #include "remoting/protocol/input_stub.h"
 #include "third_party/skia/include/core/SkPoint.h"
 #include "third_party/skia/include/core/SkSize.h"
 
 namespace base {
 class SingleThreadTaskRunner;
 }  // namespace base
 
 namespace remoting {
 
 class AudioEncoder;
 class AudioScheduler;
 struct ClientSessionTraits;
 class DesktopEnvironment;
 class DesktopEnvironmentFactory;
+class EventExecutor;
 class VideoEncoder;
-class VideoFrameCapturer;
 class VideoScheduler;
 
 // A ClientSession keeps a reference to a connection to a client, and maintains
 // per-client state.
 class ClientSession
     : public base::RefCountedThreadSafe<ClientSession, ClientSessionTraits>,
       public protocol::HostStub,
       public protocol::ConnectionToClient::EventHandler,
       public base::NonThreadSafe {
  public:
@@ skipping 33 matching lines @@
 
    protected:
     virtual ~EventHandler() {}
   };
 
   // |event_handler| must outlive |this|. |desktop_environment_factory| is only
   // used by the constructor to create an instance of DesktopEnvironment.
   ClientSession(
       EventHandler* event_handler,
       scoped_refptr<base::SingleThreadTaskRunner> audio_task_runner,
+      scoped_refptr<base::SingleThreadTaskRunner> input_task_runner,
       scoped_refptr<base::SingleThreadTaskRunner> video_capture_task_runner,
       scoped_refptr<base::SingleThreadTaskRunner> video_encode_task_runner,
       scoped_refptr<base::SingleThreadTaskRunner> network_task_runner,
+      scoped_refptr<base::SingleThreadTaskRunner> ui_task_runner,
       scoped_ptr<protocol::ConnectionToClient> connection,
       DesktopEnvironmentFactory* desktop_environment_factory,
       const base::TimeDelta& max_duration);
 
   // protocol::HostStub interface.
   virtual void NotifyClientDimensions(
       const protocol::ClientDimensions& dimensions) OVERRIDE;
   virtual void ControlVideo(
       const protocol::VideoControl& video_control) OVERRIDE;
   virtual void ControlAudio(
@@ skipping 11 matching lines @@
   virtual void OnRouteChange(
       protocol::ConnectionToClient* connection,
       const std::string& channel_name,
       const protocol::TransportRoute& route) OVERRIDE;
 
   // Disconnects the session, tears down transport resources and stops scheduler
   // components. |event_handler_| is guaranteed not to be called after this
   // method returns.
   void Disconnect();
 
-  // Stops the ClientSession, and calls |stopped_task| on |network_task_runner_|
-  // when fully stopped.
-  void Stop(const base::Closure& stopped_task);
+  // Stops the ClientSession.

[Wez, 2013/01/11 02:23:41]

Clarify that the semantics; once ClientSession is stopped the caller can
presumably safely tear-down things like the EventHandler?

[alexeypa (please no reviews), 2013/01/11 19:59:46]

Done.

+  void Stop();
 
   protocol::ConnectionToClient* connection() const {
     return connection_.get();
   }
 
   const std::string& client_jid() { return client_jid_; }
 
   bool is_authenticated() { return auth_input_filter_.enabled();  }
 
   // Indicate that local mouse activity has been detected. This causes remote
   // inputs to be ignored for a short time so that the local user will always
   // have the upper hand in 'pointer wars'.
   void LocalMouseMoved(const SkIPoint& new_pos);
 
   // Disable handling of input events from this client. If the client has any
   // keys or mouse buttons pressed then these will be released.
   void SetDisableInputs(bool disable_inputs);
 
  private:
   friend class base::DeleteHelper<ClientSession>;
   friend struct ClientSessionTraits;
   virtual ~ClientSession();
 
   // Creates a proxy for sending clipboard events to the client.
   scoped_ptr<protocol::ClipboardStub> CreateClipboardProxy();
 
-  void OnRecorderStopped();
-
   // Creates an audio encoder for the specified configuration.
   static scoped_ptr<AudioEncoder> CreateAudioEncoder(
       const protocol::SessionConfig& config);
 
   // Creates a video encoder for the specified configuration.
   static scoped_ptr<VideoEncoder> CreateVideoEncoder(
       const protocol::SessionConfig& config);
 
   EventHandler* event_handler_;
 
   // The connection to the client.
   scoped_ptr<protocol::ConnectionToClient> connection_;
 
   // Used to disable callbacks to |connection_| once it is disconnected.
   base::WeakPtrFactory<protocol::ConnectionToClient> connection_factory_;
 
+  std::string client_jid_;
+
   // The desktop environment used by this session.
   scoped_ptr<DesktopEnvironment> desktop_environment_;
 
-  std::string client_jid_;
-
   // Filter used as the final element in the input pipeline.
   protocol::InputFilter host_input_filter_;
 
   // Tracker used to release pressed keys and buttons when disconnecting.
   protocol::InputEventTracker input_tracker_;
 
   // Filter used to disable remote inputs during local input activity.
   RemoteInputFilter remote_input_filter_;
 
   // Filter used to clamp mouse events to the current display dimensions.
@@ skipping 19 matching lines @@
 
   // The maximum duration of this session.
   // There is no maximum if this value is <= 0.
   base::TimeDelta max_duration_;
 
   // A timer that triggers a disconnect when the maximum session duration
   // is reached.
   base::OneShotTimer<ClientSession> max_duration_timer_;
 
   scoped_refptr<base::SingleThreadTaskRunner> audio_task_runner_;
+  scoped_refptr<base::SingleThreadTaskRunner> input_task_runner_;
   scoped_refptr<base::SingleThreadTaskRunner> video_capture_task_runner_;
   scoped_refptr<base::SingleThreadTaskRunner> video_encode_task_runner_;
   scoped_refptr<base::SingleThreadTaskRunner> network_task_runner_;
+  scoped_refptr<base::SingleThreadTaskRunner> ui_task_runner_;
 
   // Schedulers for audio and video capture.
   scoped_refptr<AudioScheduler> audio_scheduler_;
   scoped_refptr<VideoScheduler> video_scheduler_;
 
-  // Number of screen recorders and audio schedulers that are currently being
-  // used or shutdown. Used to delay shutdown if one or more
-  // recorders/schedulers are asynchronously shutting down.
-  int active_recorders_;
-
-  // Task to execute once the session is completely stopped.
-  base::Closure stopped_task_;
+  scoped_ptr<EventExecutor> event_executor_;
 
   DISALLOW_COPY_AND_ASSIGN(ClientSession);
 };
 
 // Destroys |ClienSession| instances on the network thread.
 struct ClientSessionTraits {
   static void Destruct(const ClientSession* client);
 };
 
 }  // namespace remoting
 
 #endif  // REMOTING_HOST_CLIENT_SESSION_H_