iOS Chromoting Client

remoting/ios/bridge/client_bridge.h

-// Copyright 2013 The Chromium Authors. All rights reserved.
+// Copyright 2014 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_CLIENT_JNI_CHROMOTING_JNI_RUNTIME_H_
-#define REMOTING_CLIENT_JNI_CHROMOTING_JNI_RUNTIME_H_
+#ifndef REMOTING_IOS_BRIDGE_CLIENT_BRIDGE_H_
+#define REMOTING_IOS_BRIDGE_CLIENT_BRDIGE_H_
 
-#include <jni.h>
 #include <string>
 
-#include "base/android/scoped_java_ref.h"
-#include "base/at_exit.h"
+#include "base/memory/ref_counted.h"
+#include "base/message_loop/message_loop.h"
 #include "net/url_request/url_request_context_getter.h"
 #include "remoting/base/auto_thread.h"
-#include "remoting/client/jni/chromoting_jni_instance.h"
 #include "remoting/protocol/connection_to_host.h"
+#include "third_party/webrtc/modules/desktop_capture/desktop_frame.h"
 
-template<typename T> struct DefaultSingletonTraits;
+#include "remoting/ios/bridge/client_instance.h"
+#include "remoting/ios/bridge/frame_consumer_bridge_callback.h"
+
+#if defined(__OBJC__)
+@class ClientController;
+#else   // __OBJC__
+class ClientController;
+#endif  // __OBJC__
 
 namespace remoting {
 
-bool RegisterJni(JNIEnv* env);
+// Houses the global resources on which the Chromoting components run
+// (e.g. message loops and task runners). Proxies outgoing OBJ_C calls from its
+// ClientInstance member to C++. All its methods should be invoked
+// exclusively from the UI thread unless otherwise noted.
+class ClientBridge : public base::RefCounted<ClientBridge> {

[dcaiafa, 2014/03/19 01:14:15]

Does it really need to be ref-counted? I would prefer if it had a clear owner,
like ClientController. See client_instance.h for comments on an a circular
reference between ClientBridge and ClientInstance.

[aboone, 2014/03/21 16:42:07]

Changed to a SupportWeakPtr<>

+ public:
+  ClientBridge();
 
-// Houses the global resources on which the Chromoting components run
-// (e.g. message loops and task runners). Proxies outgoing JNI calls from its
-// ChromotingJniInstance member to Java. All its methods should be invoked
-// exclusively from the UI thread unless otherwise noted.
-class ChromotingJniRuntime {
- public:
-  // This class is instantiated at process initialization and persists until
-  // we close. Its components are reused across |ChromotingJniInstance|s.
-  static ChromotingJniRuntime* GetInstance();
+  // Forces a DisconnectFromHost() in case there is any active or failed
+  // connection, then proceeds to tear down the Chromium dependencies on which
+  // all sessions depended.
+  virtual ~ClientBridge();

[dcaiafa, 2014/03/19 01:14:15]

Make destructor private, and friend base::RefCounted<ClientBridge>. See
ref_counted.h for details.

[aboone, 2014/03/21 16:42:07]

Requirements after change to using a WeakPtr are different, so I don't think
this comment is relevent now

 
   scoped_refptr<AutoThreadTaskRunner> ui_task_runner() {
     return ui_task_runner_;
   }
 
   scoped_refptr<AutoThreadTaskRunner> network_task_runner() {
     return network_task_runner_;
   }
 
-  scoped_refptr<AutoThreadTaskRunner> display_task_runner() {
-    return display_task_runner_;
-  }
-
   scoped_refptr<net::URLRequestContextGetter> url_requester() {
     return url_requester_;
   }
 
   // Initiates a connection with the specified host. Only call when a host
   // connection is active (i.e. between a call to Connect() and the
   // corresponding call to Disconnect()). To skip the attempt at pair-based
   // authentication, leave |pairing_id| and |pairing_secret| as empty strings.
   void ConnectToHost(const char* username,
                      const char* auth_token,
                      const char* host_jid,
                      const char* host_id,
                      const char* host_pubkey,
                      const char* pairing_id,
-                     const char* pairing_secret);
+                     const char* pairing_secret,
+                     ClientController* controller);
 
   // Terminates any ongoing connection attempt and cleans up by nullifying
   // |session_|. This is a no-op unless |session| is currently non-null.
   void DisconnectFromHost();
 
   // Returns the client for the currently-active session. Do not call if
   // |session| is null.
-  scoped_refptr<ChromotingJniInstance> session() {
+  scoped_refptr<ClientInstance> session() {
     DCHECK(session_);
     return session_;
   }
 
   // Notifies the user of the current connection status. Call on UI thread.
   void ReportConnectionStatus(protocol::ConnectionToHost::State state,
                               protocol::ErrorCode error);
 
   // Pops up a dialog box asking the user to enter a PIN. Call on UI thread.
   void DisplayAuthenticationPrompt(bool pairing_supported);
 
   // Saves new pairing credentials to permanent storage. Call on UI thread.
   void CommitPairingCredentials(const std::string& host,
                                 const std::string& id,
                                 const std::string& secret);
 
-  // Creates a new Bitmap object to store a video frame.
-  base::android::ScopedJavaLocalRef<jobject> NewBitmap(
-      webrtc::DesktopSize size);
-
-  // Updates video frame bitmap. |bitmap| must be an instance of
-  // android.graphics.Bitmap. Call on the display thread.
-  void UpdateFrameBitmap(jobject bitmap);
-
   // Updates cursor shape. Call on display thread.

[dcaiafa, 2014/03/19 01:14:15]

nit: There doesn't seem to be a display thread like in the Android counterpart.
Should it be the UI thread instead? Here and below.

[aboone, 2014/03/21 16:42:07]

Done.

   void UpdateCursorShape(const protocol::CursorShapeInfo& cursor_shape);
 
   // Draws the latest image buffer onto the canvas. Call on the display thread.
-  void RedrawCanvas();
+  void RedrawCanvas(const webrtc::DesktopSize& view_size,
+                    webrtc::DesktopFrame* buffer,
+                    const webrtc::DesktopRegion& region);
+
+  FrameConsumerBridgeCallback BindToFrameConsumerBridgeCallback();
 
  private:
-  ChromotingJniRuntime();
-
-  // Forces a DisconnectFromHost() in case there is any active or failed
-  // connection, then proceeds to tear down the Chromium dependencies on which
-  // all sessions depended. Because destruction only occurs at application exit
-  // after all connections have terminated, it is safe to make unretained
-  // cross-thread calls on the class.
-  virtual ~ChromotingJniRuntime();
-
-  // Detaches JVM from the current thread, then signals. Doesn't own |waiter|.
+  // Detaches OBJ_C from the current thread, then signals. Doesn't own |waiter|.
   void DetachFromVmAndSignal(base::WaitableEvent* waiter);
 
-  // Used by the Chromium libraries to clean up the base and net libraries' JNI
-  // bindings. It must persist for the lifetime of the singleton.
-  scoped_ptr<base::AtExitManager> at_exit_manager_;
-
-  // Chromium code's connection to the Java message loop.
+  // Chromium code's connection to the OBJ_C message loop.
   scoped_ptr<base::MessageLoopForUI> ui_loop_;
 
   // References to native threads.
   scoped_refptr<AutoThreadTaskRunner> ui_task_runner_;
   scoped_refptr<AutoThreadTaskRunner> network_task_runner_;
-  scoped_refptr<AutoThreadTaskRunner> display_task_runner_;
 
   scoped_refptr<net::URLRequestContextGetter> url_requester_;
 
-  // Contains all connection-specific state.
-  scoped_refptr<ChromotingJniInstance> session_;
+  // Contains connection-specific state.
+  scoped_refptr<ClientInstance> session_;
 
-  friend struct DefaultSingletonTraits<ChromotingJniRuntime>;
+  // Ponter to the OBJ_C side of the bridge
+  ClientController* controller_;
 
-  DISALLOW_COPY_AND_ASSIGN(ChromotingJniRuntime);
+  DISALLOW_COPY_AND_ASSIGN(ClientBridge);
 };
 
 }  // namespace remoting
 
-#endif
+#endif  // REMOTING_IOS_BRIDGE_CLIENT_BRDIGE_H_