diff --git a/doc/reference.html b/doc/reference.html
index be513cd..a451c82 100644
--- a/doc/reference.html
+++ b/doc/reference.html
@@ -39,6 +39,7 @@
Introduction
Macros
+ Deprecated names
Header <boost/system/error_code.hpp>
Class error_category
Class error_category synopsis
@@ -57,6 +58,8 @@
Class error_condition constructors
Class error_condition modifiers
Class error_condition observers
+ throws object
+ Semantics of throws object
Non-member functions
Header <boost/system/system_error.hpp>
Class system_error
@@ -114,6 +117,45 @@ provided, so users may ignore these macros if they prefer.
| Deprecated features are excluded. |
+
+In the process of adding Boost.System to C++0x standard library, some of the
+names are being changed. To ease transition, Boost.System deprecates the old
+names, but continues to provide them unless macro BOOST_SYSTEM_NO_DEPRECATED
+is defined.
+
+
+ | Old name, now deprecated |
+ New name |
+
+
+ namespace posix |
+ namespace errc |
+
+
+ namespace posix_error |
+ namespace errc |
+
+
+ enum posix_errno |
+ enum errc_t |
+
+
+ get_posix_category() |
+ get_generic_category() |
+
+
+ posix_category |
+ generic_category |
+
+
+ errno_ecat |
+ generic_category |
+
+
+ native_ecat |
+ system_category |
+
+
<boost/system/error_code.hpp> synopsis
@@ -223,6 +265,11 @@ provided, so users may ignore these macros if they prefer.
template<> struct is_error_condition_enum<errc::errc_t>
{ static const bool value = true; };
+ // predefined error_code object used as "throw on error" tag
+ extern error_code throws;
+
+ // non-member functions
+
bool operator==( const error_code & lhs, const error_code & rhs );
bool operator==( const error_code & code, const error_condition & condition );
bool operator==( const error_condition & condition, const error_code & code );
@@ -279,7 +326,7 @@ types should create a single object of each such type.
virtual ~error_category();
virtual const char * name() const = 0;
- virtual string message( error_code::value_type ev ) const = 0;
+ virtual string message( int ev ) const = 0;
virtual error_condition default_error_condition( int ev ) const;
virtual bool equivalent( int code, const error_condition & condition ) const;
virtual bool equivalent( const error_code & code, int condition ) const;
@@ -305,7 +352,7 @@ this subclause.
Returns: a string naming the error category.
Throws: Nothing.
-virtual string message( error_code::value_type ev ) const=0;
+virtual string message( int ev ) const=0;
Returns: A string that describes the error denoted by
ev.
@@ -370,7 +417,7 @@ non-member functions
Predefined objects system_category
-and generic_category identify operating system error codes and portable error conditions, respectively.
+and generic_category identify system specific error codes and portable error conditions, respectively.
The class error_code describes an object used to hold error code
@@ -392,7 +439,7 @@ error_code synopsis
error_code();
error_code( val, const error_category & cat );
template <class ErrorCodeEnum>
- error_code( errorCodeEnum e,
+ error_code( ErrorCodeEnum e,
typename enable_if<is_error_code_enum<ErrorCodeEnum> >::type* = 0);
// modifiers:
@@ -411,7 +458,7 @@ error_code synopsis
private:
int val_; // exposition only
- const error_category & cat_; // exposition only
+ const error_category * cat_; // exposition only
};
}
}
@@ -442,7 +489,7 @@ error_code constructors
error_code modifiers
void assign( int val, const error_category & cat );
- Postconditions: val_ == val && cat_ == cat.
+ Postconditions: val_ == val && cat_ == &cat.
Throws: Nothing.
template<typename ErrorCodeEnum>
@@ -463,9 +510,9 @@ error_code observers
Returns: val_.
Throws: Nothing.
- error_category category() const;
+ const error_category & category() const;
-Returns: cat_.
+Returns: *cat_.
Throws: Nothing.
error_condition default_error_condition() const;
@@ -480,7 +527,7 @@ error_code observers
operator unspecified-bool-type() const;
-Returns: if value() != value_type(), returns a value that will evaluate
+
Returns: if value() != 0, returns a value that will evaluate
true in a boolean context; otherwise, returns a value that will
evaluate false in a boolean context. The value type returned shall
not be convertible to int.
@@ -527,8 +574,8 @@ implementation specific. --end note ]
operator unspecified-bool-type () const;
private:
- int val_; // exposition only
- const error_category & cat_; // exposition only
+ int val_; // exposition only
+ const error_category * cat_; // exposition only
};
}
}
@@ -538,13 +585,13 @@ constructors
error_condition();
Effects: Constructs an object of type error_condition.
- Postconditions: val_ == 0 and cat_ == generic_category.
+ Postconditions: val_ == 0 and cat_ == &generic_category.
Throws: Nothing.
-error_condition( value_type val, const error_category & cat );
+error_condition( int val, const error_category & cat );
Effects: Constructs an object of type error_condition.
- Postconditions: val_ == val and cat_ == cat.
+ Postconditions: val_ == val and cat_ == &cat.
Throws: Nothing.
template <class ErrorConditionEnum>
@@ -557,9 +604,9 @@ constructors
-void assign( value_type val, const error_category & cat );
+void assign( int val, const error_category & cat );
- Postconditions: val_ == val and cat_ == cat.
+ Postconditions: val_ == val and cat_ == &cat.
Throws: Nothing.
template<typename ErrorConditionEnum>
@@ -575,14 +622,14 @@ modifiers
-value_type value() const;
+int value() const;
Returns: val_.
Throws: Nothing
const error_category & category() const;
- Returns: cat_.
+ Returns: *cat_.
Throws: Nothing.
string message() const;
@@ -603,7 +650,37 @@ observers
eliminating some sources of user error. One possible implementation choice for
this type is pointer to member. --end note ]
-
+
+ extern error_code throws;
+The predefined error_code object throws is supplied
+for use as a "throw on error" tag.
+
+Functions that specify an argument in the form error_code& ec=throws,
+with appropriate namespace qualifiers, have the following error handling
+semantics:
+
+ Postconditions:
+
+ If &ec != &throws and an error occurred:
+
+ -
ec.value() returns the implementation specific error
+ number for the particular error that occurred.
+ ec.category() returns the
+ error_category for ec.value().
+ if &ec != &throws and an error did not occur, ec.clear().
+
+ Throws:
+
+ If an error occurs and &ec == &throws, throws an exception of type
+ system_error or of a type
+ derived from system_error. The
+ exception's code() member function returns a reference to an
+ error_code object with the behavior specified in
+ Postconditions.
+
+
+
bool operator==( const error_code & lhs, const error_code & rhs );
Returns: lhs.category() == rhs.category() && lhs.value() ==
@@ -657,7 +734,7 @@ bool operator!=( const error_condition & condition, const error_code & c
error_condition make_error_condition( errc::errc_t e );
- Returns: error_condition( e, generic_category).
+ Returns: error_condition( static_cast<int>( e ), generic_category).
template <class charT, class traits>
@@ -677,8 +754,7 @@ bool operator!=( const error_condition & condition, const error_code & c
The class system_error describes an exception object used to
-report error conditions that have an associated error code. Such error
-conditions typically originate from the operating system or other low-level
+report errors that have an associated error_code. Such errors typically originate from operating system or other low-level
application program interfaces.
namespace boost
@@ -691,11 +767,11 @@ application program interfaces.
system_error( error_code ec );
system_error( error_code ec, const char * what_arg );
system_error( error_code ec, const std::string & what_arg );
- system_error( error_code::value_type ev, const error_category & ecat,
+ system_error( int ev, const error_category & ecat,
const char * what_arg );
- system_error( error_code::value_type ev, const error_category & ecat,
+ system_error( int ev, const error_category & ecat,
const std::string & what_arg );
- system_error( error_code::value_type ev, const error_category & ecat);
+ system_error( int ev, const error_category & ecat);
const error_code & code() const throw();
const char * what() const throw();
@@ -721,21 +797,21 @@ application program interfaces.
Postcondition: code() == ec
&& std::strcmp( this->runtime_error::what(), what_arg.c_str() ) == 0
-system_error( error_code::value_type ev, const error_category & ecat,
+system_error( int ev, const error_category & ecat,
const char * what_arg );
Effects: Constructs an object of class system_error.
Postcondition: code() == error_code( ev, ecat )
&& std::strcmp( this->runtime_error::what(), what_arg ) == 0
-system_error( error_code::value_type ev, const error_category & ecat,
+system_error( int ev, const error_category & ecat,
const std::string & what_arg );
Effects: Constructs an object of class system_error.
Postcondition: code() == error_code( ev, ecat )
&& std::strcmp( this->runtime_error::what(), what_arg.c_str() ) == 0
-system_error( error_code::value_type ev, const error_category & ecat );
+system_error( int ev, const error_category & ecat );
Effects: Constructs an object of class system_error.
Postcondition: code() == error_code( ev, ecat )
@@ -754,14 +830,15 @@ application program interfaces.
-© Copyright Beman Dawes, 2006, 2007
-Distributed under the Boost Software License, Version 1.0. See
-www.boost.org/LICENSE_1_0.txt
-
Revised
-June 25, 2008
+October 11, 2008
+© Copyright Beman Dawes, 2006, 2007, 2008
+
+Distributed under the Boost Software License, Version 1.0. See
+www.boost.org/LICENSE_1_0.txt
+