chromium/chromeos/ash/components/dbus/shill/shill_third_party_vpn_driver_client.h

// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROMEOS_ASH_COMPONENTS_DBUS_SHILL_SHILL_THIRD_PARTY_VPN_DRIVER_CLIENT_H_
#define CHROMEOS_ASH_COMPONENTS_DBUS_SHILL_SHILL_THIRD_PARTY_VPN_DRIVER_CLIENT_H_

#include <stdint.h>
#include <string>
#include <vector>

#include "base/component_export.h"
#include "base/functional/callback.h"
#include "chromeos/ash/components/dbus/shill/shill_client_helper.h"

namespace base {
class Value;
}

namespace dbus {
class Bus;
}  // namespace dbus

namespace ash {

class ShillThirdPartyVpnObserver;

// ShillThirdPartyVpnDriverClient is used to communicate with the Shill
// ThirdPartyVpnDriver service.
// All methods should be called from the origin thread which initializes the
// DBusThreadManager instance.
class COMPONENT_EXPORT(SHILL_CLIENT) ShillThirdPartyVpnDriverClient {
 public:
  using ErrorCallback = ShillClientHelper::ErrorCallback;
  using StringCallback = ShillClientHelper::StringCallback;

  class TestInterface {
   public:
    virtual void OnPacketReceived(const std::string& object_path_value,
                                  const std::vector<char>& packet) = 0;
    virtual void OnPlatformMessage(const std::string& object_path_value,
                                   uint32_t message) = 0;

   protected:
    virtual ~TestInterface() = default;
  };

  // Creates and initializes the global instance. |bus| must not be null.
  static void Initialize(dbus::Bus* bus);

  // Creates the global instance with a fake implementation if not already
  // created (e.g. in a browser test setup), otherwise does nothing.
  static void InitializeFake();

  // Destroys the global instance which must have been initialized.
  static void Shutdown();

  // Returns the global instance if initialized. May return null.
  static ShillThirdPartyVpnDriverClient* Get();

  ShillThirdPartyVpnDriverClient(const ShillThirdPartyVpnDriverClient&) =
      delete;
  ShillThirdPartyVpnDriverClient& operator=(
      const ShillThirdPartyVpnDriverClient&) = delete;

  // Adds an |observer| for the third party vpn driver at |object_path_value|.
  virtual void AddShillThirdPartyVpnObserver(
      const std::string& object_path_value,
      ShillThirdPartyVpnObserver* observer) = 0;

  // Removes an |observer| for the third party vpn driver at
  // |object_path_value|.
  virtual void RemoveShillThirdPartyVpnObserver(
      const std::string& object_path_value) = 0;

  // Calls the SetParameters DBus method for |object_path_value| with
  // |parameters|. Invokes |callback| on success or |error_callback| on failure.
  virtual void SetParameters(const std::string& object_path_value,
                             const base::Value::Dict& parameters,
                             StringCallback callback,
                             ErrorCallback error_callback) = 0;

  // Calls UpdateConnectionState method.
  // |callback| is called after the method call succeeds.
  virtual void UpdateConnectionState(const std::string& object_path_value,
                                     const uint32_t connection_state,
                                     base::OnceClosure callback,
                                     ErrorCallback error_callback) = 0;

  // Calls SendPacket method.
  // |callback| is called after the method call succeeds.
  virtual void SendPacket(const std::string& object_path_value,
                          const std::vector<char>& ip_packet,
                          base::OnceClosure callback,
                          ErrorCallback error_callback) = 0;

  // Returns an interface for testing (stub only), or returns nullptr.
  virtual ShillThirdPartyVpnDriverClient::TestInterface* GetTestInterface() = 0;

 protected:
  friend class ShillThirdPartyVpnDriverClientTest;

  // Initialize/Shutdown should be used instead.
  ShillThirdPartyVpnDriverClient();
  virtual ~ShillThirdPartyVpnDriverClient();
};

}  // namespace ash

#endif  // CHROMEOS_ASH_COMPONENTS_DBUS_SHILL_SHILL_THIRD_PARTY_VPN_DRIVER_CLIENT_H_