[cast_channel] Make CastSocket not inherit from ApiResource

extensions/browser/api/cast_channel/cast_socket.h

 // 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 EXTENSIONS_BROWSER_API_CAST_CHANNEL_CAST_SOCKET_H_
 #define EXTENSIONS_BROWSER_API_CAST_CHANNEL_CAST_SOCKET_H_
 
 #include <stdint.h>
 
 #include <queue>
 #include <string>
 
 #include "base/cancelable_callback.h"
 #include "base/gtest_prod_util.h"
 #include "base/macros.h"
 #include "base/memory/ref_counted.h"
 #include "base/threading/thread_checker.h"
 #include "base/timer/timer.h"
-#include "extensions/browser/api/api_resource.h"
-#include "extensions/browser/api/api_resource_manager.h"
 #include "extensions/browser/api/cast_channel/cast_auth_util.h"
 #include "extensions/browser/api/cast_channel/cast_socket.h"
 #include "extensions/browser/api/cast_channel/cast_transport.h"
 #include "extensions/common/api/cast_channel.h"
 #include "extensions/common/api/cast_channel/logging.pb.h"
 #include "net/base/completion_callback.h"
 #include "net/base/io_buffer.h"
 #include "net/base/ip_endpoint.h"
 #include "net/log/net_log_source.h"
 
@@ skipping 20 matching lines @@
 enum CastDeviceCapability {
   NONE = 0,
   VIDEO_OUT = 1 << 0,
   VIDEO_IN = 1 << 1,
   AUDIO_OUT = 1 << 2,
   AUDIO_IN = 1 << 3,
   DEV_MODE = 1 << 4
 };
 
 // Public interface of the CastSocket class.
-class CastSocket : public ApiResource {
+class CastSocket {
  public:
-  explicit CastSocket(const std::string& owner_extension_id);
-  ~CastSocket() override {}
+  explicit CastSocket();
+  virtual ~CastSocket() {}
 
   // Used by BrowserContextKeyedAPIFactory.
   static const char* service_name() { return "CastSocketImplManager"; }
 
   // Connects the channel to the peer. If successful, the channel will be in
   // READY_STATE_OPEN.  DO NOT delete the CastSocket object in |callback|.
   // Instead use Close().
   // |callback| will be invoked with any ChannelError that occurred, or
   // CHANNEL_ERROR_NONE if successful.
   // If the CastSocket is destroyed while the connection is pending, |callback|
   // will be invoked with CHANNEL_ERROR_UNKNOWN. In this case, invoking
   // |callback| must not result in any re-entrancy behavior.
   // |delegate| receives message receipt and error events.
   // Ownership of |delegate| is transferred to this CastSocket.
   virtual void Connect(std::unique_ptr<CastTransport::Delegate> delegate,
                        base::Callback<void(ChannelError)> callback) = 0;
 
   // Closes the channel if not already closed. On completion, the channel will
   // be in READY_STATE_CLOSED.
   //
   // It is fine to delete this object in |callback|.
   virtual void Close(const net::CompletionCallback& callback) = 0;
 
   // The IP endpoint for the destination of the channel.
   virtual const net::IPEndPoint& ip_endpoint() const = 0;
 
-  // Channel id generated by the ApiResourceManager.
+  // Channel id generated by the CastChannelService.
   virtual int id() const = 0;
 
-  // Sets the channel id generated by ApiResourceManager.
+  // Sets the channel id generated by CastChannelService.
   virtual void set_id(int id) = 0;
 
   // The authentication level requested for the channel.
   virtual ChannelAuthType channel_auth() const = 0;
 
   // The ready state of the channel.
   virtual ReadyState ready_state() const = 0;
 
   // Returns the last error that occurred on this channel, or
   // CHANNEL_ERROR_NONE if no error has occurred.
   virtual ChannelError error_state() const = 0;
 
   // True when keep-alive signaling is handled for this socket.
   virtual bool keep_alive() const = 0;
 
   // Whether the channel is audio only as identified by the device
   // certificate during channel authentication.
   virtual bool audio_only() const = 0;
 
+  virtual const std::string& owner_extension_id() const = 0;

[mark a. foltz, 2017/05/18 19:12:05]

Is this still necessary?  I think this is only used by ApiResourceManager but I
could be wrong.

Since we'll have sockets created by the browser (and not any extension), this
will eventually be empty (and possibly unused).

[zhaobin, 2017/05/24 01:51:40]

Still needed when dispatch UI event...

https://cs.chromium.org/chromium/src/extensions/browser/api/cast_channel/cast...

[imcheng, 2017/05/24 20:24:32]

Can we just use extension_->id() (which is used to populate owner_extension_id)
in the ExtensionFunction class?

[zhaobin, 2017/05/24 22:15:07]

Done.

+
   // Marks a socket as invalid due to an error, and sends an OnError
   // event to |delegate_|.
   // The OnError event receipient is responsible for closing the socket in the
   // event of an error.
   // Setting the error state does not close the socket if it is open.
   virtual void SetErrorState(ChannelError error_state) = 0;
 
   // Returns a pointer to the socket's message transport layer. Can be used to
   // send and receive CastMessages over the socket.
   virtual CastTransport* transport() const = 0;
-
-  // Tells the ApiResourceManager to retain CastSocket objects even
-  // if their corresponding extension is suspended.
-  // (CastSockets are still deleted if the extension is removed entirely from
-  // the browser.)
-  bool IsPersistent() const override;
 };
 
 // This class implements a channel between Chrome and a Cast device using a TCP
 // socket with SSL.  The channel may authenticate that the receiver is a genuine
 // Cast device.  All CastSocketImpl objects must be used only on the IO thread.
 //
 // NOTE: Not called "CastChannel" to reduce confusion with the generated API
 // code.
 class CastSocketImpl : public CastSocket {
  public:
@@ skipping 38 matching lines @@
   CastTransport* transport() const override;
   void Close(const net::CompletionCallback& callback) override;
   const net::IPEndPoint& ip_endpoint() const override;
   int id() const override;
   void set_id(int channel_id) override;
   ChannelAuthType channel_auth() const override;
   ReadyState ready_state() const override;
   ChannelError error_state() const override;
   bool keep_alive() const override;
   bool audio_only() const override;
+  const std::string& owner_extension_id() const override;
 
   // Required by ApiResourceManager.
   static const char* service_name() { return "CastSocketManager"; }
 
  protected:
   // CastTransport::Delegate methods for receiving handshake messages.
   class AuthTransportDelegate : public CastTransport::Delegate {
    public:
     explicit AuthTransportDelegate(CastSocketImpl* socket);
 
@@ skipping 24 matching lines @@
   // capability must not have a certificate with audio only policy.
   bool VerifyChannelPolicy(const AuthResult& result);
 
  private:
   FRIEND_TEST_ALL_PREFIXES(CastSocketTest, TestConnectAuthMessageCorrupted);
   FRIEND_TEST_ALL_PREFIXES(CastSocketTest,
                            TestConnectChallengeReplyReceiveError);
   FRIEND_TEST_ALL_PREFIXES(CastSocketTest,
                            TestConnectChallengeVerificationFails);
   friend class AuthTransportDelegate;
-  friend class ApiResourceManager<CastSocketImpl>;
   friend class CastSocketTest;
   friend class TestCastSocket;
 
   void SetErrorState(ChannelError error_state) override;
 
   // Frees resources and cancels pending callbacks.  |ready_state_| will be set
   // READY_STATE_CLOSED on completion.  A no-op if |ready_state_| is already
   // READY_STATE_CLOSED.
   void CloseInternal();
 
@@ skipping 158 matching lines @@
   // information.
   AuthTransportDelegate* auth_delegate_;
 
   DISALLOW_COPY_AND_ASSIGN(CastSocketImpl);
 };
 }  // namespace cast_channel
 }  // namespace api
 }  // namespace extensions
 
 #endif  // EXTENSIONS_BROWSER_API_CAST_CHANNEL_CAST_SOCKET_H_