cellular/modem_cdma_proxy_interface.h

//
// Copyright (C) 2011 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

#ifndef SHILL_CELLULAR_MODEM_CDMA_PROXY_INTERFACE_H_
#define SHILL_CELLULAR_MODEM_CDMA_PROXY_INTERFACE_H_

#include <string>

#include "shill/callbacks.h"

namespace shill {

class Error;

using SignalQualitySignalCallback = base::Callback<void(uint32_t)>;
using RegistrationStateSignalCallback =
    base::Callback<void(uint32_t, uint32_t)>;
using ActivationResultCallback = base::Callback<void(uint32_t, const Error&)>;
using SignalQualityCallback = base::Callback<void(uint32_t, const Error&)>;
using RegistrationStateCallback =
    base::Callback<void(uint32_t, uint32_t, const Error&)>;

// These are the methods that a ModemManager.Modem.CDMA proxy must support.
// The interface is provided so that it can be mocked in tests.
// All calls are made asynchronously. Call completion is signalled via
// the callbacks passed to the methods.
class ModemCdmaProxyInterface {
 public:
  virtual ~ModemCdmaProxyInterface() {}

  virtual void Activate(const std::string& carrier, Error* error,
                        const ActivationResultCallback& callback,
                        int timeout) = 0;
  virtual void GetRegistrationState(Error* error,
                                    const RegistrationStateCallback& callback,
                                    int timeout) = 0;
  virtual void GetSignalQuality(Error* error,
                                const SignalQualityCallback& callback,
                                int timeout) = 0;

  // Properties.
  virtual const std::string MEID() = 0;

  virtual void set_activation_state_callback(
      const ActivationStateSignalCallback& callback) = 0;
  virtual void set_signal_quality_callback(
      const SignalQualitySignalCallback& callback) = 0;
  virtual void set_registration_state_callback(
      const RegistrationStateSignalCallback& callback) = 0;
};

}  // namespace shill

#endif  // SHILL_CELLULAR_MODEM_CDMA_PROXY_INTERFACE_H_