modem_gsm_card_proxy_interface.h

// Copyright (c) 2012 The Chromium OS 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 SHILL_MODEM_GSM_CARD_PROXY_INTERFACE_
#define SHILL_MODEM_GSM_CARD_PROXY_INTERFACE_

#include <string>

#include "shill/callbacks.h"

namespace shill {

class Error;
typedef base::Callback<void(const std::string &,
                            const Error &)> GSMIdentifierCallback;

// These are the methods that a ModemManager.Modem.Gsm.Card proxy must
// support. The interface is provided so that it can be mocked in tests.
// All calls are made asynchronously.
class ModemGSMCardProxyInterface {
 public:
  virtual ~ModemGSMCardProxyInterface() {}

  virtual void GetIMEI(Error *error, const GSMIdentifierCallback &callback,
                       int timeout) = 0;
  virtual void GetIMSI(Error *error, const GSMIdentifierCallback &callback,
                       int timeout) = 0;
  virtual void GetSPN(Error *error, const GSMIdentifierCallback &callback,
                      int timeout) = 0;
  virtual void GetMSISDN(Error *error, const GSMIdentifierCallback &callback,
                         int timeout) = 0;
  virtual void EnablePIN(const std::string &pin, bool enabled,
                         Error *error, const ResultCallback &callback,
                         int timeout) = 0;
  virtual void SendPIN(const std::string &pin,
                       Error *error, const ResultCallback &callback,
                       int timeout) = 0;
  virtual void SendPUK(const std::string &puk, const std::string &pin,
                       Error *error, const ResultCallback &callback,
                       int timeout) = 0;
  virtual void ChangePIN(const std::string &old_pin,
                         const std::string &new_pin,
                         Error *error, const ResultCallback &callback,
                         int timeout) = 0;

  // Properties.
  virtual uint32 EnabledFacilityLocks() = 0;
};

}  // namespace shill

#endif  // SHILL_MODEM_GSM_CARD_PROXY_INTERFACE_