Host extensions

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 <string>
 
 #include "base/memory/ref_counted.h"
+#include "base/memory/scoped_vector.h"
 #include "base/memory/weak_ptr.h"
 #include "base/sequenced_task_runner_helpers.h"
 #include "base/threading/non_thread_safe.h"
 #include "base/time/time.h"
 #include "base/timer/timer.h"
 #include "remoting/host/client_session_control.h"
 #include "remoting/host/gnubby_auth_handler.h"
+#include "remoting/host/host_extension.h"
+#include "remoting/host/host_extension_session.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"
@@ skipping 29 matching lines @@
     // Called after authentication has started.
     virtual void OnSessionAuthenticating(ClientSession* client) = 0;
 
     // Called after authentication has finished successfully. Returns true if
     // the connection is allowed, or false otherwise.
     virtual bool OnSessionAuthenticated(ClientSession* client) = 0;
 
     // Called after we've finished connecting all channels.
     virtual void OnSessionChannelsConnected(ClientSession* client) = 0;
 
+    // Called after client has reported capabilities.
+    virtual void OnClientCapabilities(ClientSession* client) = 0;

[Wez, 2014/05/28 23:03:41]

All the other handlers are OnSession<Foo>; OnSessionCapabilities or
OnSessionClientCapabilities, for consistency?

[dcaiafa, 2014/05/29 00:03:16]

Done.

+
     // Called after authentication has failed. Must not tear down this
     // object. OnSessionClosed() is notified after this handler
     // returns.
     virtual void OnSessionAuthenticationFailed(ClientSession* client) = 0;
 
     // Called after connection has failed or after the client closed it.
     virtual void OnSessionClosed(ClientSession* client) = 0;
 
     // Called to notify of each message's sequence number. The
     // callback must not tear down this object.
     virtual void OnSessionSequenceNumber(ClientSession* client,
                                          int64 sequence_number) = 0;
 
     // Called on notification of a route change event, when a channel is
     // connected.
     virtual void OnSessionRouteChange(
         ClientSession* client,
         const std::string& channel_name,
         const protocol::TransportRoute& route) = 0;
 
    protected:
     virtual ~EventHandler() {}
   };
 
-  // |event_handler| and |desktop_environment_factory| must outlive |this|.
+  // |event_handler|, |desktop_environment_factory| must outlive |this|.

[Wez, 2014/05/28 23:03:41]

nit: , -> and

[dcaiafa, 2014/05/29 00:03:16]

Done.

   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,
       scoped_refptr<protocol::PairingRegistry> pairing_registry);
   virtual ~ClientSession();
 
+  // Adds an extension to client to handle extension messages.
+  void AddExtensionSession(scoped_ptr<HostExtensionSession> extension_session);
+
+  // Adds one or more host capabilities in the form of a space-separated list of
+  // words, to be reported to the client.
+  // This must be called during the call to |OnSessionAuthenticated|.
+  void AddHostCapabilities(const std::string& capability);
+
   // protocol::HostStub interface.
   virtual void NotifyClientResolution(
       const protocol::ClientResolution& resolution) OVERRIDE;
   virtual void ControlVideo(
       const protocol::VideoControl& video_control) OVERRIDE;
   virtual void ControlAudio(
       const protocol::AudioControl& audio_control) OVERRIDE;
   virtual void SetCapabilities(
       const protocol::Capabilities& capabilities) OVERRIDE;
   virtual void RequestPairing(
@@ skipping 25 matching lines @@
   virtual void SetDisableInputs(bool disable_inputs) OVERRIDE;
 
   void SetGnubbyAuthHandlerForTesting(GnubbyAuthHandler* gnubby_auth_handler);
 
   protocol::ConnectionToClient* connection() const {
     return connection_.get();
   }
 
   bool is_authenticated() { return auth_input_filter_.enabled();  }
 
+  const std::string* client_capabilities() const {
+    return client_capabilities_.get();
+  }
+
  private:
+  typedef ScopedVector<HostExtensionSession> HostExtensionSessionList;
+
   // Creates a proxy for sending clipboard events to the client.
   scoped_ptr<protocol::ClipboardStub> CreateClipboardProxy();
 
   // 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);
@@ skipping 75 matching lines @@
 
   // Used to apply client-requested changes in screen resolution.
   scoped_ptr<ScreenControls> screen_controls_;
 
   // The pairing registry for PIN-less authentication.
   scoped_refptr<protocol::PairingRegistry> pairing_registry_;
 
   // Used to proxy gnubby auth traffic.
   scoped_ptr<GnubbyAuthHandler> gnubby_auth_handler_;
 
+  // Host extension sessions, used to handle extension messages.
+  HostExtensionSessionList extension_sessions_;
+
   DISALLOW_COPY_AND_ASSIGN(ClientSession);
 };
 
 }  // namespace remoting
 
 #endif  // REMOTING_HOST_CLIENT_SESSION_H_