| 1 | <?xml version="1.0" encoding="utf-8"?> |
|---|
| 2 | <!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN" |
|---|
| 3 | "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd" [ |
|---|
| 4 | <!ENTITY % thread.entities SYSTEM "entities.xml"> |
|---|
| 5 | %thread.entities; |
|---|
| 6 | ]> |
|---|
| 7 | <!-- Copyright (c) 2002-2003 William E. Kempf, Michael Glassford |
|---|
| 8 | Subject to the Boost Software License, Version 1.0. |
|---|
| 9 | (See accompanying file LICENSE-1.0 or http://www.boost.org/LICENSE-1.0) |
|---|
| 10 | --> |
|---|
| 11 | <header name="boost/thread/exceptions.hpp" |
|---|
| 12 | last-revision="$Date: 2006/10/15 14:52:53 $"> |
|---|
| 13 | <namespace name="boost"> |
|---|
| 14 | <class name="lock_error"> |
|---|
| 15 | <purpose> |
|---|
| 16 | <simpara>The lock_error class defines an exception type thrown |
|---|
| 17 | to indicate a locking related error has been detected.</simpara> |
|---|
| 18 | </purpose> |
|---|
| 19 | |
|---|
| 20 | <description> |
|---|
| 21 | <simpara>Examples of errors indicated by a lock_error exception |
|---|
| 22 | include a lock operation which can be determined to result in a |
|---|
| 23 | deadlock, or unlock operations attempted by a thread that does |
|---|
| 24 | not own the lock.</simpara> |
|---|
| 25 | </description> |
|---|
| 26 | |
|---|
| 27 | <inherit access="public"> |
|---|
| 28 | <type><classname>std::logical_error</classname></type> |
|---|
| 29 | </inherit> |
|---|
| 30 | |
|---|
| 31 | <constructor> |
|---|
| 32 | <effects><simpara>Constructs a <code>lock_error</code> object. |
|---|
| 33 | </simpara></effects> |
|---|
| 34 | </constructor> |
|---|
| 35 | </class> |
|---|
| 36 | |
|---|
| 37 | <class name="thread_resource_error"> |
|---|
| 38 | <purpose> |
|---|
| 39 | <simpara>The <classname>thread_resource_error</classname> class |
|---|
| 40 | defines an exception type that is thrown by constructors in the |
|---|
| 41 | &Boost.Thread; library when thread-related resources can not be |
|---|
| 42 | acquired.</simpara> |
|---|
| 43 | </purpose> |
|---|
| 44 | |
|---|
| 45 | <description> |
|---|
| 46 | <simpara><classname>thread_resource_error</classname> is used |
|---|
| 47 | only when thread-related resources cannot be acquired; memory |
|---|
| 48 | allocation failures are indicated by |
|---|
| 49 | <classname>std::bad_alloc</classname>.</simpara> |
|---|
| 50 | </description> |
|---|
| 51 | |
|---|
| 52 | <inherit access="public"> |
|---|
| 53 | <type><classname>std::runtime_error</classname></type> |
|---|
| 54 | </inherit> |
|---|
| 55 | |
|---|
| 56 | <constructor> |
|---|
| 57 | <effects><simpara>Constructs a <code>thread_resource_error</code> |
|---|
| 58 | object.</simpara></effects> |
|---|
| 59 | </constructor> |
|---|
| 60 | </class> |
|---|
| 61 | </namespace> |
|---|
| 62 | </header> |
|---|