src/error.h

   1 ///
   2 /// \file       error.h
   3 ///             Common exception classes for the Barry library
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2007, Net Direct Inc. (http://www.netdirect.ca/)
   8
   9     This program is free software; you can redistribute it and/or modify
  10     it under the terms of the GNU General Public License as published by
  11     the Free Software Foundation; either version 2 of the License, or
  12     (at your option) any later version.
  13
  14     This program is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  17
  18     See the GNU General Public License in the COPYING file at the
  19     root directory of this project for more details.
  20 */
  21
  22 #ifndef __BARRY_ERROR_H__
  23 #define __BARRY_ERROR_H__
  24
  25 #include <stdexcept>
  26
  27 namespace Barry {
  28
  29 /// \addtogroup exceptions
  30 /// @{
  31
  32 //
  33 // Error class
  34 //
  35 /// The base class for any future derived exceptions.
  36 /// Can be thrown on any protocol error.
  37 ///
  38 class Error : public std::runtime_error
  39 {
  40 public:
  41         Error(const std::string &str) : std::runtime_error(str) {}
  42         Error(int libusb_errno, const std::string &str);
  43 };
  44
  45
  46 //
  47 // BadPassword
  48 //
  49 /// A bad or unknown password when talking to the device.
  50 /// Can be thrown in the following instances:
  51 ///
  52 ///     - no password provided and the device requests one
  53 ///     - device rejected the available password
  54 ///     - too few remaining tries left... Barry will refuse to keep
  55 ///             trying passwords if there are fewer than
  56 ///             6 tries remaining.  In this case, out_of_tries()
  57 ///             will return true.
  58 ///
  59 ///
  60 class BadPassword : public Barry::Error
  61 {
  62         int m_remaining_tries;
  63         bool m_out_of_tries;
  64
  65 public:
  66         BadPassword(const std::string &str, int remaining_tries,
  67                 bool out_of_tries)
  68                 : Barry::Error(str),
  69                 m_remaining_tries(remaining_tries),
  70                 m_out_of_tries(out_of_tries)
  71                 {}
  72         int remaining_tries() const { return m_remaining_tries; }
  73         bool out_of_tries() const { return m_out_of_tries; }
  74 };
  75
  76 /// @}
  77
  78 } // namespace Barry
  79
  80 #endif
  81