Add JavaDebug mode API
[barry.git] / doc / Exceptions
blob92c2fa3e634e221efacfcacbbb1a1b9c8b6597e9
2 The Barry library has the following exception hierarchy:
4 - std::exception
5         - std::logic_error
6         - std::runtime_error
7                 - Barry::Error
8                         - Usb::Error
9                                 - Usb::Timeout
10                         - Barry::BadPassword
11                         - Barry::BadData
12                         - Barry::BadSize
13                         - Barry::ErrnoError
14                         - Barry::BadPackedFormat
15                         - Barry::BadPacket
17 Usb::Error
18         All specific USB error exceptions will be derived from
19         this class.  Where possible, this class also stores the
20         specific return code from the libusb API, to allow
21         fine grained error handling.
23 Barry::Error
24         All specific Barry error exceptions will be derived from
25         this class.  This can be thrown from anywhere inside Barry.
27 std::bad_alloc
28         There is also the remote possibility that there will be memory
29         exceptions from a call to 'new'.  In that case, std::bad_alloc
30         will be thrown by the standard C++ libraries.  Barry does not
31         catch these errors.
33 std::logic_error
34         Assert-like errors will cause std::logic_error to be thrown.
35         Barry does sometimes throw these, but they should be be
36         exceedingly rare.
38 All of the above exceptions (from std, Barry, and Usb namespaces)
39 are derived from std::exception, so they can all be caught in one
40 statement for the efficient and lazy. :-)