1<?xml version="1.0" standalone="yes"?> 2<library-reference id="utilities"><title>Utilities</title><header name="boost/log/utility/exception_handler.hpp"> 3<para><para>Andrey Semashev </para> 4 5<para>12.07.2009</para> 6 7This header contains tools for exception handlers support in different parts of the library. </para><namespace name="boost"> 8<namespace name="log"> 9<class name="exception_handler"><template> 10 <template-type-parameter name="SequenceT"/> 11 <template-type-parameter name="HandlerT"/> 12 </template><description><para>An exception handler functional object. The handler aggregates a user-defined functional object that will be called when one of the specified exception types is caught. </para></description><typedef name="handler_type"><purpose>The exception handler type. </purpose><type>HandlerT</type></typedef> 13<typedef name="result_type"><purpose>The handler result type. </purpose><type>void</type></typedef> 14<method-group name="public member functions"> 15<method name="operator()" cv="const"><type>void</type><description><para>Exception launcher. Rethrows the current exception in order to detect its type and pass it to the aggregated function object.</para><para><note><para>Must be called from within a <computeroutput>catch</computeroutput> statement. </para> 16</note> 17</para></description></method> 18</method-group> 19<constructor specifiers="explicit"><parameter name="handler"><paramtype>handler_type const &</paramtype></parameter><description><para>Initializing constructor. Creates an exception handler with the specified function object that will receive the exception. </para></description></constructor> 20</class><class name="nothrow_exception_handler"><template> 21 <template-type-parameter name="SequenceT"/> 22 <template-type-parameter name="HandlerT"/> 23 </template><inherit access="public">boost::log::exception_handler< SequenceT, HandlerT ></inherit><description><para>A no-throw exception handler functional object. Acts similar to <computeroutput><classname alt="boost::log::exception_handler">exception_handler</classname></computeroutput>, but in case if the exception cannot be handled the exception is not propagated from the handler. Instead the user-defined functional object is called with no parameters. </para></description><typedef name="handler_type"><purpose>The exception handler type. </purpose><type>HandlerT</type></typedef> 24<typedef name="result_type"><purpose>The handler result type. </purpose><type>void</type></typedef> 25<method-group name="public member functions"> 26<method name="operator()" cv="const"><type>void</type><description><para>Exception launcher. Rethrows the current exception in order to detect its type and pass it to the aggregated function object. If the type of the exception could not be detected, the user-defined handler is called with no arguments.</para><para><note><para>Must be called from within a <computeroutput>catch</computeroutput> statement. </para> 27</note> 28</para></description></method> 29</method-group> 30<constructor specifiers="explicit"><parameter name="handler"><paramtype>handler_type const &</paramtype></parameter><description><para>Initializing constructor. Creates an exception handler with the specified function object that will receive the exception. </para></description></constructor> 31</class> 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63<function name="make_exception_suppressor"><type><classname>nop</classname></type><description><para>The function creates an empty exception handler that effectively suppresses any exception </para></description></function> 64<function name="make_exception_handler"><type><classname>exception_handler</classname>< typename HandlerT::exception_types, HandlerT ></type><template> 65 <template-type-parameter name="HandlerT"/> 66 </template><parameter name="handler"><paramtype>HandlerT const &</paramtype><description><para>User-defined functional object that will receive exceptions. </para></description></parameter><description><para>The function creates an exception handler functional object. The handler will call to the user-specified functional object with an exception as its argument.</para><para> 67 68<note><para>This form requires the user-defined functional object to have an <computeroutput>exception_types</computeroutput> nested type. This type should be an MPL sequence of all expected exception types. </para> 69</note> 70</para></description><returns><para>A nullary functional object that should be called from within a <computeroutput>catch</computeroutput> statement.</para> 71</returns></function> 72<function name="make_exception_handler"><type><classname>nothrow_exception_handler</classname>< typename HandlerT::exception_types, HandlerT ></type><template> 73 <template-type-parameter name="HandlerT"/> 74 </template><parameter name="handler"><paramtype>HandlerT const &</paramtype><description><para>User-defined functional object that will receive exceptions. </para></description></parameter><parameter name=""><paramtype>std::nothrow_t const &</paramtype></parameter><description><para>The function creates an exception handler functional object. The handler will call to the user-specified functional object with an exception as its argument. If the exception type cannot be identified, the handler will call the user-defined functor with no arguments, instead of propagating exception to the caller.</para><para>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.</para><para> 75 76<note><para>This form requires the user-defined functional object to have an <computeroutput>exception_types</computeroutput> nested type. This type should be an MPL sequence of all expected exception types. </para> 77</note> 78</para></description><returns><para>A nullary functional object that should be called from within a <computeroutput>catch</computeroutput> statement.</para> 79</returns></function> 80<function name="make_exception_handler"><type><classname>exception_handler</classname>< MPL_sequence_of_ExceptionsT, HandlerT ></type><template> 81 <template-nontype-parameter name="ExceptionsT"><type>typename...</type></template-nontype-parameter> 82 <template-type-parameter name="HandlerT"/> 83 </template><parameter name="handler"><paramtype>HandlerT const &</paramtype><description><para>User-defined functional object that will receive exceptions. </para></description></parameter><description><para>The function creates an exception handler functional object. The handler will call to the user-specified functional object with an exception as its argument. All expected exception types should be specified as first template parameters explicitly, in the order they would be specified in a corresponding <computeroutput>try/catch</computeroutput> statement.</para><para>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.</para><para> 84 85</para></description><returns><para>A nullary functional object that should be called from within a <computeroutput>catch</computeroutput> statement. </para> 86</returns></function> 87<function name="make_exception_handler"><type><classname>nothrow_exception_handler</classname>< MPL_sequence_of_ExceptionsT, HandlerT ></type><template> 88 <template-nontype-parameter name="ExceptionsT"><type>typename...</type></template-nontype-parameter> 89 <template-type-parameter name="HandlerT"/> 90 </template><parameter name="handler"><paramtype>HandlerT const &</paramtype><description><para>User-defined functional object that will receive exceptions. </para></description></parameter><parameter name=""><paramtype>std::nothrow_t const &</paramtype></parameter><description><para>The function creates an exception handler functional object. The handler will call to the user-specified functional object with an exception as its argument. If the exception type cannot be identified, the handler will call the user-defined functor with no arguments, instead of propagating exception to the caller. All expected exception types should be specified as first template parameters explicitly, in the order they would be specified in a corresponding <computeroutput>try/catch</computeroutput> statement.</para><para>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.</para><para> 91 92</para></description><returns><para>A nullary functional object that should be called from within a <computeroutput>catch</computeroutput> statement. </para> 93</returns></function> 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170</namespace> 171</namespace> 172<macro name="BOOST_LOG_MAX_EXCEPTION_TYPES"><purpose>Maximum number of exception types that can be specified for exception handlers. </purpose></macro> 173</header> 174<header name="boost/log/utility/formatting_ostream.hpp"> 175<para><para>Andrey Semashev </para> 176 177<para>11.07.2012</para> 178 179The header contains implementation of a string stream used for log record formatting. </para><namespace name="boost"> 180<namespace name="log"> 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207<function name="operator<<"><type><emphasis>unspecified</emphasis></type><template> 208 <template-type-parameter name="StreamT"/> 209 <template-type-parameter name="T"/> 210 </template><parameter name="strm"><paramtype>StreamT &</paramtype></parameter><parameter name="value"><paramtype>T</paramtype></parameter></function> 211<function name="operator<<"><type><emphasis>unspecified</emphasis></type><template> 212 <template-type-parameter name="StreamT"/> 213 <template-type-parameter name="T"/> 214 </template><parameter name="strm"><paramtype>StreamT &</paramtype></parameter><parameter name="value"><paramtype>T const &</paramtype></parameter></function> 215<function name="operator<<"><type><emphasis>unspecified</emphasis></type><template> 216 <template-type-parameter name="StreamT"/> 217 <template-type-parameter name="T"/> 218 </template><parameter name="strm"><paramtype>StreamT &</paramtype></parameter><parameter name="value"><paramtype>T &</paramtype></parameter></function> 219<function name="operator<<"><type><emphasis>unspecified</emphasis></type><template> 220 <template-type-parameter name="StreamT"/> 221 <template-type-parameter name="T"/> 222 </template><parameter name="strm"><paramtype>StreamT &&</paramtype></parameter><parameter name="value"><paramtype>T</paramtype></parameter></function> 223<function name="operator<<"><type><emphasis>unspecified</emphasis></type><template> 224 <template-type-parameter name="StreamT"/> 225 <template-type-parameter name="T"/> 226 </template><parameter name="strm"><paramtype>StreamT &&</paramtype></parameter><parameter name="value"><paramtype>T const &</paramtype></parameter></function> 227<function name="operator<<"><type><emphasis>unspecified</emphasis></type><template> 228 <template-type-parameter name="StreamT"/> 229 <template-type-parameter name="T"/> 230 </template><parameter name="strm"><paramtype>StreamT &&</paramtype></parameter><parameter name="value"><paramtype>T &</paramtype></parameter></function> 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312</namespace> 313</namespace> 314</header> 315<header name="boost/log/utility/formatting_ostream_fwd.hpp"> 316<para><para>Andrey Semashev </para> 317 318<para>11.07.2012</para> 319 320The header contains forward declaration of a string stream used for log record formatting. </para><namespace name="boost"> 321<namespace name="log"> 322<class name="basic_formatting_ostream"><template> 323 <template-type-parameter name="CharT"/> 324 <template-type-parameter name="TraitsT"/> 325 <template-type-parameter name="AllocatorT"/> 326 </template><purpose>Stream for log records formatting. </purpose><description><para>Stream wrapper for log records formatting.</para><para>This stream wrapper is used by the library for log record formatting. It implements the standard string stream interface with a few differences:</para><para><itemizedlist> 327<listitem><para>It does not derive from standard types <computeroutput>std::basic_ostream</computeroutput>, <computeroutput>std::basic_ios</computeroutput> and <computeroutput>std::ios_base</computeroutput>, although it tries to implement their interfaces closely. There are a few small differences, mostly regarding <computeroutput>rdbuf</computeroutput> and <computeroutput>str</computeroutput> signatures, as well as the supported insertion operator overloads. The actual wrapped stream can be accessed through the <computeroutput>stream</computeroutput> methods. </para> 328</listitem> 329<listitem><para>By default, <computeroutput>bool</computeroutput> values are formatted using alphabetical representation rather than numeric. </para> 330</listitem> 331<listitem><para>The stream supports writing strings of character types different from the stream character type. The stream will perform character code conversion as needed using the imbued locale. </para> 332</listitem> 333<listitem><para>The stream operates on an external string object rather than on the embedded one. The string can be attached or detached from the stream dynamically.</para> 334</listitem> 335</itemizedlist> 336Although <computeroutput><classname alt="boost::log::basic_formatting_ostream">basic_formatting_ostream</classname></computeroutput> does not derive from <computeroutput>std::basic_ostream</computeroutput>, users are not required to add special overloads of <computeroutput>operator<<</computeroutput> for it since the stream will by default reuse the operators for <computeroutput>std::basic_ostream</computeroutput>. However, one can define special overloads of <computeroutput>operator<<</computeroutput> for <computeroutput><classname alt="boost::log::basic_formatting_ostream">basic_formatting_ostream</classname></computeroutput> if a certain type needs special formatting when output to log. </para></description><method-group name="public member functions"> 337<method name="attach"><type>void</type><parameter name="str"><paramtype>string_type &</paramtype><description><para>The string buffer to attach. </para></description></parameter><description><para>Attaches the stream to the string. The string will be used to store the formatted characters.</para><para> 338</para></description></method> 339<method name="detach"><type>void</type><description><para>Detaches the stream from the string. Any buffered data is flushed to the string. </para></description></method> 340<method name="str" cv="const"><type>string_type const &</type><description><para> 341</para></description><returns><para>Reference to the attached string. The string must be attached before calling this method. </para> 342</returns></method> 343<method name="stream"><type>ostream_type &</type><description><para> 344</para></description><returns><para>Reference to the wrapped stream </para> 345</returns></method> 346<method name="stream" cv="const"><type>ostream_type const &</type><description><para> 347</para></description><returns><para>Reference to the wrapped stream </para> 348</returns></method> 349<method name="flags" cv="const"><type>fmtflags</type></method> 350<method name="flags"><type>fmtflags</type><parameter name="f"><paramtype>fmtflags</paramtype></parameter></method> 351<method name="setf"><type>fmtflags</type><parameter name="f"><paramtype>fmtflags</paramtype></parameter></method> 352<method name="setf"><type>fmtflags</type><parameter name="f"><paramtype>fmtflags</paramtype></parameter><parameter name="mask"><paramtype>fmtflags</paramtype></parameter></method> 353<method name="unsetf"><type>void</type><parameter name="f"><paramtype>fmtflags</paramtype></parameter></method> 354<method name="precision" cv="const"><type>std::streamsize</type></method> 355<method name="precision"><type>std::streamsize</type><parameter name="p"><paramtype>std::streamsize</paramtype></parameter></method> 356<method name="width" cv="const"><type>std::streamsize</type></method> 357<method name="width"><type>std::streamsize</type><parameter name="w"><paramtype>std::streamsize</paramtype></parameter></method> 358<method name="getloc" cv="const"><type>std::locale</type></method> 359<method name="imbue"><type>std::locale</type><parameter name="loc"><paramtype>std::locale const &</paramtype></parameter></method> 360<method name="iword"><type>long &</type><parameter name="index"><paramtype>int</paramtype></parameter></method> 361<method name="pword"><type>void *&</type><parameter name="index"><paramtype>int</paramtype></parameter></method> 362<method name="register_callback"><type>void</type><parameter name="fn"><paramtype>event_callback</paramtype></parameter><parameter name="index"><paramtype>int</paramtype></parameter></method> 363<method name="conversion-operator" cv="const" specifiers="explicit"><type>bool</type></method> 364<method name="operator!" cv="const"><type>bool</type></method> 365<method name="rdstate" cv="const"><type>iostate</type></method> 366<method name="clear"><type>void</type><parameter name="state"><paramtype>iostate</paramtype><default>goodbit</default></parameter></method> 367<method name="setstate"><type>void</type><parameter name="state"><paramtype>iostate</paramtype></parameter></method> 368<method name="good" cv="const"><type>bool</type></method> 369<method name="eof" cv="const"><type>bool</type></method> 370<method name="fail" cv="const"><type>bool</type></method> 371<method name="bad" cv="const"><type>bool</type></method> 372<method name="exceptions" cv="const"><type>iostate</type></method> 373<method name="exceptions"><type>void</type><parameter name="s"><paramtype>iostate</paramtype></parameter></method> 374<method name="tie" cv="const"><type>ostream_type *</type></method> 375<method name="tie"><type>ostream_type *</type><parameter name="strm"><paramtype>ostream_type *</paramtype></parameter></method> 376<method name="rdbuf" cv="const"><type>streambuf_type *</type></method> 377<method name="copyfmt"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="rhs"><paramtype>std::basic_ios< char_type, traits_type > &</paramtype></parameter></method> 378<method name="copyfmt"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="rhs"><paramtype><classname>basic_formatting_ostream</classname> &</paramtype></parameter></method> 379<method name="fill" cv="const"><type>char_type</type></method> 380<method name="fill"><type>char_type</type><parameter name="ch"><paramtype>char_type</paramtype></parameter></method> 381<method name="narrow" cv="const"><type>char</type><parameter name="ch"><paramtype>char_type</paramtype></parameter><parameter name="def"><paramtype>char</paramtype></parameter></method> 382<method name="widen" cv="const"><type>char_type</type><parameter name="ch"><paramtype>char</paramtype></parameter></method> 383<method name="flush"><type><classname>basic_formatting_ostream</classname> &</type></method> 384<method name="tellp"><type>pos_type</type></method> 385<method name="seekp"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="pos"><paramtype>pos_type</paramtype></parameter></method> 386<method name="seekp"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="off"><paramtype>off_type</paramtype></parameter><parameter name="dir"><paramtype>std::ios_base::seekdir</paramtype></parameter></method> 387<method name="put"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="c"><paramtype>char_type</paramtype></parameter></method> 388<method name="put"><type><emphasis>unspecified</emphasis></type><template> 389 <template-type-parameter name="OtherCharT"/> 390 </template><parameter name="c"><paramtype>OtherCharT</paramtype></parameter></method> 391<method name="write"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="p"><paramtype>const char_type *</paramtype></parameter><parameter name="size"><paramtype>std::streamsize</paramtype></parameter></method> 392<method name="write"><type><emphasis>unspecified</emphasis></type><template> 393 <template-type-parameter name="OtherCharT"/> 394 </template><parameter name="p"><paramtype>const OtherCharT *</paramtype></parameter><parameter name="size"><paramtype>std::streamsize</paramtype></parameter></method> 395<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="manip"><paramtype>ios_base_manip</paramtype></parameter></method> 396<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="manip"><paramtype>basic_ios_manip</paramtype></parameter></method> 397<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="manip"><paramtype>stream_manip</paramtype></parameter></method> 398<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="c"><paramtype>char</paramtype></parameter></method> 399<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="p"><paramtype>const char *</paramtype></parameter></method> 400<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="c"><paramtype>wchar_t</paramtype></parameter></method> 401<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="p"><paramtype>const wchar_t *</paramtype></parameter></method> 402<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="c"><paramtype>char16_t</paramtype></parameter></method> 403<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="p"><paramtype>const char16_t *</paramtype></parameter></method> 404<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="c"><paramtype>char32_t</paramtype></parameter></method> 405<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="p"><paramtype>const char32_t *</paramtype></parameter></method> 406<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="value"><paramtype>bool</paramtype></parameter></method> 407<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="value"><paramtype>signed char</paramtype></parameter></method> 408<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="value"><paramtype>unsigned char</paramtype></parameter></method> 409<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="value"><paramtype>short</paramtype></parameter></method> 410<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="value"><paramtype>unsigned short</paramtype></parameter></method> 411<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="value"><paramtype>int</paramtype></parameter></method> 412<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="value"><paramtype>unsigned int</paramtype></parameter></method> 413<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="value"><paramtype>long</paramtype></parameter></method> 414<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="value"><paramtype>unsigned long</paramtype></parameter></method> 415<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="value"><paramtype>long long</paramtype></parameter></method> 416<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="value"><paramtype>unsigned long long</paramtype></parameter></method> 417<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="value"><paramtype>float</paramtype></parameter></method> 418<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="value"><paramtype>double</paramtype></parameter></method> 419<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="value"><paramtype>long double</paramtype></parameter></method> 420<method name="operator<<"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="buf"><paramtype>std::basic_streambuf< char_type, traits_type > *</paramtype></parameter></method> 421</method-group> 422<constructor><description><para>Default constructor. Creates an empty record that is equivalent to the invalid record handle. The stream capability is not available after construction.</para><para> 423</para></description><postconditions><para><computeroutput>!*this == true</computeroutput> </para> 424</postconditions></constructor> 425<constructor specifiers="explicit"><parameter name="str"><paramtype>string_type &</paramtype><description><para>The string buffer to attach. </para></description></parameter><description><para>Initializing constructor. Attaches the string to the constructed stream. The string will be used to store the formatted characters.</para><para> 426 427</para></description><postconditions><para><computeroutput>!*this == false</computeroutput> </para> 428</postconditions></constructor> 429<destructor><description><para>Destructor. Destroys the record, releases any sinks and attribute values that were involved in processing this record. </para></description></destructor> 430<method-group name="public static functions"> 431<method name="xalloc" specifiers="static"><type>int</type></method> 432<method name="sync_with_stdio" specifiers="static"><type>bool</type><parameter name="sync"><paramtype>bool</paramtype><default>true</default></parameter></method> 433</method-group> 434<method-group name="protected member functions"> 435<method name="init_stream"><type>void</type></method> 436</method-group> 437<method-group name="private member functions"> 438<method name="formatted_write"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="p"><paramtype>const char_type *</paramtype></parameter><parameter name="size"><paramtype>std::streamsize</paramtype></parameter></method> 439<method name="formatted_write"><type><classname>basic_formatting_ostream</classname> &</type><template> 440 <template-type-parameter name="OtherCharT"/> 441 </template><parameter name="p"><paramtype>const OtherCharT *</paramtype></parameter><parameter name="size"><paramtype>std::streamsize</paramtype></parameter></method> 442<method name="aligned_write"><type>void</type><parameter name="p"><paramtype>const char_type *</paramtype></parameter><parameter name="size"><paramtype>std::streamsize</paramtype></parameter></method> 443<method name="aligned_write"><type>void</type><template> 444 <template-type-parameter name="OtherCharT"/> 445 </template><parameter name="p"><paramtype>const OtherCharT *</paramtype></parameter><parameter name="size"><paramtype>std::streamsize</paramtype></parameter></method> 446</method-group> 447<constructor cv="= delete"><parameter name="that"><paramtype><classname>basic_formatting_ostream</classname> const &</paramtype></parameter><purpose>Copy constructor (closed) </purpose></constructor> 448<copy-assignment cv="= delete"><type><classname>basic_formatting_ostream</classname> &</type><parameter name="that"><paramtype><classname>basic_formatting_ostream</classname> const &</paramtype></parameter><purpose>Assignment (closed) </purpose></copy-assignment> 449</class><typedef name="formatting_ostream"><type><classname>basic_formatting_ostream</classname>< char ></type></typedef> 450<typedef name="wformatting_ostream"><type><classname>basic_formatting_ostream</classname>< wchar_t ></type></typedef> 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564</namespace> 565</namespace> 566</header> 567<header name="boost/log/utility/functional.hpp"> 568<para><para>Andrey Semashev </para> 569 570<para>30.03.2008</para> 571 572This header includes all functional helpers. </para></header> 573<header name="boost/log/utility/functional/as_action.hpp"> 574<para><para>Andrey Semashev </para> 575 576<para>30.03.2008</para> 577 578This header contains function object adapter for compatibility with Boost.Spirit actions interface requirements. </para><namespace name="boost"> 579<namespace name="log"> 580<struct name="as_action_adapter"><template> 581 <template-type-parameter name="FunT"/> 582 </template><purpose>Function object adapter for Boost.Spirit actions. </purpose><typedef name="result_type"><type>FunT::result_type</type></typedef> 583<method-group name="public member functions"> 584<method name="operator()" cv="const"><type>result_type</type><template> 585 <template-type-parameter name="AttributeT"/> 586 <template-type-parameter name="ContextT"/> 587 </template><parameter name="attr"><paramtype>AttributeT const &</paramtype></parameter><parameter name="ctx"><paramtype>ContextT const &</paramtype></parameter><parameter name="pass"><paramtype>bool &</paramtype></parameter></method> 588</method-group> 589<constructor specifiers="explicit"><parameter name="fun"><paramtype>FunT const &</paramtype></parameter></constructor> 590</struct> 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668<function name="as_action"><type><classname>as_action_adapter</classname>< FunT ></type><template> 669 <template-type-parameter name="FunT"/> 670 </template><parameter name="fun"><paramtype>FunT const &</paramtype></parameter></function> 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705</namespace> 706</namespace> 707</header> 708<header name="boost/log/utility/functional/begins_with.hpp"> 709<para><para>Andrey Semashev </para> 710 711<para>30.03.2008</para> 712 713This header contains a predicate for checking if the provided string begins with a substring. </para><namespace name="boost"> 714<namespace name="log"> 715<struct name="begins_with_fun"><purpose>The <computeroutput>begins_with</computeroutput> functor. </purpose><typedef name="result_type"><type>bool</type></typedef> 716<method-group name="public member functions"> 717<method name="operator()" cv="const"><type>bool</type><template> 718 <template-type-parameter name="T"/> 719 <template-type-parameter name="U"/> 720 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter></method> 721</method-group> 722</struct> 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835</namespace> 836</namespace> 837</header> 838<header name="boost/log/utility/functional/bind.hpp"> 839<para><para>Andrey Semashev </para> 840 841<para>30.03.2008</para> 842 843This header contains function object adapters. This is a lightweight alternative to what Boost.Phoenix and Boost.Bind provides. </para><namespace name="boost"> 844<namespace name="log"> 845<struct name="binder1st"><template> 846 <template-type-parameter name="FunT"/> 847 <template-type-parameter name="FirstArgT"/> 848 </template><inherit access="private">FunT</inherit><purpose>First argument binder. </purpose><typedef name="result_type"><type>FunT::result_type</type></typedef> 849<method-group name="public member functions"> 850<method name="operator()" cv="const"><type>result_type</type></method> 851<method name="operator()" cv="const"><type>result_type</type><template> 852 <template-type-parameter name="T0"/> 853 </template><parameter name="arg0"><paramtype>T0 const &</paramtype></parameter></method> 854<method name="operator()" cv="const"><type>result_type</type><template> 855 <template-type-parameter name="T0"/> 856 <template-type-parameter name="T1"/> 857 </template><parameter name="arg0"><paramtype>T0 const &</paramtype></parameter><parameter name="arg1"><paramtype>T1 const &</paramtype></parameter></method> 858</method-group> 859<constructor><parameter name="fun"><paramtype>FunT const &</paramtype></parameter><parameter name="arg"><paramtype><emphasis>unspecified</emphasis></paramtype></parameter></constructor> 860</struct><struct-specialization name="binder1st"><template> 861 <template-type-parameter name="FunT"/> 862 <template-type-parameter name="FirstArgT"/> 863 </template><specialization><template-arg>FunT &</template-arg><template-arg>FirstArgT</template-arg></specialization><purpose>First argument binder. </purpose><typedef name="result_type"><type>remove_cv< FunT >::type::result_type</type></typedef> 864<method-group name="public member functions"> 865<method name="operator()" cv="const"><type>result_type</type></method> 866<method name="operator()" cv="const"><type>result_type</type><template> 867 <template-type-parameter name="T0"/> 868 </template><parameter name="arg0"><paramtype>T0 const &</paramtype></parameter></method> 869<method name="operator()" cv="const"><type>result_type</type><template> 870 <template-type-parameter name="T0"/> 871 <template-type-parameter name="T1"/> 872 </template><parameter name="arg0"><paramtype>T0 const &</paramtype></parameter><parameter name="arg1"><paramtype>T1 const &</paramtype></parameter></method> 873</method-group> 874<constructor><parameter name="fun"><paramtype>FunT &</paramtype></parameter><parameter name="arg"><paramtype><emphasis>unspecified</emphasis></paramtype></parameter></constructor> 875</struct-specialization><struct name="binder2nd"><template> 876 <template-type-parameter name="FunT"/> 877 <template-type-parameter name="SecondArgT"/> 878 </template><inherit access="private">FunT</inherit><purpose>Second argument binder. </purpose><typedef name="result_type"><type>FunT::result_type</type></typedef> 879<method-group name="public member functions"> 880<method name="operator()" cv="const"><type>result_type</type><template> 881 <template-type-parameter name="T"/> 882 </template><parameter name="arg"><paramtype>T const &</paramtype></parameter></method> 883<method name="operator()" cv="const"><type>result_type</type><template> 884 <template-type-parameter name="T0"/> 885 <template-type-parameter name="T1"/> 886 </template><parameter name="arg0"><paramtype>T0 const &</paramtype></parameter><parameter name="arg1"><paramtype>T1 const &</paramtype></parameter></method> 887</method-group> 888<constructor><parameter name="fun"><paramtype>FunT const &</paramtype></parameter><parameter name="arg"><paramtype><emphasis>unspecified</emphasis></paramtype></parameter></constructor> 889</struct><struct-specialization name="binder2nd"><template> 890 <template-type-parameter name="FunT"/> 891 <template-type-parameter name="SecondArgT"/> 892 </template><specialization><template-arg>FunT &</template-arg><template-arg>SecondArgT</template-arg></specialization><purpose>Second argument binder. </purpose><typedef name="result_type"><type>remove_cv< FunT >::type::result_type</type></typedef> 893<method-group name="public member functions"> 894<method name="operator()" cv="const"><type>result_type</type><template> 895 <template-type-parameter name="T"/> 896 </template><parameter name="arg"><paramtype>T const &</paramtype></parameter></method> 897<method name="operator()" cv="const"><type>result_type</type><template> 898 <template-type-parameter name="T0"/> 899 <template-type-parameter name="T1"/> 900 </template><parameter name="arg0"><paramtype>T0 const &</paramtype></parameter><parameter name="arg1"><paramtype>T1 const &</paramtype></parameter></method> 901</method-group> 902<constructor><parameter name="fun"><paramtype>FunT &</paramtype></parameter><parameter name="arg"><paramtype><emphasis>unspecified</emphasis></paramtype></parameter></constructor> 903</struct-specialization><struct name="binder3rd"><template> 904 <template-type-parameter name="FunT"/> 905 <template-type-parameter name="ThirdArgT"/> 906 </template><inherit access="private">FunT</inherit><purpose>Third argument binder. </purpose><typedef name="result_type"><type>FunT::result_type</type></typedef> 907<method-group name="public member functions"> 908<method name="operator()" cv="const"><type>result_type</type><template> 909 <template-type-parameter name="T0"/> 910 <template-type-parameter name="T1"/> 911 </template><parameter name="arg0"><paramtype>T0 const &</paramtype></parameter><parameter name="arg1"><paramtype>T1 const &</paramtype></parameter></method> 912</method-group> 913<constructor><parameter name="fun"><paramtype>FunT const &</paramtype></parameter><parameter name="arg"><paramtype><emphasis>unspecified</emphasis></paramtype></parameter></constructor> 914</struct><struct-specialization name="binder3rd"><template> 915 <template-type-parameter name="FunT"/> 916 <template-type-parameter name="ThirdArgT"/> 917 </template><specialization><template-arg>FunT &</template-arg><template-arg>ThirdArgT</template-arg></specialization><purpose>Third argument binder. </purpose><typedef name="result_type"><type>remove_cv< FunT >::type::result_type</type></typedef> 918<method-group name="public member functions"> 919<method name="operator()" cv="const"><type>result_type</type><template> 920 <template-type-parameter name="T0"/> 921 <template-type-parameter name="T1"/> 922 </template><parameter name="arg0"><paramtype>T0 const &</paramtype></parameter><parameter name="arg1"><paramtype>T1 const &</paramtype></parameter></method> 923</method-group> 924<constructor><parameter name="fun"><paramtype>FunT &</paramtype></parameter><parameter name="arg"><paramtype><emphasis>unspecified</emphasis></paramtype></parameter></constructor> 925</struct-specialization> 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997<function name="bind1st"><type><classname>binder1st</classname>< FunT, FirstArgT ></type><template> 998 <template-type-parameter name="FunT"/> 999 <template-type-parameter name="FirstArgT"/> 1000 </template><parameter name="fun"><paramtype>FunT</paramtype></parameter><parameter name="arg"><paramtype>FirstArgT const &</paramtype></parameter></function> 1001<function name="bind1st"><type><classname>binder1st</classname>< FunT, FirstArgT ></type><template> 1002 <template-type-parameter name="FunT"/> 1003 <template-type-parameter name="FirstArgT"/> 1004 </template><parameter name="fun"><paramtype>FunT</paramtype></parameter><parameter name="arg"><paramtype>FirstArgT &</paramtype></parameter></function> 1005<function name="bind2nd"><type><classname>binder2nd</classname>< FunT, SecondArgT ></type><template> 1006 <template-type-parameter name="FunT"/> 1007 <template-type-parameter name="SecondArgT"/> 1008 </template><parameter name="fun"><paramtype>FunT</paramtype></parameter><parameter name="arg"><paramtype>SecondArgT const &</paramtype></parameter></function> 1009<function name="bind2nd"><type><classname>binder2nd</classname>< FunT, SecondArgT ></type><template> 1010 <template-type-parameter name="FunT"/> 1011 <template-type-parameter name="SecondArgT"/> 1012 </template><parameter name="fun"><paramtype>FunT</paramtype></parameter><parameter name="arg"><paramtype>SecondArgT &</paramtype></parameter></function> 1013<function name="bind3rd"><type><classname>binder3rd</classname>< FunT, ThirdArgT ></type><template> 1014 <template-type-parameter name="FunT"/> 1015 <template-type-parameter name="ThirdArgT"/> 1016 </template><parameter name="fun"><paramtype>FunT</paramtype></parameter><parameter name="arg"><paramtype>ThirdArgT const &</paramtype></parameter></function> 1017<function name="bind3rd"><type><classname>binder3rd</classname>< FunT, ThirdArgT ></type><template> 1018 <template-type-parameter name="FunT"/> 1019 <template-type-parameter name="ThirdArgT"/> 1020 </template><parameter name="fun"><paramtype>FunT</paramtype></parameter><parameter name="arg"><paramtype>ThirdArgT &</paramtype></parameter></function> 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056</namespace> 1057</namespace> 1058</header> 1059<header name="boost/log/utility/functional/bind_assign.hpp"> 1060<para><para>Andrey Semashev </para> 1061 1062<para>30.03.2008</para> 1063 1064This header contains a function object that assigns the received value to the bound object. This is a lightweight alternative to what Boost.Phoenix and Boost.Lambda provides. </para><namespace name="boost"> 1065<namespace name="log"> 1066<struct name="assign_fun"><purpose>The function object that assigns its second operand to the first one. </purpose><typedef name="result_type"><type>void</type></typedef> 1067<method-group name="public member functions"> 1068<method name="operator()" cv="const"><type>void</type><template> 1069 <template-type-parameter name="LeftT"/> 1070 <template-type-parameter name="RightT"/> 1071 </template><parameter name="assignee"><paramtype>LeftT &</paramtype></parameter><parameter name="val"><paramtype>RightT const &</paramtype></parameter></method> 1072</method-group> 1073</struct> 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144<function name="bind_assign"><type><classname>binder1st</classname>< <classname>assign_fun</classname>, AssigneeT & ></type><template> 1145 <template-type-parameter name="AssigneeT"/> 1146 </template><parameter name="assignee"><paramtype>AssigneeT &</paramtype></parameter></function> 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188</namespace> 1189</namespace> 1190</header> 1191<header name="boost/log/utility/functional/bind_output.hpp"> 1192<para><para>Andrey Semashev </para> 1193 1194<para>30.03.2008</para> 1195 1196This header contains a function object that puts the received value to the bound stream. This is a lightweight alternative to what Boost.Phoenix and Boost.Lambda provides. </para><namespace name="boost"> 1197<namespace name="log"> 1198<struct name="output_fun"><purpose>The function object that outputs its second operand to the first one. </purpose><typedef name="result_type"><type>void</type></typedef> 1199<method-group name="public member functions"> 1200<method name="operator()" cv="const"><type>void</type><template> 1201 <template-type-parameter name="StreamT"/> 1202 <template-type-parameter name="T"/> 1203 </template><parameter name="strm"><paramtype>StreamT &</paramtype></parameter><parameter name="val"><paramtype>T const &</paramtype></parameter></method> 1204</method-group> 1205</struct> 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275<function name="bind_output"><type><classname>binder1st</classname>< <classname>output_fun</classname>, StreamT & ></type><template> 1276 <template-type-parameter name="StreamT"/> 1277 </template><parameter name="strm"><paramtype>StreamT &</paramtype></parameter></function> 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320</namespace> 1321</namespace> 1322</header> 1323<header name="boost/log/utility/functional/bind_to_log.hpp"> 1324<para><para>Andrey Semashev </para> 1325 1326<para>06.11.2012</para> 1327 1328This header contains a function object that puts the received value to the bound stream using the <computeroutput>to_log</computeroutput> manipulator. This is a lightweight alternative to what Boost.Phoenix and Boost.Lambda provides. </para><namespace name="boost"> 1329<namespace name="log"> 1330<struct name="to_log_fun"><template> 1331 <template-type-parameter name="TagT"><default>void</default></template-type-parameter> 1332 </template><purpose>The function object that outputs its second operand to the first one. </purpose><typedef name="result_type"><type>void</type></typedef> 1333<method-group name="public member functions"> 1334<method name="operator()" cv="const"><type>void</type><template> 1335 <template-type-parameter name="StreamT"/> 1336 <template-type-parameter name="T"/> 1337 </template><parameter name="strm"><paramtype>StreamT &</paramtype></parameter><parameter name="val"><paramtype>T const &</paramtype></parameter></method> 1338</method-group> 1339</struct><struct-specialization name="to_log_fun"><template> 1340 </template><specialization><template-arg>void</template-arg></specialization><purpose>The function object that outputs its second operand to the first one. </purpose><typedef name="result_type"><type>void</type></typedef> 1341<method-group name="public member functions"> 1342<method name="operator()" cv="const"><type>void</type><template> 1343 <template-type-parameter name="StreamT"/> 1344 <template-type-parameter name="T"/> 1345 </template><parameter name="strm"><paramtype>StreamT &</paramtype></parameter><parameter name="val"><paramtype>T const &</paramtype></parameter></method> 1346</method-group> 1347</struct-specialization> 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415<function name="bind_to_log"><type><classname>binder1st</classname>< <classname>to_log_fun</classname>< >, StreamT & ></type><template> 1416 <template-type-parameter name="StreamT"/> 1417 </template><parameter name="strm"><paramtype>StreamT &</paramtype></parameter></function> 1418<function name="bind_to_log"><type><classname>binder1st</classname>< <classname>to_log_fun</classname>< TagT >, StreamT & ></type><template> 1419 <template-type-parameter name="TagT"/> 1420 <template-type-parameter name="StreamT"/> 1421 </template><parameter name="strm"><paramtype>StreamT &</paramtype></parameter></function> 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465</namespace> 1466</namespace> 1467</header> 1468<header name="boost/log/utility/functional/contains.hpp"> 1469<para><para>Andrey Semashev </para> 1470 1471<para>30.03.2008</para> 1472 1473This header contains a predicate for checking if the provided string contains a substring. </para><namespace name="boost"> 1474<namespace name="log"> 1475<struct name="contains_fun"><purpose>The <computeroutput>contains</computeroutput> functor. </purpose><typedef name="result_type"><type>bool</type></typedef> 1476<method-group name="public member functions"> 1477<method name="operator()" cv="const"><type>bool</type><template> 1478 <template-type-parameter name="T"/> 1479 <template-type-parameter name="U"/> 1480 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter></method> 1481</method-group> 1482</struct> 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595</namespace> 1596</namespace> 1597</header> 1598<header name="boost/log/utility/functional/ends_with.hpp"> 1599<para><para>Andrey Semashev </para> 1600 1601<para>30.03.2008</para> 1602 1603This header contains a predicate for checking if the provided string ends with a substring. </para><namespace name="boost"> 1604<namespace name="log"> 1605<struct name="ends_with_fun"><purpose>The <computeroutput>ends_with</computeroutput> functor. </purpose><typedef name="result_type"><type>bool</type></typedef> 1606<method-group name="public member functions"> 1607<method name="operator()" cv="const"><type>bool</type><template> 1608 <template-type-parameter name="T"/> 1609 <template-type-parameter name="U"/> 1610 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter></method> 1611</method-group> 1612</struct> 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725</namespace> 1726</namespace> 1727</header> 1728<header name="boost/log/utility/functional/fun_ref.hpp"> 1729<para><para>Andrey Semashev </para> 1730 1731<para>30.03.2008</para> 1732 1733This header contains function object reference adapter. The adapter stores a reference to external function object and forwards all calls to the referred function. </para><namespace name="boost"> 1734<namespace name="log"> 1735<struct name="function_reference_wrapper"><template> 1736 <template-type-parameter name="FunT"/> 1737 </template><purpose>Reference wrapper for function objects. </purpose><typedef name="result_type"><type>FunT::result_type</type></typedef> 1738<method-group name="public member functions"> 1739<method name="operator()" cv="const"><type>result_type</type></method> 1740<method name="operator()" cv="const"><type>result_type</type><template> 1741 <template-nontype-parameter name="ArgsT"><type>typename...</type></template-nontype-parameter> 1742 </template><parameter name="args"><paramtype>ArgsT const &...</paramtype></parameter></method> 1743</method-group> 1744<constructor specifiers="explicit"><parameter name="fun"><paramtype>FunT &</paramtype></parameter></constructor> 1745</struct> 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812<function name="fun_ref"><type><classname>function_reference_wrapper</classname>< FunT ></type><template> 1813 <template-type-parameter name="FunT"/> 1814 </template><parameter name="fun"><paramtype>FunT &</paramtype></parameter></function> 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860</namespace> 1861</namespace> 1862</header> 1863<header name="boost/log/utility/functional/in_range.hpp"> 1864<para><para>Andrey Semashev </para> 1865 1866<para>30.03.2008</para> 1867 1868This header contains a predicate for checking if the provided value is within a half-open range. </para><namespace name="boost"> 1869<namespace name="log"> 1870<struct name="in_range_fun"><purpose>The in_range functor. </purpose><typedef name="result_type"><type>bool</type></typedef> 1871<method-group name="public member functions"> 1872<method name="operator()" cv="const"><type>bool</type><template> 1873 <template-type-parameter name="T"/> 1874 <template-type-parameter name="U"/> 1875 </template><parameter name="value"><paramtype>T const &</paramtype></parameter><parameter name="rng"><paramtype>std::pair< U, U > const &</paramtype></parameter></method> 1876</method-group> 1877<method-group name="private static functions"> 1878<method name="op" specifiers="static"><type>bool</type><template> 1879 <template-type-parameter name="T"/> 1880 <template-type-parameter name="U"/> 1881 </template><parameter name="value"><paramtype>T const &</paramtype></parameter><parameter name="rng"><paramtype>std::pair< U, U > const &</paramtype></parameter><parameter name=""><paramtype>false_type</paramtype></parameter></method> 1882<method name="op" specifiers="static"><type>bool</type><template> 1883 <template-type-parameter name="T"/> 1884 <template-type-parameter name="U"/> 1885 </template><parameter name="value"><paramtype>T const &</paramtype></parameter><parameter name="rng"><paramtype>std::pair< U, U > const &</paramtype></parameter><parameter name=""><paramtype>true_type</paramtype></parameter></method> 1886</method-group> 1887</struct> 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000</namespace> 2001</namespace> 2002</header> 2003<header name="boost/log/utility/functional/logical.hpp"> 2004<para><para>Andrey Semashev </para> 2005 2006<para>30.03.2008</para> 2007 2008This header contains logical predicates for value comparison, analogous to <computeroutput>std::less</computeroutput>, <computeroutput>std::greater</computeroutput> and others. The main difference from the standard equivalents is that the predicates defined in this header are not templates and therefore do not require a fixed argument type. Furthermore, both arguments may have different types, in which case the comparison is performed without type conversion.</para><para><note><para>In case if arguments are integral, the conversion is performed according to the standard C++ rules in order to avoid warnings from the compiler. </para> 2009</note> 2010</para><namespace name="boost"> 2011<namespace name="log"> 2012<struct name="equal_to"><purpose>Equality predicate. </purpose><typedef name="result_type"><type>bool</type></typedef> 2013<method-group name="public member functions"> 2014<method name="operator()" cv="const"><type>bool</type><template> 2015 <template-type-parameter name="T"/> 2016 <template-type-parameter name="U"/> 2017 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter></method> 2018</method-group> 2019<method-group name="private static functions"> 2020<method name="op" specifiers="static"><type>bool</type><template> 2021 <template-type-parameter name="T"/> 2022 <template-type-parameter name="U"/> 2023 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter><parameter name=""><paramtype>false_type</paramtype></parameter></method> 2024<method name="op" specifiers="static"><type>bool</type><template> 2025 <template-type-parameter name="T"/> 2026 <template-type-parameter name="U"/> 2027 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter><parameter name=""><paramtype>true_type</paramtype></parameter></method> 2028</method-group> 2029</struct><struct name="greater"><purpose>Greater predicate. </purpose><typedef name="result_type"><type>bool</type></typedef> 2030<method-group name="public member functions"> 2031<method name="operator()" cv="const"><type>bool</type><template> 2032 <template-type-parameter name="T"/> 2033 <template-type-parameter name="U"/> 2034 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter></method> 2035</method-group> 2036<method-group name="private static functions"> 2037<method name="op" specifiers="static"><type>bool</type><template> 2038 <template-type-parameter name="T"/> 2039 <template-type-parameter name="U"/> 2040 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter><parameter name=""><paramtype>false_type</paramtype></parameter></method> 2041<method name="op" specifiers="static"><type>bool</type><template> 2042 <template-type-parameter name="T"/> 2043 <template-type-parameter name="U"/> 2044 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter><parameter name=""><paramtype>true_type</paramtype></parameter></method> 2045</method-group> 2046</struct><struct name="greater_equal"><purpose>Greater or equal predicate. </purpose><typedef name="result_type"><type>bool</type></typedef> 2047<method-group name="public member functions"> 2048<method name="operator()" cv="const"><type>bool</type><template> 2049 <template-type-parameter name="T"/> 2050 <template-type-parameter name="U"/> 2051 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter></method> 2052</method-group> 2053<method-group name="private static functions"> 2054<method name="op" specifiers="static"><type>bool</type><template> 2055 <template-type-parameter name="T"/> 2056 <template-type-parameter name="U"/> 2057 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter><parameter name=""><paramtype>false_type</paramtype></parameter></method> 2058<method name="op" specifiers="static"><type>bool</type><template> 2059 <template-type-parameter name="T"/> 2060 <template-type-parameter name="U"/> 2061 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter><parameter name=""><paramtype>true_type</paramtype></parameter></method> 2062</method-group> 2063</struct><struct name="less"><purpose>Less predicate. </purpose><typedef name="result_type"><type>bool</type></typedef> 2064<method-group name="public member functions"> 2065<method name="operator()" cv="const"><type>bool</type><template> 2066 <template-type-parameter name="T"/> 2067 <template-type-parameter name="U"/> 2068 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter></method> 2069</method-group> 2070<method-group name="private static functions"> 2071<method name="op" specifiers="static"><type>bool</type><template> 2072 <template-type-parameter name="T"/> 2073 <template-type-parameter name="U"/> 2074 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter><parameter name=""><paramtype>false_type</paramtype></parameter></method> 2075<method name="op" specifiers="static"><type>bool</type><template> 2076 <template-type-parameter name="T"/> 2077 <template-type-parameter name="U"/> 2078 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter><parameter name=""><paramtype>true_type</paramtype></parameter></method> 2079</method-group> 2080</struct><struct name="less_equal"><purpose>Less or equal predicate. </purpose><typedef name="result_type"><type>bool</type></typedef> 2081<method-group name="public member functions"> 2082<method name="operator()" cv="const"><type>bool</type><template> 2083 <template-type-parameter name="T"/> 2084 <template-type-parameter name="U"/> 2085 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter></method> 2086</method-group> 2087<method-group name="private static functions"> 2088<method name="op" specifiers="static"><type>bool</type><template> 2089 <template-type-parameter name="T"/> 2090 <template-type-parameter name="U"/> 2091 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter><parameter name=""><paramtype>false_type</paramtype></parameter></method> 2092<method name="op" specifiers="static"><type>bool</type><template> 2093 <template-type-parameter name="T"/> 2094 <template-type-parameter name="U"/> 2095 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter><parameter name=""><paramtype>true_type</paramtype></parameter></method> 2096</method-group> 2097</struct><struct name="not_equal_to"><purpose>Inequality predicate. </purpose><typedef name="result_type"><type>bool</type></typedef> 2098<method-group name="public member functions"> 2099<method name="operator()" cv="const"><type>bool</type><template> 2100 <template-type-parameter name="T"/> 2101 <template-type-parameter name="U"/> 2102 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter></method> 2103</method-group> 2104<method-group name="private static functions"> 2105<method name="op" specifiers="static"><type>bool</type><template> 2106 <template-type-parameter name="T"/> 2107 <template-type-parameter name="U"/> 2108 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter><parameter name=""><paramtype>false_type</paramtype></parameter></method> 2109<method name="op" specifiers="static"><type>bool</type><template> 2110 <template-type-parameter name="T"/> 2111 <template-type-parameter name="U"/> 2112 </template><parameter name="left"><paramtype>T const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter><parameter name=""><paramtype>true_type</paramtype></parameter></method> 2113</method-group> 2114</struct> 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227</namespace> 2228</namespace> 2229</header> 2230<header name="boost/log/utility/functional/matches.hpp"> 2231<para><para>Andrey Semashev </para> 2232 2233<para>30.03.2008</para> 2234 2235This header contains a predicate for checking if the provided string matches a regular expression. </para><namespace name="boost"> 2236<namespace name="log"> 2237<struct name="matches_fun"><purpose>The regex matching functor. </purpose><typedef name="result_type"><type>bool</type></typedef> 2238<method-group name="public member functions"> 2239<method name="operator()" cv="const"><type>bool</type><template> 2240 <template-type-parameter name="StringT"/> 2241 <template-type-parameter name="ExpressionT"/> 2242 </template><parameter name="str"><paramtype>StringT const &</paramtype></parameter><parameter name="expr"><paramtype>ExpressionT const &</paramtype></parameter></method> 2243<method name="operator()" cv="const"><type>bool</type><template> 2244 <template-type-parameter name="StringT"/> 2245 <template-type-parameter name="ExpressionT"/> 2246 <template-type-parameter name="ArgT"/> 2247 </template><parameter name="str"><paramtype>StringT const &</paramtype></parameter><parameter name="expr"><paramtype>ExpressionT const &</paramtype></parameter><parameter name="arg"><paramtype>ArgT const &</paramtype></parameter></method> 2248</method-group> 2249</struct> 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362</namespace> 2363</namespace> 2364</header> 2365<header name="boost/log/utility/functional/nop.hpp"> 2366<para><para>Andrey Semashev </para> 2367 2368<para>30.03.2008</para> 2369 2370This header contains a function object that does nothing. </para><namespace name="boost"> 2371<namespace name="log"> 2372<struct name="nop"><purpose>The function object that does nothing. </purpose><typedef name="result_type"><type>void</type></typedef> 2373<method-group name="public member functions"> 2374<method name="operator()" cv="const noexcept"><type>void</type></method> 2375<method name="operator()" cv="const noexcept"><type>void</type><template> 2376 <template-nontype-parameter name="ArgsT"><type>typename...</type></template-nontype-parameter> 2377 </template><parameter name="..."><paramtype>ArgsT const &</paramtype></parameter></method> 2378</method-group> 2379</struct> 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492</namespace> 2493</namespace> 2494</header> 2495<header name="boost/log/utility/functional/save_result.hpp"> 2496<para><para>Andrey Semashev </para> 2497 2498<para>19.01.2013</para> 2499 2500This header contains function object adapter that saves the result of the adopted function to an external variable. </para><namespace name="boost"> 2501<namespace name="log"> 2502<struct name="save_result_wrapper"><template> 2503 <template-type-parameter name="FunT"/> 2504 <template-type-parameter name="AssigneeT"/> 2505 </template><purpose>Function object wrapper for saving the adopted function object result. </purpose><typedef name="result_type"><type>void</type></typedef> 2506<method-group name="public member functions"> 2507<method name="operator()" cv="const"><type>result_type</type><template> 2508 <template-type-parameter name="ArgT"/> 2509 </template><parameter name="arg"><paramtype>ArgT const &</paramtype></parameter></method> 2510</method-group> 2511<constructor><parameter name="fun"><paramtype>FunT</paramtype></parameter><parameter name="assignee"><paramtype>AssigneeT &</paramtype></parameter></constructor> 2512</struct> 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578<function name="save_result"><type><classname>save_result_wrapper</classname>< FunT, AssigneeT ></type><template> 2579 <template-type-parameter name="FunT"/> 2580 <template-type-parameter name="AssigneeT"/> 2581 </template><parameter name="fun"><paramtype>FunT const &</paramtype></parameter><parameter name="assignee"><paramtype>AssigneeT &</paramtype></parameter></function> 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628</namespace> 2629</namespace> 2630</header> 2631<header name="boost/log/utility/ipc/object_name.hpp"> 2632<para><para>Andrey Semashev </para> 2633 2634<para>05.03.2016</para> 2635 2636The header contains declaration of a system object name wrapper. </para><namespace name="boost"> 2637<namespace name="log"> 2638<namespace name="ipc"> 2639<class name="object_name"><purpose>A system object name class. </purpose><description><para>In order to identify a system-wide object such as a shared memory segment or a named synchronization primitive the object has to be given a name. The format of the name is specific to the operating system and the <computeroutput><classname alt="boost::log::ipc::object_name">object_name</classname></computeroutput> class provides an abstraction for names of objects. It also provides means for scoping, which allows to avoid name clashes between different processes.</para><para>The object name is a UTF-8 encoded string. The portable object name should consist of the following characters:</para><programlisting> 2640A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 2641a b c d e f g h i j k l m n o p q r s t u v w x y z 26420 1 2 3 4 5 6 7 8 9 . _ - 2643</programlisting><para><note><para>The character set corresponds to the POSIX Portable Filename Character Set (<ulink url="http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_278">http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_278</ulink>).</para> 2644</note> 2645Use of other characters may result in non-portable system-specific behavior.</para><para>The name can have one of the following scopes:</para><para><itemizedlist> 2646<listitem><para><computeroutput>global</computeroutput> - objects within this scope are visible to any process on the system. In order to use this scope the process may need to have extended privileges. This scope is not available for Windows Store applications. </para> 2647</listitem> 2648<listitem><para><computeroutput>user</computeroutput> - objects within this scope can be opened by processes running under the same user as the current process. </para> 2649</listitem> 2650<listitem><para><computeroutput>session</computeroutput> - objects within this scope are visible to processes within the session of the current process. The definition of a session may vary between operating systems. On POSIX, a session is typically a group of processes attached to a single virtual terminal device. On Windows a session is started when a user logs into the system. There is also a separate session for Windows services. </para> 2651</listitem> 2652<listitem><para><computeroutput>process_group</computeroutput> - objects within this scope are visible to processes within the process group of the current process. Currently, on Windows all processes running in the current session are considered members of the same process group. This may change in future.</para> 2653</listitem> 2654</itemizedlist> 2655The scopes are not overlapping. For instance, if an object is created in the global scope, the object cannot be opened with the same name but in user's scope.</para><para>Note that name scoping is not a security feature. On some systems any process on the system has technical capability to open objects within any scope. The scope is only used to help avoid name clashes between processes using <computeroutput><classname alt="boost::log::ipc::object_name">object_name</classname></computeroutput> to identify objects. </para></description><enum name="scope"><enumvalue name="global"><purpose>The name has global scope; any process in the system has the potential to open the resource identified by the name. </purpose></enumvalue><enumvalue name="user"><purpose>The name is limited to processes running under the current user. </purpose></enumvalue><enumvalue name="session"><purpose>The name is limited to processes running in the current login session. </purpose></enumvalue><enumvalue name="process_group"><purpose>The name is limited to processes running in the current process group. </purpose></enumvalue><purpose>Name scopes. </purpose></enum> 2656<method-group name="public member functions"> 2657<method name="empty" cv="const noexcept"><type>bool</type><description><para>Returns <computeroutput>true</computeroutput> if the object name is empty </para></description></method> 2658<method name="size" cv="const noexcept"><type>std::size_t</type><description><para>Returns length of the name, in bytes </para></description></method> 2659<method name="c_str" cv="const noexcept"><type>const char *</type><description><para>Returns the name string </para></description></method> 2660<method name="swap" cv="noexcept"><type>void</type><parameter name="that"><paramtype><classname>object_name</classname> &</paramtype></parameter><description><para>Swaps the object name with another object name </para></description></method> 2661</method-group> 2662<constructor cv="noexcept"><description><para>Default constructor. The method creates an empty object name.</para><para> 2663</para></description><postconditions><para><computeroutput>empty() == true</computeroutput> </para> 2664</postconditions></constructor> 2665<constructor cv="noexcept"><parameter name="that"><paramtype><classname>object_name</classname> &&</paramtype></parameter><description><para>Move constructor. </para></description></constructor> 2666<constructor><parameter name="that"><paramtype><classname>object_name</classname> const &</paramtype></parameter><description><para>Copy constructor. </para></description></constructor> 2667<constructor><parameter name="ns"><paramtype>scope</paramtype><description><para>The scope of the object name </para></description></parameter><parameter name="str"><paramtype>const char *</paramtype><description><para>The object name, must not be NULL. </para></description></parameter><description><para>Constructor from the object name 2668</para></description></constructor> 2669<constructor><parameter name="ns"><paramtype>scope</paramtype><description><para>The scope of the object name </para></description></parameter><parameter name="str"><paramtype>std::string const &</paramtype><description><para>The object name </para></description></parameter><description><para>Constructor from the object name 2670</para></description></constructor> 2671<copy-assignment cv="noexcept"><type><classname>object_name</classname> &</type><parameter name="that"><paramtype><classname>object_name</classname> &&</paramtype></parameter><description><para>Move assignment </para></description></copy-assignment> 2672<copy-assignment><type><classname>object_name</classname> &</type><parameter name="that"><paramtype><classname>object_name</classname> const &</paramtype></parameter><description><para>Copy assignment </para></description></copy-assignment> 2673<method-group name="public static functions"> 2674<method name="from_native" specifiers="static"><type><classname>object_name</classname></type><parameter name="str"><paramtype>const char *</paramtype><description><para>The object name string, must not be <computeroutput>NULL</computeroutput>. The string format is specific to the operating system. </para></description></parameter><description><para>Constructor from the native string.</para><para> 2675</para></description></method> 2676<method name="from_native" specifiers="static"><type><classname>object_name</classname></type><parameter name="str"><paramtype>std::string const &</paramtype><description><para>The object name string. The string format is specific to the operating system. </para></description></parameter><description><para>Constructor from the native string.</para><para> 2677</para></description></method> 2678</method-group> 2679<method-group name="friend functions"> 2680<method name="swap" cv="noexcept"><type>friend void</type><parameter name="left"><paramtype><classname>object_name</classname> &</paramtype></parameter><parameter name="right"><paramtype><classname>object_name</classname> &</paramtype></parameter><description><para>Swaps two object names </para></description></method> 2681<method name="to_string"><type>friend std::string</type><parameter name="name"><paramtype><classname>object_name</classname> const &</paramtype></parameter><description><para>Returns string representation of the object name </para></description></method> 2682<method name="operator==" cv="noexcept"><type>friend bool</type><parameter name="left"><paramtype><classname>object_name</classname> const &</paramtype></parameter><parameter name="right"><paramtype><classname>object_name</classname> const &</paramtype></parameter><description><para>Equality operator </para></description></method> 2683<method name="operator!=" cv="noexcept"><type>friend bool</type><parameter name="left"><paramtype><classname>object_name</classname> const &</paramtype></parameter><parameter name="right"><paramtype><classname>object_name</classname> const &</paramtype></parameter><description><para>Inequality operator </para></description></method> 2684<method name="operator<" cv="noexcept"><type>friend bool</type><parameter name="left"><paramtype><classname>object_name</classname> const &</paramtype></parameter><parameter name="right"><paramtype><classname>object_name</classname> const &</paramtype></parameter><description><para>Less operator </para></description></method> 2685<method name="operator>" cv="noexcept"><type>friend bool</type><parameter name="left"><paramtype><classname>object_name</classname> const &</paramtype></parameter><parameter name="right"><paramtype><classname>object_name</classname> const &</paramtype></parameter><description><para>Greater operator </para></description></method> 2686<method name="operator<=" cv="noexcept"><type>friend bool</type><parameter name="left"><paramtype><classname>object_name</classname> const &</paramtype></parameter><parameter name="right"><paramtype><classname>object_name</classname> const &</paramtype></parameter><description><para>Less or equal operator </para></description></method> 2687<method name="operator>=" cv="noexcept"><type>friend bool</type><parameter name="left"><paramtype><classname>object_name</classname> const &</paramtype></parameter><parameter name="right"><paramtype><classname>object_name</classname> const &</paramtype></parameter><description><para>Greater or equal operator </para></description></method> 2688<method name="operator<<"><type>friend std::basic_ostream< CharT, TraitsT > &</type><template> 2689 <template-type-parameter name="CharT"/> 2690 <template-type-parameter name="TraitsT"/> 2691 </template><parameter name="strm"><paramtype>std::basic_ostream< CharT, TraitsT > &</paramtype></parameter><parameter name="name"><paramtype><classname>object_name</classname> const &</paramtype></parameter><description><para>Stream ouput operator </para></description></method> 2692</method-group> 2693</class></namespace> 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807</namespace> 2808</namespace> 2809</header> 2810<header name="boost/log/utility/ipc/reliable_message_queue.hpp"> 2811<para><para>Lingxi Li </para> 2812 2813<para>Andrey Semashev </para> 2814 2815<para>01.01.2016</para> 2816 2817The header contains declaration of a reliable interprocess message queue. </para><namespace name="boost"> 2818<namespace name="log"> 2819<namespace name="ipc"> 2820<class name="reliable_message_queue"><purpose>A reliable interprocess message queue. </purpose><description><para>The queue implements a reliable one-way channel of passing messages from one or multiple writers to a single reader. The format of the messages is user-defined and must be consistent across all writers and the reader. The queue does not enforce any specific format of the messages, other than they should be supplied as a contiguous array of bytes.</para><para>The queue internally uses a process-shared storage identified by an <computeroutput><classname alt="boost::log::ipc::object_name">object_name</classname></computeroutput> (the queue name). Refer to <computeroutput><classname alt="boost::log::ipc::object_name">object_name</classname></computeroutput> documentation for details on restrictions imposed on object names.</para><para>The queue storage is organized as a fixed number of blocks of a fixed size. The block size must be an integer power of 2 and is expressed in bytes. Each written message, together with some metadata added by the queue, consumes an integer number of blocks. Each read message received by the reader releases the blocks allocated for that message. As such the maximum size of a message is slightly less than block size times capacity of the queue. For efficiency, it is recommended to choose block size large enough to accommodate most of the messages to be passed through the queue.</para><para>The queue is considered empty when no messages are enqueued (all blocks are free). The queue is considered full at the point of enqueueing a message when there is not enough free blocks to accommodate the message.</para><para>The queue is reliable in that it will not drop successfully sent messages that are not received by the reader, other than the case when a non-empty queue is destroyed by the last user. If a message cannot be enqueued by the writer because the queue is full, the queue can either block the writer or return an error or throw an exception, depending on the policy specified at the queue creation. The policy is object local, i.e. different writers and the reader can have different overflow policies.</para><para>If the queue is empty and the reader attempts to dequeue a message, it will block until a message is enqueued by a writer.</para><para>A blocked reader or writer can be unblocked by calling <computeroutput>stop_local</computeroutput>. After this method is called, all threads blocked on this particular object are released and return <computeroutput>operation_result::aborted</computeroutput>. The other instances of the queue (in the current or other processes) are unaffected. In order to restore the normal functioning of the queue instance after the <computeroutput>stop_local</computeroutput> call the user has to invoke <computeroutput>reset_local</computeroutput>.</para><para>The queue does not guarantee any particular order of received messages from different writer threads. Messages sent by a particular writer thread will be received in the order of sending.</para><para>Methods of this class are not thread-safe, unless otherwise specified. </para></description><enum name="operation_result"><enumvalue name="succeeded"><purpose>The operation has completed successfully. </purpose></enumvalue><enumvalue name="no_space"><purpose>The message could not be sent because the queue is full. </purpose></enumvalue><enumvalue name="aborted"><purpose>The operation has been aborted because the queue method <computeroutput>stop_local()</computeroutput> has been called. </purpose></enumvalue><purpose>Result codes for various operations on the queue. </purpose></enum> 2821<enum name="overflow_policy"><enumvalue name="block_on_overflow"><purpose>Block the send operation when the queue is full. </purpose></enumvalue><enumvalue name="fail_on_overflow"><purpose>Return <computeroutput>operation_result::no_space</computeroutput> when the queue is full. </purpose></enumvalue><enumvalue name="throw_on_overflow"><purpose>Throw <computeroutput>capacity_limit_reached</computeroutput> exception when the queue is full. </purpose></enumvalue><purpose>Interprocess queue overflow policies. </purpose></enum> 2822<typedef name="size_type"><purpose>Queue message size type. </purpose><type>uint32_t</type></typedef> 2823<method-group name="public member functions"> 2824<method name="swap" cv="noexcept"><type>void</type><parameter name="that"><paramtype><classname>reliable_message_queue</classname> &</paramtype><description><para>The other object to swap with. </para></description></parameter><description><para>The method swaps the object with <emphasis>that</emphasis>.</para><para> 2825</para></description></method> 2826<method name="create"><type>void</type><parameter name="name"><paramtype><classname>object_name</classname> const &</paramtype><description><para>Name of the message queue to be associated with. </para></description></parameter><parameter name="capacity"><paramtype>uint32_t</paramtype><description><para>Maximum number of allocation blocks the queue can hold. </para></description></parameter><parameter name="block_size"><paramtype>size_type</paramtype><description><para>Size in bytes of allocation block. Must be a power of 2. </para></description></parameter><parameter name="oflow_policy"><paramtype>overflow_policy</paramtype><default>block_on_overflow</default><description><para>Queue behavior policy in case of overflow. </para></description></parameter><parameter name="perms"><paramtype><classname>permissions</classname> const &</paramtype><default><classname alt="boost::log::permissions">permissions</classname>()</default><description><para>Access permissions for the associated message queue. </para></description></parameter><description><para>The method creates the message queue to be associated with the object. After the call, the object will be in running state if a message queue is successfully created.</para><para> 2827 2828 2829</para></description><requires><para><computeroutput>is_open() == false</computeroutput> </para> 2830</requires><postconditions><para><computeroutput>is_open() == true</computeroutput></para> 2831</postconditions></method> 2832<method name="open_or_create"><type>void</type><parameter name="name"><paramtype><classname>object_name</classname> const &</paramtype><description><para>Name of the message queue to be associated with. </para></description></parameter><parameter name="capacity"><paramtype>uint32_t</paramtype><description><para>Maximum number of allocation blocks the queue can hold. </para></description></parameter><parameter name="block_size"><paramtype>size_type</paramtype><description><para>Size in bytes of allocation block. Must be a power of 2. </para></description></parameter><parameter name="oflow_policy"><paramtype>overflow_policy</paramtype><default>block_on_overflow</default><description><para>Queue behavior policy in case of overflow. </para></description></parameter><parameter name="perms"><paramtype><classname>permissions</classname> const &</paramtype><default><classname alt="boost::log::permissions">permissions</classname>()</default><description><para>Access permissions for the associated message queue. </para></description></parameter><description><para>The method creates or opens the message queue to be associated with the object. After the call, the object will be in running state if a message queue is successfully created or opened. If the message queue that is identified by the name already exists then the other queue parameters are ignored. The actual queue parameters can be obtained with accessors from this object after this method returns.</para><para> 2833 2834 2835</para></description><requires><para><computeroutput>is_open() == false</computeroutput> </para> 2836</requires><postconditions><para><computeroutput>is_open() == true</computeroutput></para> 2837</postconditions></method> 2838<method name="open"><type>void</type><parameter name="name"><paramtype><classname>object_name</classname> const &</paramtype><description><para>Name of the message queue to be associated with. </para></description></parameter><parameter name="oflow_policy"><paramtype>overflow_policy</paramtype><default>block_on_overflow</default><description><para>Queue behavior policy in case of overflow. </para></description></parameter><parameter name="perms"><paramtype><classname>permissions</classname> const &</paramtype><default><classname alt="boost::log::permissions">permissions</classname>()</default><description><para>Access permissions for the associated message queue. The permissions will only be used if the queue implementation has to create system objects while operating. This parameter is currently not used on POSIX systems. </para></description></parameter><description><para>The method opens the existing message queue to be associated with the object. After the call, the object will be in running state if a message queue is successfully opened.</para><para> 2839 2840 2841</para></description><requires><para><computeroutput>is_open() == false</computeroutput> </para> 2842</requires><postconditions><para><computeroutput>is_open() == true</computeroutput></para> 2843</postconditions></method> 2844<method name="is_open" cv="const noexcept"><type>bool</type><description><para>Tests whether the object is associated with any message queue.</para><para> 2845</para></description><returns><para><computeroutput>true</computeroutput> if the object is associated with a message queue, and <computeroutput>false</computeroutput> otherwise. </para> 2846</returns></method> 2847<method name="clear"><type>void</type><description><para>This method empties the associated message queue. Concurrent calls to this method, <computeroutput>send()</computeroutput>, <computeroutput>try_send()</computeroutput>, <computeroutput>receive()</computeroutput>, <computeroutput>try_receive()</computeroutput>, and <computeroutput>stop_local()</computeroutput> are allowed.</para><para> 2848</para></description><requires><para><computeroutput>is_open() == true</computeroutput> </para> 2849</requires></method> 2850<method name="name" cv="const"><type><classname>object_name</classname> const &</type><description><para>The method returns the name of the associated message queue.</para><para> 2851 2852</para></description><requires><para><computeroutput>is_open() == true</computeroutput></para> 2853</requires><returns><para>Name of the associated message queue </para> 2854</returns></method> 2855<method name="capacity" cv="const"><type>uint32_t</type><description><para>The method returns the maximum number of allocation blocks the associated message queue can hold. Note that the returned value may be different from the corresponding value passed to the constructor or <computeroutput>open_or_create()</computeroutput>, for the message queue may not have been created by this object.</para><para> 2856 2857</para></description><requires><para><computeroutput>is_open() == true</computeroutput></para> 2858</requires><returns><para>Maximum number of allocation blocks the associated message queue can hold. </para> 2859</returns></method> 2860<method name="block_size" cv="const"><type>size_type</type><description><para>The method returns the allocation block size, in bytes. Each message in the associated message queue consumes an integer number of allocation blocks. Note that the returned value may be different from the corresponding value passed to the constructor or <computeroutput>open_or_create()</computeroutput>, for the message queue may not have been created by this object.</para><para> 2861 2862</para></description><requires><para><computeroutput>is_open() == true</computeroutput></para> 2863</requires><returns><para>Allocation block size, in bytes. </para> 2864</returns></method> 2865<method name="stop_local"><type>void</type><description><para>The method wakes up all threads that are blocked in calls to <computeroutput>send()</computeroutput> or <computeroutput>receive()</computeroutput>. Those calls would then return <computeroutput>operation_result::aborted</computeroutput>. Note that, the method does not block until the woken-up threads have actually returned from <computeroutput>send()</computeroutput> or <computeroutput>receive()</computeroutput>. Other means is needed to ensure that calls to <computeroutput>send()</computeroutput> or <computeroutput>receive()</computeroutput> have returned, e.g., joining the threads that might be blocking on the calls.</para><para>The method also puts the object in stopped state. When in stopped state, calls to <computeroutput>send()</computeroutput> or <computeroutput>receive()</computeroutput> will return immediately with return value <computeroutput>operation_result::aborted</computeroutput> when they would otherwise block in running state.</para><para>Concurrent calls to this method, <computeroutput>send()</computeroutput>, <computeroutput>try_send()</computeroutput>, <computeroutput>receive()</computeroutput>, <computeroutput>try_receive()</computeroutput>, and <computeroutput>clear()</computeroutput> are allowed.</para><para> 2866</para></description><requires><para><computeroutput>is_open() == true</computeroutput> </para> 2867</requires></method> 2868<method name="reset_local"><type>void</type><description><para>The method puts the object in running state where calls to <computeroutput>send()</computeroutput> or <computeroutput>receive()</computeroutput> may block. This method is not thread-safe.</para><para> 2869</para></description><requires><para><computeroutput>is_open() == true</computeroutput> </para> 2870</requires></method> 2871<method name="close" cv="noexcept"><type>void</type><description><para>The method disassociates the associated message queue, if any. No other threads should be using this object before calling this method. The <computeroutput>stop_local()</computeroutput> method can be used to have any threads currently blocked in <computeroutput>send()</computeroutput> or <computeroutput>receive()</computeroutput> return, and prevent further calls to them from blocking. Typically, before calling this method, one would first call <computeroutput>stop_local()</computeroutput> and then join all threads that might be blocking on <computeroutput>send()</computeroutput> or <computeroutput>receive()</computeroutput> to ensure that they have returned from the calls. The associated message queue is destroyed if the object represents the last outstanding reference to it.</para><para> 2872</para></description><postconditions><para><computeroutput>is_open() == false</computeroutput> </para> 2873</postconditions></method> 2874<method name="send"><type>operation_result</type><parameter name="message_data"><paramtype>void const *</paramtype><description><para>The message data to send. Ignored when <computeroutput>message_size</computeroutput> is <computeroutput>0</computeroutput>. </para></description></parameter><parameter name="message_size"><paramtype>size_type</paramtype><description><para>Size of the message data in bytes. If the size is larger than the associated message queue capacity, an <computeroutput>std::logic_error</computeroutput> exception is thrown.</para></description></parameter><description><para>The method sends a message to the associated message queue. When the object is in running state and the queue has no free space for the message, the method either blocks or throws an exception, depending on the overflow policy that was specified on the queue opening/creation. If blocking policy is in effect, the blocking can be interrupted by calling <computeroutput>stop_local()</computeroutput>, in which case the method returns <computeroutput>operation_result::aborted</computeroutput>. When the object is already in the stopped state, the method does not block but returns immediately with return value <computeroutput>operation_result::aborted</computeroutput>.</para><para>It is possible to send an empty message by passing <computeroutput>0</computeroutput> to the parameter <computeroutput>message_size</computeroutput>.</para><para>Concurrent calls to <computeroutput>send()</computeroutput>, <computeroutput>try_send()</computeroutput>, <computeroutput>receive()</computeroutput>, <computeroutput>try_receive()</computeroutput>, <computeroutput>stop_local()</computeroutput>, and <computeroutput>clear()</computeroutput> are allowed.</para><para> 2875 2876 2877<emphasis role="bold">Throws:</emphasis> <computeroutput>std::logic_error</computeroutput> in case if the message size exceeds the queue capacity, <computeroutput>system_error</computeroutput> in case if a native OS method fails. </para></description><requires><para><computeroutput>is_open() == true</computeroutput></para> 2878</requires></method> 2879<method name="try_send"><type>bool</type><parameter name="message_data"><paramtype>void const *</paramtype><description><para>The message data to send. Ignored when <computeroutput>message_size</computeroutput> is <computeroutput>0</computeroutput>. </para></description></parameter><parameter name="message_size"><paramtype>size_type</paramtype><description><para>Size of the message data in bytes. If the size is larger than the maximum size allowed by the associated message queue, an <computeroutput>std::logic_error</computeroutput> exception is thrown.</para></description></parameter><description><para>The method performs an attempt to send a message to the associated message queue. The method is non-blocking, and always returns immediately. <computeroutput>boost::system::system_error</computeroutput> is thrown for errors resulting from native operating system calls. Note that it is possible to send an empty message by passing <computeroutput>0</computeroutput> to the parameter <computeroutput>message_size</computeroutput>. Concurrent calls to <computeroutput>send()</computeroutput>, <computeroutput>try_send()</computeroutput>, <computeroutput>receive()</computeroutput>, <computeroutput>try_receive()</computeroutput>, <computeroutput>stop_local()</computeroutput>, and <computeroutput>clear()</computeroutput> are allowed.</para><para> 2880 2881 2882<emphasis role="bold">Throws:</emphasis> <computeroutput>std::logic_error</computeroutput> in case if the message size exceeds the queue capacity, <computeroutput>system_error</computeroutput> in case if a native OS method fails. </para></description><requires><para><computeroutput>is_open() == true</computeroutput></para> 2883</requires><returns><para><computeroutput>true</computeroutput> if the message is successfully sent, and <computeroutput>false</computeroutput> otherwise (e.g., when the queue is full).</para> 2884</returns></method> 2885<method name="receive"><type>operation_result</type><parameter name="buffer"><paramtype>void *</paramtype><description><para>The memory buffer to store the received message in. </para></description></parameter><parameter name="buffer_size"><paramtype>size_type</paramtype><description><para>The size of the buffer, in bytes. </para></description></parameter><parameter name="message_size"><paramtype>size_type &</paramtype><description><para>Receives the size of the received message, in bytes.</para></description></parameter><description><para>The method takes a message from the associated message queue. When the object is in running state and the queue is empty, the method blocks. The blocking is interrupted when <computeroutput>stop_local()</computeroutput> is called, in which case the method returns <computeroutput>operation_result::aborted</computeroutput>. When the object is already in the stopped state and the queue is empty, the method does not block but returns immediately with return value <computeroutput>operation_result::aborted</computeroutput>.</para><para>Concurrent calls to <computeroutput>send()</computeroutput>, <computeroutput>try_send()</computeroutput>, <computeroutput>receive()</computeroutput>, <computeroutput>try_receive()</computeroutput>, <computeroutput>stop_local()</computeroutput>, and <computeroutput>clear()</computeroutput> are allowed.</para><para> 2886 2887 2888</para></description><requires><para><computeroutput>is_open() == true</computeroutput></para> 2889</requires></method> 2890<method name="receive"><type>operation_result</type><template> 2891 <template-type-parameter name="ElementT"/> 2892 <template-nontype-parameter name="SizeV"><type>size_type</type></template-nontype-parameter> 2893 </template><parameter name="buffer"><paramtype>ElementT(&)</paramtype><description><para>The memory buffer to store the received message in. </para></description></parameter><parameter name="message_size"><paramtype>size_type &</paramtype><description><para>Receives the size of the received message, in bytes.</para></description></parameter><description><para>The method takes a message from the associated message queue. When the object is in running state and the queue is empty, the method blocks. The blocking is interrupted when <computeroutput>stop_local()</computeroutput> is called, in which case the method returns <computeroutput>operation_result::aborted</computeroutput>. When the object is already in the stopped state and the queue is empty, the method does not block but returns immediately with return value <computeroutput>operation_result::aborted</computeroutput>.</para><para>Concurrent calls to <computeroutput>send()</computeroutput>, <computeroutput>try_send()</computeroutput>, <computeroutput>receive()</computeroutput>, <computeroutput>try_receive()</computeroutput>, <computeroutput>stop_local()</computeroutput>, and <computeroutput>clear()</computeroutput> are allowed.</para><para> 2894 2895 2896</para></description><requires><para><computeroutput>is_open() == true</computeroutput></para> 2897</requires></method> 2898<method name="receive"><type>operation_result</type><template> 2899 <template-type-parameter name="ContainerT"/> 2900 </template><parameter name="container"><paramtype>ContainerT &</paramtype><description><para>The container to store the received message in. The container should have value type of <computeroutput>char</computeroutput>, <computeroutput>signed char</computeroutput> or <computeroutput>unsigned char</computeroutput> and support inserting elements at the end.</para></description></parameter><description><para>The method takes a message from the associated message queue. When the object is in running state and the queue is empty, the method blocks. The blocking is interrupted when <computeroutput>stop_local()</computeroutput> is called, in which case the method returns <computeroutput>operation_result::aborted</computeroutput>. When the object is already in the stopped state and the queue is empty, the method does not block but returns immediately with return value <computeroutput>operation_result::aborted</computeroutput>.</para><para>Concurrent calls to <computeroutput>send()</computeroutput>, <computeroutput>try_send()</computeroutput>, <computeroutput>receive()</computeroutput>, <computeroutput>try_receive()</computeroutput>, <computeroutput>stop_local()</computeroutput>, and <computeroutput>clear()</computeroutput> are allowed.</para><para> 2901 2902 2903</para></description><requires><para><computeroutput>is_open() == true</computeroutput></para> 2904</requires></method> 2905<method name="try_receive"><type>bool</type><parameter name="buffer"><paramtype>void *</paramtype><description><para>The memory buffer to store the received message in. </para></description></parameter><parameter name="buffer_size"><paramtype>size_type</paramtype><description><para>The size of the buffer, in bytes. </para></description></parameter><parameter name="message_size"><paramtype>size_type &</paramtype><description><para>Receives the size of the received message, in bytes.</para></description></parameter><description><para>The method performs an attempt to take a message from the associated message queue. The method is non-blocking, and always returns immediately.</para><para>Concurrent calls to <computeroutput>send()</computeroutput>, <computeroutput>try_send()</computeroutput>, <computeroutput>receive()</computeroutput>, <computeroutput>try_receive()</computeroutput>, <computeroutput>stop_local()</computeroutput>, and <computeroutput>clear()</computeroutput> are allowed.</para><para> 2906 2907 2908</para></description><requires><para><computeroutput>is_open() == true</computeroutput></para> 2909</requires><returns><para><computeroutput>true</computeroutput> if a message is successfully received, and <computeroutput>false</computeroutput> otherwise (e.g., when the queue is empty). </para> 2910</returns></method> 2911<method name="try_receive"><type>bool</type><template> 2912 <template-type-parameter name="ElementT"/> 2913 <template-nontype-parameter name="SizeV"><type>size_type</type></template-nontype-parameter> 2914 </template><parameter name="buffer"><paramtype>ElementT(&)</paramtype><description><para>The memory buffer to store the received message in. </para></description></parameter><parameter name="message_size"><paramtype>size_type &</paramtype><description><para>Receives the size of the received message, in bytes.</para></description></parameter><description><para>The method performs an attempt to take a message from the associated message queue. The method is non-blocking, and always returns immediately.</para><para>Concurrent calls to <computeroutput>send()</computeroutput>, <computeroutput>try_send()</computeroutput>, <computeroutput>receive()</computeroutput>, <computeroutput>try_receive()</computeroutput>, <computeroutput>stop_local()</computeroutput>, and <computeroutput>clear()</computeroutput> are allowed.</para><para> 2915 2916 2917</para></description><requires><para><computeroutput>is_open() == true</computeroutput></para> 2918</requires><returns><para><computeroutput>true</computeroutput> if a message is successfully received, and <computeroutput>false</computeroutput> otherwise (e.g., when the queue is empty). </para> 2919</returns></method> 2920<method name="try_receive"><type>bool</type><template> 2921 <template-type-parameter name="ContainerT"/> 2922 </template><parameter name="container"><paramtype>ContainerT &</paramtype><description><para>The container to store the received message in. The container should have value type of <computeroutput>char</computeroutput>, <computeroutput>signed char</computeroutput> or <computeroutput>unsigned char</computeroutput> and support inserting elements at the end.</para></description></parameter><description><para>The method performs an attempt to take a message from the associated message queue. The method is non-blocking, and always returns immediately.</para><para>Concurrent calls to <computeroutput>send()</computeroutput>, <computeroutput>try_send()</computeroutput>, <computeroutput>receive()</computeroutput>, <computeroutput>try_receive()</computeroutput>, <computeroutput>stop_local()</computeroutput>, and <computeroutput>clear()</computeroutput> are allowed.</para><para> 2923 2924 2925</para></description><requires><para><computeroutput>is_open() == true</computeroutput></para> 2926</requires><returns><para><computeroutput>true</computeroutput> if a message is successfully received, and <computeroutput>false</computeroutput> otherwise (e.g., when the queue is empty). </para> 2927</returns></method> 2928</method-group> 2929<constructor cv="noexcept"><description><para>Default constructor. The method constructs an object that is not associated with any message queue.</para><para> 2930</para></description><postconditions><para><computeroutput>is_open() == false</computeroutput> </para> 2931</postconditions></constructor> 2932<constructor><parameter name=""><paramtype><classname>open_mode::create_only_tag</classname></paramtype></parameter><parameter name="name"><paramtype><classname>object_name</classname> const &</paramtype><description><para>Name of the message queue to be associated with. </para></description></parameter><parameter name="capacity"><paramtype>uint32_t</paramtype><description><para>Maximum number of allocation blocks the queue can hold. </para></description></parameter><parameter name="block_size"><paramtype>size_type</paramtype><description><para>Size in bytes of allocation block. Must be a power of 2. </para></description></parameter><parameter name="oflow_policy"><paramtype>overflow_policy</paramtype><default>block_on_overflow</default><description><para>Queue behavior policy in case of overflow. </para></description></parameter><parameter name="perms"><paramtype><classname>permissions</classname> const &</paramtype><default><classname alt="boost::log::permissions">permissions</classname>()</default><description><para>Access permissions for the associated message queue. </para></description></parameter><description><para>Constructor. The method is used to construct an object and create the associated message queue. The constructed object will be in running state if the message queue is successfully created.</para><para> 2933 2934</para></description><postconditions><para><computeroutput>is_open() == true</computeroutput></para> 2935</postconditions></constructor> 2936<constructor><parameter name=""><paramtype><classname>open_mode::open_or_create_tag</classname></paramtype></parameter><parameter name="name"><paramtype><classname>object_name</classname> const &</paramtype><description><para>Name of the message queue to be associated with. </para></description></parameter><parameter name="capacity"><paramtype>uint32_t</paramtype><description><para>Maximum number of allocation blocks the queue can hold. </para></description></parameter><parameter name="block_size"><paramtype>size_type</paramtype><description><para>Size in bytes of allocation block. Must be a power of 2. </para></description></parameter><parameter name="oflow_policy"><paramtype>overflow_policy</paramtype><default>block_on_overflow</default><description><para>Queue behavior policy in case of overflow. </para></description></parameter><parameter name="perms"><paramtype><classname>permissions</classname> const &</paramtype><default><classname alt="boost::log::permissions">permissions</classname>()</default><description><para>Access permissions for the associated message queue. </para></description></parameter><description><para>Constructor. The method is used to construct an object and create or open the associated message queue. The constructed object will be in running state if the message queue is successfully created or opened. If the message queue that is identified by the name already exists then the other queue parameters are ignored. The actual queue parameters can be obtained with accessors from the constructed object.</para><para> 2937 2938</para></description><postconditions><para><computeroutput>is_open() == true</computeroutput></para> 2939</postconditions></constructor> 2940<constructor><parameter name=""><paramtype><classname>open_mode::open_only_tag</classname></paramtype></parameter><parameter name="name"><paramtype><classname>object_name</classname> const &</paramtype><description><para>Name of the message queue to be associated with. </para></description></parameter><parameter name="oflow_policy"><paramtype>overflow_policy</paramtype><default>block_on_overflow</default><description><para>Queue behavior policy in case of overflow. </para></description></parameter><parameter name="perms"><paramtype><classname>permissions</classname> const &</paramtype><default><classname alt="boost::log::permissions">permissions</classname>()</default><description><para>Access permissions for the associated message queue. The permissions will only be used if the queue implementation has to create system objects while operating. This parameter is currently not used on POSIX systems. </para></description></parameter><description><para>Constructor. The method is used to construct an object and open the existing message queue. The constructed object will be in running state if the message queue is successfully opened.</para><para> 2941 2942</para></description><postconditions><para><computeroutput>is_open() == true</computeroutput></para> 2943</postconditions></constructor> 2944<constructor specifiers="explicit"><template> 2945 <template-nontype-parameter name="Args"><type>typename...</type></template-nontype-parameter> 2946 </template><parameter name="args"><paramtype>Args const &...</paramtype></parameter><description><para>Constructor with named parameters. The method is used to construct an object and create or open the associated message queue. The constructed object will be in running state if the message queue is successfully created.</para><para>The following named parameters are accepted:</para><para><itemizedlist> 2947<listitem><para>open_mode - One of the open mode tags: <computeroutput>open_mode::create_only</computeroutput>, <computeroutput>open_mode::open_only</computeroutput> or <computeroutput>open_mode::open_or_create</computeroutput>.</para> 2948</listitem><listitem><para>name - Name of the message queue to be associated with.</para> 2949</listitem><listitem><para>capacity - Maximum number of allocation blocks the queue can hold. Used only if the queue is created.</para> 2950</listitem><listitem><para>block_size - Size in bytes of allocation block. Must be a power of 2. Used only if the queue is created.</para> 2951</listitem><listitem><para>overflow_policy - Queue behavior policy in case of overflow, see <computeroutput>overflow_policy</computeroutput>.</para> 2952</listitem><listitem><para>permissions - Access permissions for the associated message queue.</para> 2953</listitem></itemizedlist> 2954</para><para> 2955</para></description><postconditions><para><computeroutput>is_open() == true</computeroutput> </para> 2956</postconditions></constructor> 2957<destructor><description><para>Destructor. Calls <computeroutput>close()</computeroutput>. </para></description></destructor> 2958<constructor cv="noexcept"><parameter name="that"><paramtype><classname>reliable_message_queue</classname> &&</paramtype><description><para>The object to be moved. </para></description></parameter><description><para>Move constructor. The method move-constructs an object from <computeroutput>other</computeroutput>. After the call, the constructed object becomes <computeroutput>other</computeroutput>, while <computeroutput>other</computeroutput> is left in default constructed state.</para><para> 2959</para></description></constructor> 2960<copy-assignment cv="noexcept"><type><classname>reliable_message_queue</classname> &</type><parameter name="that"><paramtype><classname>reliable_message_queue</classname> &&</paramtype><description><para>The object to be moved.</para></description></parameter><description><para>Move assignment operator. If the object is associated with a message queue, <computeroutput>close()</computeroutput> is first called and the precondition to calling <computeroutput>close()</computeroutput> applies. After the call, the object becomes <emphasis>that</emphasis> while <emphasis>that</emphasis> is left in default constructed state.</para><para> 2961 2962</para></description><returns><para>A reference to the assigned object. </para> 2963</returns></copy-assignment> 2964<method-group name="friend functions"> 2965<method name="swap" cv="noexcept"><type>friend void</type><parameter name="a"><paramtype><classname>reliable_message_queue</classname> &</paramtype></parameter><parameter name="b"><paramtype><classname>reliable_message_queue</classname> &</paramtype></parameter><purpose>Swaps the two <computeroutput><classname alt="boost::log::ipc::reliable_message_queue">reliable_message_queue</classname></computeroutput> objects. </purpose></method> 2966</method-group> 2967<method-group name="public static functions"> 2968<method name="remove" specifiers="static"><type>void</type><parameter name="name"><paramtype><classname>object_name</classname> const &</paramtype><description><para>Name of the message queue to be removed. </para></description></parameter><description><para>The method frees system-wide resources, associated with the interprocess queue with the supplied name. The queue referred to by the specified name must not be opened in any process at the point of this call. After this call succeeds a new queue with the specified name can be created.</para><para>This call can be useful to recover from an earlier process misbehavior (e.g. a crash without properly closing the message queue). In this case resources allocated for the interprocess queue may remain allocated after the last process closed the queue, which in turn may prevent creating a new queue with the same name. By calling this method before creating a queue the application can attempt to ensure it starts with a clean slate.</para><para>On some platforms resources associated with the queue are automatically reclaimed by the operating system when the last process using those resources terminates (even if it terminates abnormally). On these platforms this call may be a no-op. However, portable code should still call this method at appropriate places to ensure compatibility with other platforms and future library versions, which may change implementation of the queue.</para><para> 2969</para></description></method> 2970</method-group> 2971</class></namespace> 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085</namespace> 3086</namespace> 3087</header> 3088<header name="boost/log/utility/manipulators.hpp"> 3089<para><para>Andrey Semashev </para> 3090 3091<para>06.11.2012</para> 3092 3093This header includes all manipulators. </para></header> 3094<header name="boost/log/utility/manipulators/add_value.hpp"> 3095<para><para>Andrey Semashev </para> 3096 3097<para>26.11.2012</para> 3098 3099This header contains the <computeroutput>add_value</computeroutput> manipulator. </para><namespace name="boost"> 3100<namespace name="log"> 3101<class name="add_value_manip"><template> 3102 <template-type-parameter name="RefT"/> 3103 </template><purpose>Attribute value manipulator. </purpose><typedef name="reference_type"><purpose>Stored reference type. </purpose><type>RefT</type></typedef> 3104<typedef name="value_type"><purpose>Attribute value type. </purpose><type>remove_cv< typename remove_reference< reference_type >::type >::type</type></typedef> 3105<method-group name="public member functions"> 3106<method name="get_name" cv="const"><type>attribute_name</type><purpose>Returns attribute name. </purpose></method> 3107<method name="get_value" cv="const"><type>get_value_result_type</type><purpose>Returns attribute value. </purpose></method> 3108</method-group> 3109<constructor><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="value"><paramtype>reference_type</paramtype></parameter><purpose>Initializing constructor. </purpose></constructor> 3110</class> 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218<function name="operator<<"><type>basic_record_ostream< CharT > &</type><template> 3219 <template-type-parameter name="CharT"/> 3220 <template-type-parameter name="RefT"/> 3221 </template><parameter name="strm"><paramtype>basic_record_ostream< CharT > &</paramtype></parameter><parameter name="manip"><paramtype><classname>add_value_manip</classname>< RefT > const &</paramtype></parameter><purpose>The operator attaches an attribute value to the log record. </purpose></function> 3222<overloaded-function name="add_value"><signature><type><classname>add_value_manip</classname>< T && ></type><template> 3223 <template-type-parameter name="T"/> 3224 </template><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="value"><paramtype>T &&</paramtype></parameter></signature><signature><type><classname>add_value_manip</classname>< typename DescriptorT::value_type && ></type><template> 3225 <template-type-parameter name="DescriptorT"/> 3226 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 3227 </template><parameter name=""><paramtype>expressions::attribute_keyword< DescriptorT, ActorT > const &</paramtype></parameter><parameter name="value"><paramtype>typename DescriptorT::value_type &&</paramtype></parameter></signature><signature><type><classname>add_value_manip</classname>< typename DescriptorT::value_type & ></type><template> 3228 <template-type-parameter name="DescriptorT"/> 3229 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 3230 </template><parameter name=""><paramtype>expressions::attribute_keyword< DescriptorT, ActorT > const &</paramtype></parameter><parameter name="value"><paramtype>typename DescriptorT::value_type &</paramtype></parameter></signature><signature><type><classname>add_value_manip</classname>< typename DescriptorT::value_type const & ></type><template> 3231 <template-type-parameter name="DescriptorT"/> 3232 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 3233 </template><parameter name=""><paramtype>expressions::attribute_keyword< DescriptorT, ActorT > const &</paramtype></parameter><parameter name="value"><paramtype>typename DescriptorT::value_type const &</paramtype></parameter></signature><purpose>The function creates a manipulator that attaches an attribute value to a log record. </purpose></overloaded-function> 3234 3235 3236 3237</namespace> 3238</namespace> 3239</header> 3240<header name="boost/log/utility/manipulators/auto_newline.hpp"> 3241<para><para>Andrey Semashev </para> 3242 3243<para>23.06.2019</para> 3244 3245The header contains implementation of a stream manipulator for inserting a newline, unless there is already one inserted. </para><namespace name="boost"> 3246<namespace name="log"> 3247<struct name="auto_newline_manip"><description><para>Stream manipulator for inserting a newline character, unless the last character inserted into the stream is already a newline. </para></description></struct><data-member name="auto_newline"><type>struct <classname>boost::log::auto_newline_manip</classname></type></data-member> 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355<function name="operator<<"><type><classname>basic_formatting_ostream</classname>< CharT, TraitsT, AllocatorT > &</type><template> 3356 <template-type-parameter name="CharT"/> 3357 <template-type-parameter name="TraitsT"/> 3358 <template-type-parameter name="AllocatorT"/> 3359 </template><parameter name="strm"><paramtype><classname>basic_formatting_ostream</classname>< CharT, TraitsT, AllocatorT > &</paramtype></parameter><parameter name=""><paramtype><classname>auto_newline_manip</classname></paramtype></parameter><description><para>Stream output operator for the <computeroutput>auto_newline</computeroutput> manipulator </para></description></function> 3360 3361 3362 3363 3364 3365</namespace> 3366</namespace> 3367</header> 3368<header name="boost/log/utility/manipulators/dump.hpp"> 3369<para><para>Andrey Semashev </para> 3370 3371<para>03.05.2013</para> 3372 3373This header contains the <computeroutput>dump</computeroutput> output manipulator. </para><namespace name="boost"> 3374<namespace name="log"> 3375<class name="bounded_dump_manip"><inherit access="public">dump_manip</inherit><purpose>Manipulator for printing binary representation of the data with a size limit. </purpose><method-group name="public member functions"> 3376<method name="get_max_size" cv="const noexcept"><type>std::size_t</type></method> 3377</method-group> 3378<constructor cv="noexcept"><parameter name="data"><paramtype>const void *</paramtype></parameter><parameter name="size"><paramtype>std::size_t</paramtype></parameter><parameter name="max_size"><paramtype>std::size_t</paramtype></parameter></constructor> 3379<constructor cv="noexcept"><parameter name="that"><paramtype><classname>bounded_dump_manip</classname> const &</paramtype></parameter></constructor> 3380</class><class name="dump_manip"><purpose>Manipulator for printing binary representation of the data. </purpose><method-group name="public member functions"> 3381<method name="get_data" cv="const noexcept"><type>const void *</type></method> 3382<method name="get_size" cv="const noexcept"><type>std::size_t</type></method> 3383</method-group> 3384<constructor cv="noexcept"><parameter name="data"><paramtype>const void *</paramtype></parameter><parameter name="size"><paramtype>std::size_t</paramtype></parameter></constructor> 3385<constructor cv="noexcept"><parameter name="that"><paramtype><classname>dump_manip</classname> const &</paramtype></parameter></constructor> 3386</class> 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487<function name="operator<<"><type>std::basic_ostream< CharT, TraitsT > &</type><template> 3488 <template-type-parameter name="CharT"/> 3489 <template-type-parameter name="TraitsT"/> 3490 </template><parameter name="strm"><paramtype>std::basic_ostream< CharT, TraitsT > &</paramtype></parameter><parameter name="manip"><paramtype><classname>dump_manip</classname> const &</paramtype></parameter><purpose>The operator outputs binary data to a stream. </purpose></function> 3491<function name="operator<<"><type>std::basic_ostream< CharT, TraitsT > &</type><template> 3492 <template-type-parameter name="CharT"/> 3493 <template-type-parameter name="TraitsT"/> 3494 </template><parameter name="strm"><paramtype>std::basic_ostream< CharT, TraitsT > &</paramtype></parameter><parameter name="manip"><paramtype><classname>bounded_dump_manip</classname> const &</paramtype></parameter><purpose>The operator outputs binary data to a stream. </purpose></function> 3495<function name="dump"><type><emphasis>unspecified</emphasis></type><template> 3496 <template-type-parameter name="T"/> 3497 </template><parameter name="data"><paramtype>T *</paramtype><description><para>The pointer to the beginning of the region </para></description></parameter><parameter name="size"><paramtype>std::size_t</paramtype><description><para>The size of the region, in bytes </para></description></parameter><purpose>Creates a stream manipulator that will output contents of a memory region in hexadecimal form. </purpose><description><para> 3498 3499</para></description><returns><para>The manipulator that is to be put to a stream </para> 3500</returns></function> 3501<function name="dump_elements"><type><classname>dump_manip</classname></type><template> 3502 <template-type-parameter name="T"/> 3503 </template><parameter name="data"><paramtype>T *</paramtype><description><para>The pointer to the beginning of the array </para></description></parameter><parameter name="count"><paramtype>std::size_t</paramtype><description><para>The size of the region, in number of <computeroutput>T</computeroutput> elements </para></description></parameter><purpose>Creates a stream manipulator that will dump elements of an array in hexadecimal form. </purpose><description><para> 3504 3505</para></description><returns><para>The manipulator that is to be put to a stream </para> 3506</returns></function> 3507<function name="dump"><type><emphasis>unspecified</emphasis></type><template> 3508 <template-type-parameter name="T"/> 3509 </template><parameter name="data"><paramtype>T *</paramtype><description><para>The pointer to the beginning of the region </para></description></parameter><parameter name="size"><paramtype>std::size_t</paramtype><description><para>The size of the region, in bytes </para></description></parameter><parameter name="max_size"><paramtype>std::size_t</paramtype><description><para>The maximum number of bytes of the region to output </para></description></parameter><purpose>Creates a stream manipulator that will output contents of a memory region in hexadecimal form. </purpose><description><para> 3510 3511</para></description><returns><para>The manipulator that is to be put to a stream </para> 3512</returns></function> 3513<function name="dump_elements"><type><classname>bounded_dump_manip</classname></type><template> 3514 <template-type-parameter name="T"/> 3515 </template><parameter name="data"><paramtype>T *</paramtype><description><para>The pointer to the beginning of the array </para></description></parameter><parameter name="count"><paramtype>std::size_t</paramtype><description><para>The size of the region, in number of <computeroutput>T</computeroutput> elements </para></description></parameter><parameter name="max_count"><paramtype>std::size_t</paramtype><description><para>The maximum number of elements to output </para></description></parameter><purpose>Creates a stream manipulator that will dump elements of an array in hexadecimal form. </purpose><description><para> 3516 3517</para></description><returns><para>The manipulator that is to be put to a stream </para> 3518</returns></function> 3519 3520 3521 3522 3523 3524 3525</namespace> 3526</namespace> 3527</header> 3528<header name="boost/log/utility/manipulators/optional.hpp"> 3529<para><para>Andrey Semashev </para> 3530 3531<para>12.05.2020</para> 3532 3533The header contains implementation of a stream manipulator for inserting an optional value. </para><namespace name="boost"> 3534<namespace name="log"> 3535<class name="optional_manipulator"><template> 3536 <template-type-parameter name="OptionalT"/> 3537 <template-type-parameter name="NoneT"/> 3538 </template><description><para>Stream manipulator for inserting an optional value. </para></description><method-group name="public member functions"> 3539<method name="output" cv="const"><type>void</type><template> 3540 <template-type-parameter name="StreamT"/> 3541 </template><parameter name="stream"><paramtype>StreamT &</paramtype></parameter><purpose>The method outputs the value, if it is present, otherwise outputs the "none" marker. </purpose></method> 3542</method-group> 3543<constructor cv="noexcept"><parameter name="opt"><paramtype>stored_optional_type</paramtype></parameter><parameter name="none"><paramtype>stored_none_type</paramtype></parameter><purpose>Initializing constructor. </purpose></constructor> 3544</class><class-specialization name="optional_manipulator"><template> 3545 <template-type-parameter name="OptionalT"/> 3546 </template><specialization><template-arg>OptionalT</template-arg><template-arg>void</template-arg></specialization><description><para>Stream manipulator for inserting an optional value. Specialization for no "none" marker. </para></description><method-group name="public member functions"> 3547<method name="output" cv="const"><type>void</type><template> 3548 <template-type-parameter name="StreamT"/> 3549 </template><parameter name="stream"><paramtype>StreamT &</paramtype></parameter><purpose>The method outputs the value, if it is present. </purpose></method> 3550</method-group> 3551<constructor cv="noexcept"><parameter name="opt"><paramtype>stored_optional_type</paramtype></parameter><purpose>Initializing constructor. </purpose></constructor> 3552</class-specialization> 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644<function name="operator<<"><type><emphasis>unspecified</emphasis></type><template> 3645 <template-type-parameter name="StreamT"/> 3646 <template-type-parameter name="OptionalT"/> 3647 <template-type-parameter name="NoneT"/> 3648 </template><parameter name="strm"><paramtype>StreamT &</paramtype></parameter><parameter name="manip"><paramtype><classname>optional_manipulator</classname>< OptionalT, NoneT > const &</paramtype></parameter><description><para>Stream output operator for <computeroutput><classname alt="boost::log::optional_manipulator">optional_manipulator</classname></computeroutput>. Outputs the optional value or the "none" marker, if one was specified on manipulator construction. </para></description></function> 3649<function name="optional_manip"><type>boost::enable_if_c< is_scalar< OptionalT >::value &&is_scalar< NoneT >::value, <classname>optional_manipulator</classname>< OptionalT, NoneT >>::type</type><template> 3650 <template-type-parameter name="OptionalT"/> 3651 <template-type-parameter name="NoneT"/> 3652 </template><parameter name="opt"><paramtype>OptionalT</paramtype><description><para>Optional value to output. The optional value must support contextual conversion to <computeroutput>bool</computeroutput> and dereferencing, and its dereferencing result must support stream output. </para></description></parameter><parameter name="none"><paramtype>NoneT</paramtype><description><para>Marker used to indicate when the value is not present. Optional. If not specified, nothing is output if the value is not present. </para></description></parameter><description><para>Optional manipulator generator function.</para><para> 3653 3654<note><para>Both <emphasis>opt</emphasis> and <emphasis>none</emphasis> objects must outlive the created manipulator object. </para> 3655</note> 3656</para></description><returns><para>Manipulator to be inserted into the stream.</para> 3657</returns></function> 3658<function name="optional_manip"><type>boost::enable_if_c< is_scalar< OptionalT >::value &&!is_scalar< NoneT >::value, <classname>optional_manipulator</classname>< OptionalT, NoneT >>::type</type><template> 3659 <template-type-parameter name="OptionalT"/> 3660 <template-type-parameter name="NoneT"/> 3661 </template><parameter name="opt"><paramtype>OptionalT</paramtype><description><para>Optional value to output. The optional value must support contextual conversion to <computeroutput>bool</computeroutput> and dereferencing, and its dereferencing result must support stream output. </para></description></parameter><parameter name="none"><paramtype>NoneT const &</paramtype><description><para>Marker used to indicate when the value is not present. Optional. If not specified, nothing is output if the value is not present. </para></description></parameter><description><para>Optional manipulator generator function.</para><para> 3662 3663<note><para>Both <emphasis>opt</emphasis> and <emphasis>none</emphasis> objects must outlive the created manipulator object. </para> 3664</note> 3665</para></description><returns><para>Manipulator to be inserted into the stream.</para> 3666</returns></function> 3667<function name="optional_manip"><type>boost::enable_if_c< is_scalar< OptionalT >::value, <classname>optional_manipulator</classname>< OptionalT, NoneElementT * >>::type</type><template> 3668 <template-type-parameter name="OptionalT"/> 3669 <template-type-parameter name="NoneElementT"/> 3670 <template-nontype-parameter name="N"><type>std::size_t</type></template-nontype-parameter> 3671 </template><parameter name="opt"><paramtype>OptionalT</paramtype><description><para>Optional value to output. The optional value must support contextual conversion to <computeroutput>bool</computeroutput> and dereferencing, and its dereferencing result must support stream output. </para></description></parameter><parameter name="none"><paramtype>NoneElementT(&)</paramtype><description><para>Marker used to indicate when the value is not present. Optional. If not specified, nothing is output if the value is not present. </para></description></parameter><description><para>Optional manipulator generator function.</para><para> 3672 3673<note><para>Both <emphasis>opt</emphasis> and <emphasis>none</emphasis> objects must outlive the created manipulator object. </para> 3674</note> 3675</para></description><returns><para>Manipulator to be inserted into the stream.</para> 3676</returns></function> 3677<function name="optional_manip"><type>boost::enable_if_c< !is_scalar< OptionalT >::value &&!is_array< OptionalT >::value &&is_scalar< NoneT >::value, <classname>optional_manipulator</classname>< OptionalT, NoneT >>::type</type><template> 3678 <template-type-parameter name="OptionalT"/> 3679 <template-type-parameter name="NoneT"/> 3680 </template><parameter name="opt"><paramtype>OptionalT const &</paramtype><description><para>Optional value to output. The optional value must support contextual conversion to <computeroutput>bool</computeroutput> and dereferencing, and its dereferencing result must support stream output. </para></description></parameter><parameter name="none"><paramtype>NoneT</paramtype><description><para>Marker used to indicate when the value is not present. Optional. If not specified, nothing is output if the value is not present. </para></description></parameter><description><para>Optional manipulator generator function.</para><para> 3681 3682<note><para>Both <emphasis>opt</emphasis> and <emphasis>none</emphasis> objects must outlive the created manipulator object. </para> 3683</note> 3684</para></description><returns><para>Manipulator to be inserted into the stream.</para> 3685</returns></function> 3686<function name="optional_manip"><type>boost::enable_if_c< !is_scalar< OptionalT >::value &&!is_array< OptionalT >::value &&!is_scalar< NoneT >::value, <classname>optional_manipulator</classname>< OptionalT, NoneT >>::type</type><template> 3687 <template-type-parameter name="OptionalT"/> 3688 <template-type-parameter name="NoneT"/> 3689 </template><parameter name="opt"><paramtype>OptionalT const &</paramtype><description><para>Optional value to output. The optional value must support contextual conversion to <computeroutput>bool</computeroutput> and dereferencing, and its dereferencing result must support stream output. </para></description></parameter><parameter name="none"><paramtype>NoneT const &</paramtype><description><para>Marker used to indicate when the value is not present. Optional. If not specified, nothing is output if the value is not present. </para></description></parameter><description><para>Optional manipulator generator function.</para><para> 3690 3691<note><para>Both <emphasis>opt</emphasis> and <emphasis>none</emphasis> objects must outlive the created manipulator object. </para> 3692</note> 3693</para></description><returns><para>Manipulator to be inserted into the stream.</para> 3694</returns></function> 3695<function name="optional_manip"><type>boost::enable_if_c< !is_scalar< OptionalT >::value &&!is_array< OptionalT >::value, <classname>optional_manipulator</classname>< OptionalT, NoneElementT * >>::type</type><template> 3696 <template-type-parameter name="OptionalT"/> 3697 <template-type-parameter name="NoneElementT"/> 3698 <template-nontype-parameter name="N"><type>std::size_t</type></template-nontype-parameter> 3699 </template><parameter name="opt"><paramtype>OptionalT const &</paramtype><description><para>Optional value to output. The optional value must support contextual conversion to <computeroutput>bool</computeroutput> and dereferencing, and its dereferencing result must support stream output. </para></description></parameter><parameter name="none"><paramtype>NoneElementT(&)</paramtype><description><para>Marker used to indicate when the value is not present. Optional. If not specified, nothing is output if the value is not present. </para></description></parameter><description><para>Optional manipulator generator function.</para><para> 3700 3701<note><para>Both <emphasis>opt</emphasis> and <emphasis>none</emphasis> objects must outlive the created manipulator object. </para> 3702</note> 3703</para></description><returns><para>Manipulator to be inserted into the stream.</para> 3704</returns></function> 3705<function name="optional_manip"><type>boost::enable_if_c< is_scalar< OptionalT >::value, <classname>optional_manipulator</classname>< OptionalT, void >>::type</type><template> 3706 <template-type-parameter name="OptionalT"/> 3707 </template><parameter name="opt"><paramtype>OptionalT</paramtype><description><para>Optional value to output. The optional value must support contextual conversion to <computeroutput>bool</computeroutput> and dereferencing, and its dereferencing result must support stream output. </para></description></parameter><description><para>Optional manipulator generator function.</para><para> 3708 3709<note><para><emphasis>opt</emphasis> object must outlive the created manipulator object. </para> 3710</note> 3711</para></description><returns><para>Manipulator to be inserted into the stream.</para> 3712</returns></function> 3713<function name="optional_manip"><type>boost::enable_if_c< !is_scalar< OptionalT >::value &&!is_array< OptionalT >::value, <classname>optional_manipulator</classname>< OptionalT, void >>::type</type><template> 3714 <template-type-parameter name="OptionalT"/> 3715 </template><parameter name="opt"><paramtype>OptionalT const &</paramtype><description><para>Optional value to output. The optional value must support contextual conversion to <computeroutput>bool</computeroutput> and dereferencing, and its dereferencing result must support stream output. </para></description></parameter><description><para>Optional manipulator generator function.</para><para> 3716 3717<note><para><emphasis>opt</emphasis> object must outlive the created manipulator object. </para> 3718</note> 3719</para></description><returns><para>Manipulator to be inserted into the stream.</para> 3720</returns></function> 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733</namespace> 3734</namespace> 3735</header> 3736<header name="boost/log/utility/manipulators/range.hpp"> 3737<para><para>Andrey Semashev </para> 3738 3739<para>11.05.2020</para> 3740 3741The header contains implementation of a stream manipulator for inserting a range of elements, optionally separated with a delimiter. </para><namespace name="boost"> 3742<namespace name="log"> 3743<class name="range_manipulator"><template> 3744 <template-type-parameter name="RangeT"/> 3745 <template-type-parameter name="DelimiterT"/> 3746 </template><description><para>Stream manipulator for inserting a range of elements, optionally separated with a delimiter. </para></description><method-group name="public member functions"> 3747<method name="output" cv="const"><type>void</type><template> 3748 <template-type-parameter name="StreamT"/> 3749 </template><parameter name="stream"><paramtype>StreamT &</paramtype></parameter><purpose>The method outputs elements of the range separated with delimiter. </purpose></method> 3750</method-group> 3751<constructor cv="noexcept"><parameter name="range"><paramtype>RangeT const &</paramtype></parameter><parameter name="delimiter"><paramtype>stored_delimiter_type</paramtype></parameter><purpose>Initializing constructor. </purpose></constructor> 3752</class><class-specialization name="range_manipulator"><template> 3753 <template-type-parameter name="RangeT"/> 3754 </template><specialization><template-arg>RangeT</template-arg><template-arg>void</template-arg></specialization><description><para>Stream manipulator for inserting a range of elements. Specialization for when there is no delimiter. </para></description><method-group name="public member functions"> 3755<method name="output" cv="const"><type>void</type><template> 3756 <template-type-parameter name="StreamT"/> 3757 </template><parameter name="stream"><paramtype>StreamT &</paramtype></parameter><purpose>The method outputs elements of the range. </purpose></method> 3758</method-group> 3759<constructor specifiers="explicit" cv="noexcept"><parameter name="range"><paramtype>RangeT const &</paramtype></parameter><purpose>Initializing constructor. </purpose></constructor> 3760</class-specialization> 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847<function name="operator<<"><type><emphasis>unspecified</emphasis></type><template> 3848 <template-type-parameter name="StreamT"/> 3849 <template-type-parameter name="RangeT"/> 3850 <template-type-parameter name="DelimiterT"/> 3851 </template><parameter name="strm"><paramtype>StreamT &</paramtype></parameter><parameter name="manip"><paramtype><classname>range_manipulator</classname>< RangeT, DelimiterT > const &</paramtype></parameter><description><para>Stream output operator for <computeroutput><classname alt="boost::log::range_manipulator">range_manipulator</classname></computeroutput>. Outputs every element of the range, separated with a delimiter, if one was specified on manipulator construction. </para></description></function> 3852<function name="range_manip"><type>boost::enable_if_c< is_scalar< DelimiterT >::value, <classname>range_manipulator</classname>< RangeT, DelimiterT >>::type</type><template> 3853 <template-type-parameter name="RangeT"/> 3854 <template-type-parameter name="DelimiterT"/> 3855 </template><parameter name="range"><paramtype>RangeT const &</paramtype><description><para>Range of elements to output. The range must support begin and end iterators, and its elements must support stream output. </para></description></parameter><parameter name="delimiter"><paramtype>DelimiterT</paramtype><description><para>Delimiter to separate elements in the output. Optional. If not specified, elements are output without separation. </para></description></parameter><description><para>Range manipulator generator function.</para><para> 3856 3857<note><para>Both <emphasis>range</emphasis> and <emphasis>delimiter</emphasis> objects must outlive the created manipulator object. </para> 3858</note> 3859</para></description><returns><para>Manipulator to be inserted into the stream.</para> 3860</returns></function> 3861<function name="range_manip"><type>boost::disable_if_c< is_scalar< DelimiterT >::value, <classname>range_manipulator</classname>< RangeT, DelimiterT >>::type</type><template> 3862 <template-type-parameter name="RangeT"/> 3863 <template-type-parameter name="DelimiterT"/> 3864 </template><parameter name="range"><paramtype>RangeT const &</paramtype><description><para>Range of elements to output. The range must support begin and end iterators, and its elements must support stream output. </para></description></parameter><parameter name="delimiter"><paramtype>DelimiterT const &</paramtype><description><para>Delimiter to separate elements in the output. Optional. If not specified, elements are output without separation. </para></description></parameter><description><para>Range manipulator generator function.</para><para> 3865 3866<note><para>Both <emphasis>range</emphasis> and <emphasis>delimiter</emphasis> objects must outlive the created manipulator object. </para> 3867</note> 3868</para></description><returns><para>Manipulator to be inserted into the stream.</para> 3869</returns></function> 3870<function name="range_manip"><type><classname>range_manipulator</classname>< RangeT, DelimiterElementT * ></type><template> 3871 <template-type-parameter name="RangeT"/> 3872 <template-type-parameter name="DelimiterElementT"/> 3873 <template-nontype-parameter name="N"><type>std::size_t</type></template-nontype-parameter> 3874 </template><parameter name="range"><paramtype>RangeT const &</paramtype><description><para>Range of elements to output. The range must support begin and end iterators, and its elements must support stream output. </para></description></parameter><parameter name="delimiter"><paramtype>DelimiterElementT(&)</paramtype><description><para>Delimiter to separate elements in the output. Optional. If not specified, elements are output without separation. </para></description></parameter><description><para>Range manipulator generator function.</para><para> 3875 3876<note><para>Both <emphasis>range</emphasis> and <emphasis>delimiter</emphasis> objects must outlive the created manipulator object. </para> 3877</note> 3878</para></description><returns><para>Manipulator to be inserted into the stream.</para> 3879</returns></function> 3880<function name="range_manip"><type><classname>range_manipulator</classname>< RangeT, void ></type><template> 3881 <template-type-parameter name="RangeT"/> 3882 </template><parameter name="range"><paramtype>RangeT const &</paramtype><description><para>Range of elements to output. The range must support begin and end iterators, and its elements must support stream output. </para></description></parameter><description><para>Range manipulator generator function.</para><para> 3883 3884<note><para><emphasis>delimiter</emphasis> object must outlive the created manipulator object. </para> 3885</note> 3886</para></description><returns><para>Manipulator to be inserted into the stream.</para> 3887</returns></function> 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909</namespace> 3910</namespace> 3911</header> 3912<header name="boost/log/utility/manipulators/to_log.hpp"> 3913<para><para>Andrey Semashev </para> 3914 3915<para>06.11.2012</para> 3916 3917This header contains the <computeroutput>to_log</computeroutput> output manipulator. </para><namespace name="boost"> 3918<namespace name="log"> 3919<class name="to_log_manip"><template> 3920 <template-type-parameter name="T"/> 3921 <template-type-parameter name="TagT"><default>void</default></template-type-parameter> 3922 </template><purpose>Generic manipulator for customizing output to log. </purpose><typedef name="value_type"><purpose>Output value type. </purpose><type>T</type></typedef> 3923<typedef name="tag_type"><purpose>Value tag type. </purpose><type>TagT</type></typedef> 3924<method-group name="public member functions"> 3925<method name="get" cv="const noexcept"><type>value_type const &</type></method> 3926</method-group> 3927<constructor specifiers="explicit" cv="noexcept"><parameter name="value"><paramtype>value_type const &</paramtype></parameter></constructor> 3928<constructor cv="noexcept"><parameter name="that"><paramtype><classname>to_log_manip</classname> const &</paramtype></parameter></constructor> 3929</class> 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013<function name="operator<<"><type><emphasis>unspecified</emphasis></type><template> 4014 <template-type-parameter name="StreamT"/> 4015 <template-type-parameter name="T"/> 4016 <template-type-parameter name="TagT"/> 4017 </template><parameter name="strm"><paramtype>StreamT &</paramtype></parameter><parameter name="manip"><paramtype><classname>to_log_manip</classname>< T, TagT ></paramtype></parameter></function> 4018<function name="to_log"><type><classname>to_log_manip</classname>< T ></type><template> 4019 <template-type-parameter name="T"/> 4020 </template><parameter name="value"><paramtype>T const &</paramtype></parameter></function> 4021<function name="to_log"><type><classname>to_log_manip</classname>< T, TagT ></type><template> 4022 <template-type-parameter name="TagT"/> 4023 <template-type-parameter name="T"/> 4024 </template><parameter name="value"><paramtype>T const &</paramtype></parameter></function> 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051</namespace> 4052</namespace> 4053</header> 4054<header name="boost/log/utility/manipulators/tuple.hpp"> 4055<para><para>Andrey Semashev </para> 4056 4057<para>11.05.2020</para> 4058 4059The header contains implementation of a stream manipulator for inserting a tuple or any heterogeneous sequence of elements, optionally separated with a delimiter. </para><namespace name="boost"> 4060<namespace name="log"> 4061<class name="tuple_manipulator"><template> 4062 <template-type-parameter name="TupleT"/> 4063 <template-type-parameter name="DelimiterT"/> 4064 </template><description><para>Stream manipulator for inserting a heterogeneous sequence of elements, optionally separated with a delimiter. </para></description><struct name="output_visitor"><template> 4065 <template-type-parameter name="StreamT"/> 4066 </template><typedef name="result_type"><type>boost::true_type</type></typedef> 4067<method-group name="public member functions"> 4068<method name="operator()" cv="const"><type>result_type</type><template> 4069 <template-type-parameter name="T"/> 4070 </template><parameter name=""><paramtype>boost::true_type</paramtype></parameter><parameter name="elem"><paramtype>T const &</paramtype></parameter></method> 4071<method name="operator()" cv="const"><type>result_type</type><template> 4072 <template-type-parameter name="T"/> 4073 </template><parameter name=""><paramtype>boost::false_type</paramtype></parameter><parameter name="elem"><paramtype>T const &</paramtype></parameter></method> 4074</method-group> 4075<constructor cv="noexcept"><parameter name="stream"><paramtype>StreamT &</paramtype></parameter><parameter name="delimiter"><paramtype>stored_delimiter_type</paramtype></parameter></constructor> 4076</struct><method-group name="public member functions"> 4077<method name="output" cv="const"><type>void</type><template> 4078 <template-type-parameter name="StreamT"/> 4079 </template><parameter name="stream"><paramtype>StreamT &</paramtype></parameter><purpose>The method outputs elements of the sequence separated with delimiter. </purpose></method> 4080</method-group> 4081<constructor cv="noexcept"><parameter name="tuple"><paramtype>TupleT const &</paramtype></parameter><parameter name="delimiter"><paramtype>stored_delimiter_type</paramtype></parameter><purpose>Initializing constructor. </purpose></constructor> 4082</class><class-specialization name="tuple_manipulator"><template> 4083 <template-type-parameter name="TupleT"/> 4084 </template><specialization><template-arg>TupleT</template-arg><template-arg>void</template-arg></specialization><description><para>Stream manipulator for inserting a heterogeneous sequence of elements. Specialization for when there is no delimiter. </para></description><struct name="output_visitor"><template> 4085 <template-type-parameter name="StreamT"/> 4086 </template><typedef name="result_type"><type>void</type></typedef> 4087<method-group name="public member functions"> 4088<method name="operator()" cv="const"><type>result_type</type><template> 4089 <template-type-parameter name="T"/> 4090 </template><parameter name="elem"><paramtype>T const &</paramtype></parameter></method> 4091</method-group> 4092<constructor specifiers="explicit" cv="noexcept"><parameter name="stream"><paramtype>StreamT &</paramtype></parameter></constructor> 4093</struct><method-group name="public member functions"> 4094<method name="output" cv="const"><type>void</type><template> 4095 <template-type-parameter name="StreamT"/> 4096 </template><parameter name="stream"><paramtype>StreamT &</paramtype></parameter><purpose>The method outputs elements of the sequence. </purpose></method> 4097</method-group> 4098<constructor specifiers="explicit" cv="noexcept"><parameter name="tuple"><paramtype>TupleT const &</paramtype></parameter><purpose>Initializing constructor. </purpose></constructor> 4099</class-specialization> 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178<function name="operator<<"><type><emphasis>unspecified</emphasis></type><template> 4179 <template-type-parameter name="StreamT"/> 4180 <template-type-parameter name="TupleT"/> 4181 <template-type-parameter name="DelimiterT"/> 4182 </template><parameter name="strm"><paramtype>StreamT &</paramtype></parameter><parameter name="manip"><paramtype><classname>tuple_manipulator</classname>< TupleT, DelimiterT > const &</paramtype></parameter><description><para>Stream output operator for <computeroutput><classname alt="boost::log::tuple_manipulator">tuple_manipulator</classname></computeroutput>. Outputs every element of the sequence, separated with a delimiter, if one was specified on manipulator construction. </para></description></function> 4183<function name="tuple_manip"><type>boost::enable_if_c< is_scalar< DelimiterT >::value, <classname>tuple_manipulator</classname>< TupleT, DelimiterT >>::type</type><template> 4184 <template-type-parameter name="TupleT"/> 4185 <template-type-parameter name="DelimiterT"/> 4186 </template><parameter name="tuple"><paramtype>TupleT const &</paramtype><description><para>Heterogeneous sequence of elements to output. The sequence must be supported by Boost.Fusion, and its elements must support stream output. </para></description></parameter><parameter name="delimiter"><paramtype>DelimiterT</paramtype><description><para>Delimiter to separate elements in the output. Optional. If not specified, elements are output without separation. </para></description></parameter><description><para>Tuple manipulator generator function.</para><para> 4187 4188<note><para>Both <emphasis>tuple</emphasis> and <emphasis>delimiter</emphasis> objects must outlive the created manipulator object. </para> 4189</note> 4190</para></description><returns><para>Manipulator to be inserted into the stream.</para> 4191</returns></function> 4192<function name="tuple_manip"><type>boost::disable_if_c< is_scalar< DelimiterT >::value, <classname>tuple_manipulator</classname>< TupleT, DelimiterT >>::type</type><template> 4193 <template-type-parameter name="TupleT"/> 4194 <template-type-parameter name="DelimiterT"/> 4195 </template><parameter name="tuple"><paramtype>TupleT const &</paramtype><description><para>Heterogeneous sequence of elements to output. The sequence must be supported by Boost.Fusion, and its elements must support stream output. </para></description></parameter><parameter name="delimiter"><paramtype>DelimiterT const &</paramtype><description><para>Delimiter to separate elements in the output. Optional. If not specified, elements are output without separation. </para></description></parameter><description><para>Tuple manipulator generator function.</para><para> 4196 4197<note><para>Both <emphasis>tuple</emphasis> and <emphasis>delimiter</emphasis> objects must outlive the created manipulator object. </para> 4198</note> 4199</para></description><returns><para>Manipulator to be inserted into the stream.</para> 4200</returns></function> 4201<function name="tuple_manip"><type><classname>tuple_manipulator</classname>< TupleT, DelimiterElementT * ></type><template> 4202 <template-type-parameter name="TupleT"/> 4203 <template-type-parameter name="DelimiterElementT"/> 4204 <template-nontype-parameter name="N"><type>std::size_t</type></template-nontype-parameter> 4205 </template><parameter name="tuple"><paramtype>TupleT const &</paramtype><description><para>Heterogeneous sequence of elements to output. The sequence must be supported by Boost.Fusion, and its elements must support stream output. </para></description></parameter><parameter name="delimiter"><paramtype>DelimiterElementT(&)</paramtype><description><para>Delimiter to separate elements in the output. Optional. If not specified, elements are output without separation. </para></description></parameter><description><para>Tuple manipulator generator function.</para><para> 4206 4207<note><para>Both <emphasis>tuple</emphasis> and <emphasis>delimiter</emphasis> objects must outlive the created manipulator object. </para> 4208</note> 4209</para></description><returns><para>Manipulator to be inserted into the stream.</para> 4210</returns></function> 4211<function name="tuple_manip"><type><classname>tuple_manipulator</classname>< TupleT, void ></type><template> 4212 <template-type-parameter name="TupleT"/> 4213 </template><parameter name="tuple"><paramtype>TupleT const &</paramtype><description><para>Heterogeneous sequence of elements to output. The sequence must be supported by Boost.Fusion, and its elements must support stream output. </para></description></parameter><description><para>Tuple manipulator generator function.</para><para> 4214 4215<note><para><emphasis>tuple</emphasis> object must outlive the created manipulator object. </para> 4216</note> 4217</para></description><returns><para>Manipulator to be inserted into the stream.</para> 4218</returns></function> 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248</namespace> 4249</namespace> 4250</header> 4251<header name="boost/log/utility/once_block.hpp"> 4252<para>The header defines classes and macros for once-blocks. </para><para><para>Andrey Semashev </para> 4253 4254<para>23.06.2010 </para> 4255 4256</para><namespace name="boost"> 4257<namespace name="log"> 4258<struct name="once_block_flag"><purpose>A flag to detect if a code block has already been executed. </purpose><description><para>This structure should be used in conjunction with the <computeroutput>BOOST_LOG_ONCE_BLOCK_FLAG</computeroutput> macro. Usage example:</para><para><computeroutput> <classname alt="boost::log::once_block_flag">once_block_flag</classname> flag = BOOST_LOG_ONCE_BLOCK_INIT;</computeroutput></para><para><computeroutput>void foo() { BOOST_LOG_ONCE_BLOCK_FLAG(flag) { puts("Hello, world once!"); } } </computeroutput> </para></description></struct> 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371</namespace> 4372</namespace> 4373<macro name="BOOST_LOG_ONCE_BLOCK_INIT"><description><para>The static initializer for <computeroutput>once_block_flag</computeroutput>. </para></description></macro> 4374<macro name="BOOST_LOG_ONCE_BLOCK_FLAG" kind="functionlike"><macro-parameter name="flag_var"/><description><para>Begins a code block to be executed only once, with protection against thread concurrency. User has to provide the flag variable that controls whether the block has already been executed. </para></description></macro> 4375<macro name="BOOST_LOG_ONCE_BLOCK" kind="functionlike"><macro-parameter name=""/><description><para>Begins a code block to be executed only once, with protection against thread concurrency. </para></description></macro> 4376</header> 4377<header name="boost/log/utility/open_mode.hpp"> 4378<para><para>Andrey Semashev </para> 4379 4380<para>01.01.2016</para> 4381 4382The header defines resource opening modes. </para><namespace name="boost"> 4383<namespace name="log"> 4384<namespace name="open_mode"> 4385<struct name="create_only_tag"><purpose>Create a new resource; fail if exists already. </purpose></struct><struct name="open_only_tag"><purpose>Opens an existing resource; fail if not exist. </purpose></struct><struct name="open_or_create_tag"><purpose>Creates a new resource or opens an existing one. </purpose></struct><data-member name="create_only"><type>struct <classname>boost::log::open_mode::create_only_tag</classname></type></data-member> 4386<data-member name="open_only"><type>struct <classname>boost::log::open_mode::open_only_tag</classname></type></data-member> 4387<data-member name="open_or_create"><type>struct <classname>boost::log::open_mode::open_or_create_tag</classname></type></data-member> 4388</namespace> 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502</namespace> 4503</namespace> 4504</header> 4505<header name="boost/log/utility/permissions.hpp"> 4506<para><para>Lingxi Li </para> 4507 4508<para>Andrey Semashev </para> 4509 4510<para>14.10.2015</para> 4511 4512The header contains an abstraction wrapper for security permissions. </para><namespace name="boost"> 4513<namespace name="interprocess"> 4514</namespace> 4515<namespace name="log"> 4516<class name="permissions"><purpose>Access permissions wrapper. </purpose><description><para>On Windows platforms, it represents a pointer to <computeroutput>SECURITY_ATTRIBUTES</computeroutput>. The user is responsible for allocating and reclaiming resources associated with the pointer, <computeroutput>permissions</computeroutput> instance does not own them.</para><para>On POSIX platforms, it represents a <computeroutput>mode_t</computeroutput> value. </para></description><typedef name="native_type"><purpose>The type of security permissions, specific to the operating system. </purpose><type>implementation_defined</type></typedef> 4517<method-group name="public member functions"> 4518<method name="set_native" cv="noexcept"><type>void</type><parameter name="perms"><paramtype>native_type</paramtype></parameter><description><para>Sets permissions from the OS-specific permissions. </para></description></method> 4519<method name="get_native" cv="const noexcept"><type>native_type</type><description><para>Returns the underlying OS-specific permissions. </para></description></method> 4520<method name="set_default" cv="noexcept"><type>void</type><description><para>Sets the default permissions, which are equivalent to <computeroutput>NULL</computeroutput> <computeroutput>SECURITY_ATTRIBUTES</computeroutput> on Windows and <computeroutput>0644</computeroutput> on POSIX platforms. </para></description></method> 4521<method name="set_unrestricted"><type>void</type><description><para>Sets unrestricted permissions, which are equivalent to <computeroutput>SECURITY_ATTRIBUTES</computeroutput> with <computeroutput>NULL</computeroutput> DACL on Windows and <computeroutput>0666</computeroutput> on POSIX platforms. </para></description></method> 4522<method name="swap" cv="noexcept"><type>void</type><parameter name="that"><paramtype><classname>permissions</classname> &</paramtype><description><para>The other object to swap with. </para></description></parameter><description><para>The method swaps the object with <emphasis>that</emphasis>.</para><para> 4523</para></description></method> 4524</method-group> 4525<constructor cv="noexcept"><description><para>Default constructor. The method constructs an object that represents a null <computeroutput>SECURITY_ATTRIBUTES</computeroutput> pointer on Windows platforms, and a <computeroutput>mode_t</computeroutput> value <computeroutput>0644</computeroutput> on POSIX platforms. </para></description></constructor> 4526<constructor cv="noexcept"><parameter name="that"><paramtype><classname>permissions</classname> const &</paramtype></parameter><description><para>Copy constructor. </para></description></constructor> 4527<copy-assignment cv="noexcept"><type><classname>permissions</classname> &</type><parameter name="that"><paramtype><classname>permissions</classname> const &</paramtype></parameter><description><para>Copy assignment. </para></description></copy-assignment> 4528<constructor cv="noexcept"><parameter name="perms"><paramtype>native_type</paramtype></parameter><description><para>Initializing constructor. </para></description></constructor> 4529<constructor cv="noexcept"><parameter name="perms"><paramtype>boost::interprocess::permissions const &</paramtype></parameter><description><para>Initializing constructor. </para></description></constructor> 4530<constructor cv="noexcept"><parameter name="that"><paramtype><classname>permissions</classname> &&</paramtype></parameter><description><para>Move constructor. </para></description></constructor> 4531<copy-assignment cv="noexcept"><type><classname>permissions</classname> &</type><parameter name="that"><paramtype><classname>permissions</classname> &&</paramtype></parameter><description><para>Move assignment. </para></description></copy-assignment> 4532<method-group name="friend functions"> 4533<method name="swap" cv="noexcept"><type>friend void</type><parameter name="a"><paramtype><classname>permissions</classname> &</paramtype></parameter><parameter name="b"><paramtype><classname>permissions</classname> &</paramtype></parameter><purpose>Swaps the two <computeroutput>permissions</computeroutput> objects. </purpose></method> 4534</method-group> 4535</class> 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648</namespace> 4649</namespace> 4650</header> 4651<header name="boost/log/utility/record_ordering.hpp"> 4652<para><para>Andrey Semashev </para> 4653 4654<para>23.08.2009</para> 4655 4656This header contains ordering predicates for logging records. </para><namespace name="boost"> 4657<namespace name="log"> 4658<class name="abstract_ordering"><template> 4659 <template-type-parameter name="FunT"><default><classname alt="boost::log::less">less</classname></default></template-type-parameter> 4660 </template><inherit access="private">FunT</inherit><purpose>Ordering predicate, based on opaque pointers to the record view implementation data. </purpose><description><para>Since record views only refer to a shared implementation data, this predicate is able to order the views by comparing the pointers to the data. Therefore two views are considered to be equivalent if they refer to the same implementation data. Otherwise it is not specified whether one record is ordered before the other until the predicate is applied. Note that the ordering may change every time the application runs.</para><para>This kind of ordering may be useful if log records are to be stored in an associative container with as least performance overhead as possible, when the particular order is not important.</para><para>The <computeroutput>FunT</computeroutput> template argument is the predicate that is used to actually compare pointers. It should be able to compare <computeroutput>const void*</computeroutput> pointers. The compared pointers may refer to distinct memory regions, the pointers must not be interpreted in any way. </para></description><typedef name="result_type"><purpose>Result type. </purpose><type>bool</type></typedef> 4661<method-group name="public member functions"> 4662<method name="operator()" cv="const"><type>result_type</type><parameter name="left"><paramtype>record_view const &</paramtype></parameter><parameter name="right"><paramtype>record_view const &</paramtype></parameter><description><para>Ordering operator </para></description></method> 4663</method-group> 4664<constructor><description><para>Default constructor. Requires <computeroutput>FunT</computeroutput> to be default constructible. </para></description></constructor> 4665<constructor specifiers="explicit"><parameter name="fun"><paramtype>FunT const &</paramtype></parameter><description><para>Initializing constructor. Constructs <computeroutput>FunT</computeroutput> instance as a copy of the <emphasis>fun</emphasis> argument. </para></description></constructor> 4666</class><class name="attribute_value_ordering"><template> 4667 <template-type-parameter name="ValueT"/> 4668 <template-type-parameter name="FunT"><default><classname alt="boost::log::less">less</classname></default></template-type-parameter> 4669 </template><inherit access="private">FunT</inherit><purpose>Ordering predicate, based on attribute values associated with records. </purpose><description><para>This predicate allows to order log records based on values of a specifically named attribute associated with them. Two given log records being compared should both have the specified attribute value of the specified type to be able to be ordered properly. As a special case, if neither of the records have the value, these records are considered equivalent. Otherwise, the ordering results are unspecified. </para></description><struct name="l1_visitor"><typedef name="result_type"><type>void</type></typedef> 4670<method-group name="public member functions"> 4671<method name="operator()" cv="const"><type>result_type</type><template> 4672 <template-type-parameter name="LeftT"/> 4673 </template><parameter name="left"><paramtype>LeftT const &</paramtype></parameter></method> 4674</method-group> 4675<constructor><parameter name="owner"><paramtype><classname>attribute_value_ordering</classname> const &</paramtype></parameter><parameter name="right"><paramtype>record_view const &</paramtype></parameter><parameter name="result"><paramtype>bool &</paramtype></parameter></constructor> 4676</struct><struct name="l2_visitor"><template> 4677 <template-type-parameter name="LeftT"/> 4678 </template><typedef name="result_type"><type>void</type></typedef> 4679<method-group name="public member functions"> 4680<method name="operator()" cv="const"><type>result_type</type><template> 4681 <template-type-parameter name="RightT"/> 4682 </template><parameter name="right"><paramtype>RightT const &</paramtype></parameter></method> 4683</method-group> 4684<constructor><parameter name="fun"><paramtype>FunT const &</paramtype></parameter><parameter name="left"><paramtype>LeftT const &</paramtype></parameter><parameter name="result"><paramtype>bool &</paramtype></parameter></constructor> 4685</struct><typedef name="result_type"><purpose>Result type. </purpose><type>bool</type></typedef> 4686<typedef name="value_type"><purpose>Compared attribute value type. </purpose><type>ValueT</type></typedef> 4687<method-group name="public member functions"> 4688<method name="operator()" cv="const"><type>result_type</type><parameter name="left"><paramtype>record_view const &</paramtype></parameter><parameter name="right"><paramtype>record_view const &</paramtype></parameter><description><para>Ordering operator </para></description></method> 4689</method-group> 4690<constructor specifiers="explicit"><parameter name="name"><paramtype>attribute_name const &</paramtype><description><para>The attribute value name to be compared </para></description></parameter><parameter name="fun"><paramtype>FunT const &</paramtype><default>FunT()</default><description><para>The ordering functor </para></description></parameter><description><para>Initializing constructor.</para><para> 4691</para></description></constructor> 4692</class> 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716<function name="make_attr_ordering"><type><classname>attribute_value_ordering</classname>< ValueT, FunT ></type><template> 4717 <template-type-parameter name="ValueT"/> 4718 <template-type-parameter name="FunT"/> 4719 </template><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="fun"><paramtype>FunT const &</paramtype></parameter><description><para>The function constructs a log record ordering predicate </para></description></function> 4720<function name="make_attr_ordering"><type><emphasis>unspecified</emphasis></type><template> 4721 <template-type-parameter name="FunT"/> 4722 </template><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="fun"><paramtype>FunT const &</paramtype></parameter><description><para>The function constructs a log record ordering predicate </para></description></function> 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810</namespace> 4811</namespace> 4812</header> 4813<header name="boost/log/utility/setup.hpp"> 4814<para><para>Andrey Semashev </para> 4815 4816<para>16.02.2013</para> 4817 4818This header includes all library setup helpers. </para></header> 4819<header name="boost/log/utility/setup/common_attributes.hpp"> 4820<para><para>Andrey Semashev </para> 4821 4822<para>16.05.2008</para> 4823 4824The header contains implementation of convenience functions for registering commonly used attributes. </para><namespace name="boost"> 4825<namespace name="log"> 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890<function name="add_common_attributes"><type>void</type><purpose>Simple attribute initialization routine. </purpose><description><para>The function adds commonly used attributes to the logging system. Specifically, the following attributes are registered globally:</para><para><itemizedlist> 4891<listitem><para>LineID - logging records counter with value type <computeroutput>unsigned int</computeroutput> </para> 4892</listitem> 4893<listitem><para>TimeStamp - local time generator with value type <computeroutput>boost::posix_time::ptime</computeroutput> </para> 4894</listitem> 4895<listitem><para>ProcessID - current process identifier with value type <computeroutput>attributes::current_process_id::value_type</computeroutput> </para> 4896</listitem> 4897<listitem><para>ThreadID - in multithreaded builds, current thread identifier with value type <computeroutput>attributes::current_thread_id::value_type</computeroutput> </para> 4898</listitem> 4899</itemizedlist> 4900</para></description></function> 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949</namespace> 4950</namespace> 4951</header> 4952<header name="boost/log/utility/setup/console.hpp"> 4953<para><para>Andrey Semashev </para> 4954 4955<para>16.05.2008</para> 4956 4957The header contains implementation of convenience functions for enabling logging to console. </para><namespace name="boost"> 4958<namespace name="log"> 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019<function name="add_console_log"><type>shared_ptr< sinks::synchronous_sink< sinks::basic_text_ostream_backend< CharT > >></type><template> 5020 <template-type-parameter name="CharT"/> 5021 <template-nontype-parameter name="ArgsT"><type>typename...</type></template-nontype-parameter> 5022 </template><parameter name="strm"><paramtype>std::basic_ostream< CharT > &</paramtype><description><para>One of the standard console streams: <computeroutput>std::cout</computeroutput>, <computeroutput>std::cerr</computeroutput> or <computeroutput>std::clog</computeroutput> (or the corresponding wide-character analogues). </para></description></parameter><parameter name="args"><paramtype>ArgsT... const &</paramtype><description><para>Optional additional named arguments for the sink initialization. The following arguments are supported: <itemizedlist> 5023<listitem><para><computeroutput>filter</computeroutput> Specifies a filter to install into the sink. May be a string that represents a filter, or a filter lambda expression. </para> 5024</listitem> 5025<listitem><para><computeroutput>format</computeroutput> Specifies a formatter to install into the sink. May be a string that represents a formatter, or a formatter lambda expression (either streaming or Boost.Format-like notation). </para> 5026</listitem> 5027<listitem><para><computeroutput>auto_flush</computeroutput> A boolean flag that shows whether the sink should automatically flush the stream after each written record. </para> 5028</listitem> 5029<listitem><para><computeroutput>auto_newline_mode</computeroutput> - Specifies automatic trailing newline insertion mode. Must be a value of the <computeroutput>auto_newline_mode</computeroutput> enum. By default, is <computeroutput>auto_newline_mode::insert_if_missing</computeroutput>. </para> 5030</listitem> 5031</itemizedlist> 5032</para></description></parameter><description><para>The function constructs sink for the specified console stream and adds it to the core</para><para> 5033 5034</para></description><returns><para>Pointer to the constructed sink. </para> 5035</returns></function> 5036<function name="add_console_log"><type>shared_ptr< sinks::synchronous_sink< sinks::basic_text_ostream_backend< CharT > >></type><template> 5037 <template-type-parameter name="CharT"/> 5038 <template-nontype-parameter name="ArgsT"><type>typename...</type></template-nontype-parameter> 5039 </template><parameter name="args"><paramtype>ArgsT... const &</paramtype></parameter><description><para>Equivalent to: <computeroutput>add_console_log(std::clog);</computeroutput> or <computeroutput>add_console_log(std::wclog);</computeroutput>, depending on the <computeroutput>CharT</computeroutput> type.</para><para>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </para></description></function> 5040<function name="add_console_log"><type>shared_ptr< sinks::synchronous_sink< sinks::text_ostream_backend >></type><description><para>The function constructs sink for the <computeroutput>std::clog</computeroutput> stream and adds it to the core</para><para>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.</para><para> 5041</para></description><returns><para>Pointer to the constructed sink. </para> 5042</returns></function> 5043<function name="wadd_console_log"><type>shared_ptr< sinks::synchronous_sink< sinks::wtext_ostream_backend >></type><description><para>The function constructs sink for the <computeroutput>std::wclog</computeroutput> stream and adds it to the core</para><para> 5044</para></description><returns><para>Pointer to the constructed sink. </para> 5045</returns></function> 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095</namespace> 5096</namespace> 5097</header> 5098<header name="boost/log/utility/setup/file.hpp"> 5099<para><para>Andrey Semashev </para> 5100 5101<para>16.05.2008</para> 5102 5103The header contains implementation of convenience functions for enabling logging to a file. </para><namespace name="boost"> 5104<namespace name="log"> 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164<function name="add_file_log"><type>shared_ptr< sinks::synchronous_sink< sinks::text_file_backend > ></type><template> 5165 <template-nontype-parameter name="ArgsT"><type>typename...</type></template-nontype-parameter> 5166 </template><parameter name="args"><paramtype>ArgsT... const &</paramtype><description><para>A number of named arguments. The following parameters are supported: <itemizedlist> 5167<listitem><para><computeroutput>file_name</computeroutput> The active file name or its pattern. This parameter is mandatory. </para> 5168</listitem> 5169<listitem><para><computeroutput>target_file_name</computeroutput> - Specifies the target file name pattern to use to rename the log file on rotation, before passing it to the file collector. The pattern may contain the same placeholders as the <computeroutput>file_name</computeroutput> parameter. By default, no renaming is done, i.e. the written log file keeps its name according to <computeroutput>file_name</computeroutput>. </para> 5170</listitem> 5171<listitem><para><computeroutput>open_mode</computeroutput> The mask that describes the open mode for the file. See <computeroutput>std::ios_base::openmode</computeroutput>. </para> 5172</listitem> 5173<listitem><para><computeroutput>rotation_size</computeroutput> The size of the file at which rotation should occur. See <computeroutput>basic_text_file_backend</computeroutput>. </para> 5174</listitem> 5175<listitem><para><computeroutput>time_based_rotation</computeroutput> The predicate for time-based file rotations. See <computeroutput>basic_text_file_backend</computeroutput>. </para> 5176</listitem> 5177<listitem><para><computeroutput>auto_flush</computeroutput> A boolean flag that shows whether the sink should automatically flush the file after each written record. </para> 5178</listitem> 5179<listitem><para><computeroutput>auto_newline_mode</computeroutput> - Specifies automatic trailing newline insertion mode. Must be a value of the <computeroutput>auto_newline_mode</computeroutput> enum. By default, is <computeroutput>auto_newline_mode::insert_if_missing</computeroutput>. </para> 5180</listitem> 5181<listitem><para><computeroutput>target</computeroutput> The target directory to store rotated files in. See <computeroutput>sinks::file::make_collector</computeroutput>. </para> 5182</listitem> 5183<listitem><para><computeroutput>max_size</computeroutput> The maximum total size of rotated files in the target directory. See <computeroutput>sinks::file::make_collector</computeroutput>. </para> 5184</listitem> 5185<listitem><para><computeroutput>min_free_space</computeroutput> Minimum free space in the target directory. See <computeroutput>sinks::file::make_collector</computeroutput>. </para> 5186</listitem> 5187<listitem><para><computeroutput>max_files</computeroutput> The maximum total number of rotated files in the target directory. See <computeroutput>sinks::file::make_collector</computeroutput>. </para> 5188</listitem> 5189<listitem><para><computeroutput>scan_method</computeroutput> The method of scanning the target directory for log files. See <computeroutput>sinks::file::scan_method</computeroutput>. </para> 5190</listitem> 5191<listitem><para><computeroutput>filter</computeroutput> Specifies a filter to install into the sink. May be a string that represents a filter, or a filter lambda expression. </para> 5192</listitem> 5193<listitem><para><computeroutput>format</computeroutput> Specifies a formatter to install into the sink. May be a string that represents a formatter, or a formatter lambda expression (either streaming or Boost.Format-like notation). </para> 5194</listitem> 5195</itemizedlist> 5196</para></description></parameter><description><para>The function initializes the logging library to write logs to a file stream.</para><para> 5197 5198</para></description><returns><para>Pointer to the constructed sink. </para> 5199</returns></function> 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253</namespace> 5254</namespace> 5255</header> 5256<header name="boost/log/utility/setup/filter_parser.hpp"> 5257<para><para>Andrey Semashev </para> 5258 5259<para>31.03.2008</para> 5260 5261The header contains definition of a filter parser function. </para><namespace name="boost"> 5262<namespace name="log"> 5263<class name="basic_filter_factory"><template> 5264 <template-type-parameter name="CharT"/> 5265 <template-type-parameter name="AttributeValueT"/> 5266 </template><inherit access="public">boost::log::filter_factory< CharT ></inherit><description><para>The base class for filter factories. The class defines default implementations for most filter expressions. In order to be able to construct filters, the attribute value type must support reading from a stream. Also, the default filters will rely on relational operators for the type, so these operators must also be defined. </para></description><typedef name="value_type"><purpose>The type(s) of the attribute value expected. </purpose><type>AttributeValueT</type></typedef> 5267<typedef name="string_type"><type>base_type::string_type</type></typedef> 5268<method-group name="public member functions"> 5269<method name="on_exists_test" specifiers="virtual"><type>filter</type><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><description><para>The callback for filter for the attribute existence test </para></description></method> 5270<method name="on_equality_relation" specifiers="virtual"><type>filter</type><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="arg"><paramtype>string_type const &</paramtype></parameter><description><para>The callback for equality relation filter </para></description></method> 5271<method name="on_inequality_relation" specifiers="virtual"><type>filter</type><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="arg"><paramtype>string_type const &</paramtype></parameter><description><para>The callback for inequality relation filter </para></description></method> 5272<method name="on_less_relation" specifiers="virtual"><type>filter</type><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="arg"><paramtype>string_type const &</paramtype></parameter><description><para>The callback for less relation filter </para></description></method> 5273<method name="on_greater_relation" specifiers="virtual"><type>filter</type><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="arg"><paramtype>string_type const &</paramtype></parameter><description><para>The callback for greater relation filter </para></description></method> 5274<method name="on_less_or_equal_relation" specifiers="virtual"><type>filter</type><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="arg"><paramtype>string_type const &</paramtype></parameter><description><para>The callback for less or equal relation filter </para></description></method> 5275<method name="on_greater_or_equal_relation" specifiers="virtual"><type>filter</type><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="arg"><paramtype>string_type const &</paramtype></parameter><description><para>The callback for greater or equal relation filter </para></description></method> 5276<method name="on_custom_relation" specifiers="virtual"><type>filter</type><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="rel"><paramtype>string_type const &</paramtype></parameter><parameter name="arg"><paramtype>string_type const &</paramtype></parameter><description><para>The callback for custom relation filter </para></description></method> 5277<method name="parse_argument" specifiers="virtual"><type>value_type</type><parameter name="arg"><paramtype>string_type const &</paramtype></parameter><description><para>The function parses the argument value for a binary relation </para></description></method> 5278</method-group> 5279</class><struct name="filter_factory"><template> 5280 <template-type-parameter name="CharT"/> 5281 </template><description><para>The interface class for all filter factories. </para></description><typedef name="char_type"><purpose>Character type. </purpose><type>CharT</type></typedef> 5282<typedef name="string_type"><purpose>String type. </purpose><type>std::basic_string< char_type ></type></typedef> 5283<method-group name="public member functions"> 5284<method name="on_exists_test" specifiers="virtual"><type>filter</type><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><description><para>The callback for filter for the attribute existence test </para></description></method> 5285<method name="on_equality_relation" specifiers="virtual"><type>filter</type><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="arg"><paramtype>string_type const &</paramtype></parameter><description><para>The callback for equality relation filter </para></description></method> 5286<method name="on_inequality_relation" specifiers="virtual"><type>filter</type><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="arg"><paramtype>string_type const &</paramtype></parameter><description><para>The callback for inequality relation filter </para></description></method> 5287<method name="on_less_relation" specifiers="virtual"><type>filter</type><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="arg"><paramtype>string_type const &</paramtype></parameter><description><para>The callback for less relation filter </para></description></method> 5288<method name="on_greater_relation" specifiers="virtual"><type>filter</type><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="arg"><paramtype>string_type const &</paramtype></parameter><description><para>The callback for greater relation filter </para></description></method> 5289<method name="on_less_or_equal_relation" specifiers="virtual"><type>filter</type><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="arg"><paramtype>string_type const &</paramtype></parameter><description><para>The callback for less or equal relation filter </para></description></method> 5290<method name="on_greater_or_equal_relation" specifiers="virtual"><type>filter</type><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="arg"><paramtype>string_type const &</paramtype></parameter><description><para>The callback for greater or equal relation filter </para></description></method> 5291<method name="on_custom_relation" specifiers="virtual"><type>filter</type><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="rel"><paramtype>string_type const &</paramtype></parameter><parameter name="arg"><paramtype>string_type const &</paramtype></parameter><description><para>The callback for custom relation filter </para></description></method> 5292</method-group> 5293<destructor><description><para>Default constructor</para><para>Virtual destructor </para></description></destructor> 5294<constructor cv="= delete"><parameter name=""><paramtype><classname>filter_factory</classname> const &</paramtype></parameter></constructor> 5295<copy-assignment cv="= delete"><type><classname>filter_factory</classname> &</type><parameter name=""><paramtype><classname>filter_factory</classname> const &</paramtype></parameter></copy-assignment> 5296</struct> 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347<function name="register_filter_factory"><type>void</type><template> 5348 <template-type-parameter name="CharT"/> 5349 </template><parameter name="name"><paramtype>attribute_name const &</paramtype><description><para>Attribute name to associate the factory with </para></description></parameter><parameter name="factory"><paramtype>shared_ptr< <classname>filter_factory</classname>< CharT > > const &</paramtype><description><para>The filter factory </para></description></parameter><description><para>The function registers a filter factory object for the specified attribute name. The factory will be used to construct a filter during parsing the filter string.</para><para> 5350 5351</para></description><requires><para><computeroutput>name != NULL && factory != NULL</computeroutput>, <computeroutput>name</computeroutput> points to a zero-terminated string </para> 5352</requires></function> 5353<function name="register_filter_factory"><type>boost::enable_if_c< is_base_and_derived< <classname>filter_factory</classname>< typename FactoryT::char_type >, FactoryT >::value >::type</type><template> 5354 <template-type-parameter name="FactoryT"/> 5355 </template><parameter name="name"><paramtype>attribute_name const &</paramtype><description><para>Attribute name to associate the factory with </para></description></parameter><parameter name="factory"><paramtype>shared_ptr< FactoryT > const &</paramtype><description><para>The filter factory </para></description></parameter><description><para>The function registers a filter factory object for the specified attribute name. The factory will be used to construct a filter during parsing the filter string.</para><para> 5356 5357</para></description><requires><para><computeroutput>name != NULL && factory != NULL</computeroutput>, <computeroutput>name</computeroutput> points to a zero-terminated string </para> 5358</requires></function> 5359<function name="register_simple_filter_factory"><type>void</type><template> 5360 <template-type-parameter name="AttributeValueT"/> 5361 <template-type-parameter name="CharT"/> 5362 </template><parameter name="name"><paramtype>attribute_name const &</paramtype><description><para>Attribute name to associate the factory with </para></description></parameter><description><para>The function registers a simple filter factory object for the specified attribute name. The factory will support attribute values of type <computeroutput>AttributeValueT</computeroutput>, which must support all relation operations, such as equality comparison and less/greater ordering, and also extraction from stream.</para><para> 5363 5364</para></description><requires><para><computeroutput>name != NULL</computeroutput>, <computeroutput>name</computeroutput> points to a zero-terminated string </para> 5365</requires></function> 5366<function name="register_simple_filter_factory"><type>void</type><template> 5367 <template-type-parameter name="AttributeValueT"/> 5368 </template><parameter name="name"><paramtype>attribute_name const &</paramtype><description><para>Attribute name to associate the factory with </para></description></parameter><description><para>The function registers a simple filter factory object for the specified attribute name. The factory will support attribute values of type <computeroutput>AttributeValueT</computeroutput>, which must support all relation operations, such as equality comparison and less/greater ordering, and also extraction from stream.</para><para> 5369 5370</para></description><requires><para><computeroutput>name != NULL</computeroutput>, <computeroutput>name</computeroutput> points to a zero-terminated string </para> 5371</requires></function> 5372<function name="register_simple_filter_factory"><type>void</type><template> 5373 <template-type-parameter name="CharT"/> 5374 <template-type-parameter name="DescriptorT"/> 5375 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 5376 </template><parameter name="keyword"><paramtype>expressions::attribute_keyword< DescriptorT, ActorT > const &</paramtype><description><para>Attribute keyword to associate the factory with </para></description></parameter><description><para>The function registers a simple filter factory object for the specified attribute keyword. The factory will support attribute values described by the keyword. The values must support all relation operations, such as equality comparison and less/greater ordering, and also extraction from stream.</para><para> 5377 5378</para></description><requires><para><computeroutput>name != NULL</computeroutput>, <computeroutput>name</computeroutput> points to a zero-terminated string </para> 5379</requires></function> 5380<function name="parse_filter"><type>filter</type><template> 5381 <template-type-parameter name="CharT"/> 5382 </template><parameter name="begin"><paramtype>const CharT *</paramtype><description><para>Pointer to the first character of the sequence </para></description></parameter><parameter name="end"><paramtype>const CharT *</paramtype><description><para>Pointer to the after-the-last character of the sequence </para></description></parameter><description><para>The function parses a filter from the sequence of characters</para><para> 5383 5384 5385<emphasis role="bold">Throws:</emphasis> An <computeroutput>std::exception</computeroutput>-based exception, if a filter cannot be recognized in the character sequence. </para></description><requires><para><computeroutput>begin <= end</computeroutput>, both pointers must not be <computeroutput>NULL</computeroutput> </para> 5386</requires><returns><para>A function object that can be used as a filter.</para> 5387</returns></function> 5388<function name="parse_filter"><type>filter</type><template> 5389 <template-type-parameter name="CharT"/> 5390 <template-type-parameter name="TraitsT"/> 5391 <template-type-parameter name="AllocatorT"/> 5392 </template><parameter name="str"><paramtype>std::basic_string< CharT, TraitsT, AllocatorT > const &</paramtype><description><para>A string that contains filter description </para></description></parameter><description><para>The function parses a filter from the string</para><para> 5393 5394<emphasis role="bold">Throws:</emphasis> An <computeroutput>std::exception</computeroutput>-based exception, if a filter cannot be recognized in the character sequence. </para></description><returns><para>A function object that can be used as a filter.</para> 5395</returns></function> 5396<function name="parse_filter"><type>filter</type><template> 5397 <template-type-parameter name="CharT"/> 5398 </template><parameter name="str"><paramtype>const CharT *</paramtype><description><para>A string that contains filter description. </para></description></parameter><description><para>The function parses a filter from the string</para><para> 5399 5400 5401<emphasis role="bold">Throws:</emphasis> An <computeroutput>std::exception</computeroutput>-based exception, if a filter cannot be recognized in the character sequence. </para></description><requires><para><computeroutput>str != NULL</computeroutput>, <computeroutput>str</computeroutput> points to a zero-terminated string. </para> 5402</requires><returns><para>A function object that can be used as a filter.</para> 5403</returns></function> 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458</namespace> 5459</namespace> 5460</header> 5461<header name="boost/log/utility/setup/formatter_parser.hpp"> 5462<para><para>Andrey Semashev </para> 5463 5464<para>07.04.2008</para> 5465 5466The header contains definition of a formatter parser function, along with facilities to add support for custom formatters. </para><namespace name="boost"> 5467<namespace name="log"> 5468<class name="basic_formatter_factory"><template> 5469 <template-type-parameter name="CharT"/> 5470 <template-type-parameter name="AttributeValueT"/> 5471 </template><inherit access="public">boost::log::formatter_factory< CharT ></inherit><description><para>Base class for formatter factories. This class provides default implementation of formatter expressions for types supporting stream output. The factory does not take into account any additional parameters that may be specified. </para></description><typedef name="value_type"><purpose>Attribute value type. </purpose><type>AttributeValueT</type></typedef> 5472<typedef name="formatter_type"><type>base_type::formatter_type</type></typedef> 5473<typedef name="args_map"><type>base_type::args_map</type></typedef> 5474<method-group name="public member functions"> 5475<method name="create_formatter" specifiers="virtual"><type>formatter_type</type><parameter name="name"><paramtype>attribute_name const &</paramtype><description><para>Attribute name </para></description></parameter><parameter name="args"><paramtype>args_map const &</paramtype><description><para>Formatter arguments </para></description></parameter><description><para>The function creates a formatter for the specified attribute.</para><para> 5476</para></description></method> 5477</method-group> 5478</class><struct name="formatter_factory"><template> 5479 <template-type-parameter name="CharT"/> 5480 </template><description><para>Formatter factory base interface. </para></description><typedef name="char_type"><purpose>Character type. </purpose><type>CharT</type></typedef> 5481<typedef name="string_type"><purpose>String type. </purpose><type>std::basic_string< char_type ></type></typedef> 5482<typedef name="formatter_type"><purpose>The formatter function object. </purpose><type>basic_formatter< char_type ></type></typedef> 5483<typedef name="args_map"><description><para>Type of the map of formatter factory arguments [argument name -> argument value]. This type of maps will be passed to formatter factories on attempt to create a formatter. </para></description><type>std::map< string_type, string_type ></type></typedef> 5484<method-group name="public member functions"> 5485<method name="create_formatter" cv="= 0" specifiers="virtual"><type>formatter_type</type><parameter name="name"><paramtype>attribute_name const &</paramtype><description><para>Attribute name </para></description></parameter><parameter name="args"><paramtype>args_map const &</paramtype><description><para>Formatter arguments </para></description></parameter><description><para>The function creates a formatter for the specified attribute.</para><para> 5486</para></description></method> 5487</method-group> 5488<destructor><description><para>Default constructor</para><para>Virtual destructor </para></description></destructor> 5489<constructor cv="= delete"><parameter name=""><paramtype><classname>formatter_factory</classname> const &</paramtype></parameter></constructor> 5490<copy-assignment cv="= delete"><type><classname>formatter_factory</classname> &</type><parameter name=""><paramtype><classname>formatter_factory</classname> const &</paramtype></parameter></copy-assignment> 5491</struct> 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536<function name="register_formatter_factory"><type>void</type><template> 5537 <template-type-parameter name="CharT"/> 5538 </template><parameter name="attr_name"><paramtype>attribute_name const &</paramtype><description><para>Attribute name </para></description></parameter><parameter name="factory"><paramtype>shared_ptr< <classname>formatter_factory</classname>< CharT > > const &</paramtype><description><para>Pointer to the formatter factory </para></description></parameter><purpose>The function registers a user-defined formatter factory. </purpose><description><para>The function registers a user-defined formatter factory. The registered factory function will be called when the formatter parser detects the specified attribute name in the formatter string.</para><para> 5539 5540</para></description><requires><para><computeroutput>!!attr_name && !!factory</computeroutput>.</para> 5541</requires></function> 5542<function name="register_formatter_factory"><type>boost::enable_if_c< is_base_and_derived< <classname>formatter_factory</classname>< typename FactoryT::char_type >, FactoryT >::value >::type</type><template> 5543 <template-type-parameter name="FactoryT"/> 5544 </template><parameter name="attr_name"><paramtype>attribute_name const &</paramtype><description><para>Attribute name </para></description></parameter><parameter name="factory"><paramtype>shared_ptr< FactoryT > const &</paramtype><description><para>Pointer to the formatter factory </para></description></parameter><purpose>The function registers a user-defined formatter factory. </purpose><description><para>The function registers a user-defined formatter factory. The registered factory function will be called when the formatter parser detects the specified attribute name in the formatter string.</para><para> 5545 5546</para></description><requires><para><computeroutput>!!attr_name && !!factory</computeroutput>.</para> 5547</requires></function> 5548<function name="register_simple_formatter_factory"><type>void</type><template> 5549 <template-type-parameter name="AttributeValueT"/> 5550 <template-type-parameter name="CharT"/> 5551 </template><parameter name="attr_name"><paramtype>attribute_name const &</paramtype><description><para>Attribute name </para></description></parameter><purpose>The function registers a simple formatter factory. </purpose><description><para>The function registers a simple formatter factory. The registered factory will generate formatters that will be equivalent to the <computeroutput>log::expressions::attr</computeroutput> formatter (i.e. that will use the native <computeroutput>operator<<</computeroutput> to format the attribute value). The factory does not use any arguments from the format string, if specified.</para><para> 5552 5553</para></description><requires><para><computeroutput>!!attr_name</computeroutput>.</para> 5554</requires></function> 5555<function name="parse_formatter"><type>basic_formatter< CharT ></type><template> 5556 <template-type-parameter name="CharT"/> 5557 </template><parameter name="begin"><paramtype>const CharT *</paramtype><description><para>Pointer to the first character of the sequence </para></description></parameter><parameter name="end"><paramtype>const CharT *</paramtype><description><para>Pointer to the after-the-last character of the sequence </para></description></parameter><description><para>The function parses a formatter from the sequence of characters</para><para> 5558 5559 5560<emphasis role="bold">Throws:</emphasis> An <computeroutput>std::exception</computeroutput>-based exception, if a formatter cannot be recognized in the character sequence. </para></description><requires><para><computeroutput>begin <= end</computeroutput>, both pointers must not be NULL </para> 5561</requires><returns><para>The parsed formatter.</para> 5562</returns></function> 5563<function name="parse_formatter"><type>basic_formatter< CharT ></type><template> 5564 <template-type-parameter name="CharT"/> 5565 <template-type-parameter name="TraitsT"/> 5566 <template-type-parameter name="AllocatorT"/> 5567 </template><parameter name="str"><paramtype>std::basic_string< CharT, TraitsT, AllocatorT > const &</paramtype><description><para>A string that contains format description </para></description></parameter><description><para>The function parses a formatter from the string</para><para> 5568 5569<emphasis role="bold">Throws:</emphasis> An <computeroutput>std::exception</computeroutput>-based exception, if a formatter cannot be recognized in the character sequence. </para></description><returns><para>The parsed formatter.</para> 5570</returns></function> 5571<function name="parse_formatter"><type>basic_formatter< CharT ></type><template> 5572 <template-type-parameter name="CharT"/> 5573 </template><parameter name="str"><paramtype>const CharT *</paramtype><description><para>A string that contains format description. </para></description></parameter><description><para>The function parses a formatter from the string</para><para> 5574 5575 5576<emphasis role="bold">Throws:</emphasis> An <computeroutput>std::exception</computeroutput>-based exception, if a formatter cannot be recognized in the character sequence. </para></description><requires><para><computeroutput>str != NULL</computeroutput>, <computeroutput>str</computeroutput> points to a zero-terminated string </para> 5577</requires><returns><para>The parsed formatter.</para> 5578</returns></function> 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641</namespace> 5642</namespace> 5643</header> 5644<header name="boost/log/utility/setup/from_settings.hpp"> 5645<para><para>Andrey Semashev </para> 5646 5647<para>11.10.2009</para> 5648 5649The header contains definition of facilities that allows to initialize the library from settings. </para><namespace name="boost"> 5650<namespace name="log"> 5651<struct name="sink_factory"><template> 5652 <template-type-parameter name="CharT"/> 5653 </template><description><para>Sink factory base interface </para></description><typedef name="char_type"><purpose>Character type. </purpose><type>CharT</type></typedef> 5654<typedef name="string_type"><purpose>String type. </purpose><type>std::basic_string< char_type ></type></typedef> 5655<typedef name="settings_section"><purpose>Settings section type. </purpose><type><classname>basic_settings_section</classname>< char_type ></type></typedef> 5656<method-group name="public member functions"> 5657<method name="create_sink" cv="= 0" specifiers="virtual"><type>shared_ptr< sinks::sink ></type><parameter name="settings"><paramtype>settings_section const &</paramtype><description><para>Sink parameters </para></description></parameter><description><para>The function creates a formatter for the specified attribute.</para><para> 5658</para></description></method> 5659</method-group> 5660<destructor><description><para>Default constructor</para><para>Virtual destructor </para></description></destructor> 5661<constructor cv="= delete"><parameter name=""><paramtype><classname>sink_factory</classname> const &</paramtype></parameter></constructor> 5662<copy-assignment cv="= delete"><type><classname>sink_factory</classname> &</type><parameter name=""><paramtype><classname>sink_factory</classname> const &</paramtype></parameter></copy-assignment> 5663</struct> 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703<function name="init_from_settings"><type>void</type><template> 5704 <template-type-parameter name="CharT"/> 5705 </template><parameter name="setts"><paramtype><classname>basic_settings_section</classname>< CharT > const &</paramtype><description><para>Library settings container</para></description></parameter><description><para>The function initializes the logging library from a settings container</para><para> 5706<emphasis role="bold">Throws:</emphasis> An <computeroutput>std::exception</computeroutput>-based exception if the provided settings are not valid. </para></description></function> 5707<function name="register_sink_factory"><type>void</type><template> 5708 <template-type-parameter name="CharT"/> 5709 </template><parameter name="sink_name"><paramtype>const char *</paramtype><description><para>The custom sink name. Must point to a zero-terminated sequence of characters, must not be NULL. </para></description></parameter><parameter name="factory"><paramtype>shared_ptr< <classname>sink_factory</classname>< CharT > > const &</paramtype><description><para>Pointer to the custom sink factory. Must not be NULL. </para></description></parameter><purpose>The function registers a factory for a custom sink. </purpose><description><para>The function registers a factory for a sink. The factory will be called to create sink instance when the parser discovers the specified sink type in the settings file. The factory must accept a map of parameters [parameter name -> parameter value] that it may use to initialize the sink. The factory must return a non-NULL pointer to the constructed sink instance.</para><para> 5710</para></description></function> 5711<function name="register_sink_factory"><type>void</type><template> 5712 <template-type-parameter name="CharT"/> 5713 </template><parameter name="sink_name"><paramtype>std::string const &</paramtype><description><para>The custom sink name </para></description></parameter><parameter name="factory"><paramtype>shared_ptr< <classname>sink_factory</classname>< CharT > > const &</paramtype><description><para>Pointer to the custom sink factory. Must not be NULL. </para></description></parameter><purpose>The function registers a factory for a custom sink. </purpose><description><para>The function registers a factory for a sink. The factory will be called to create sink instance when the parser discovers the specified sink type in the settings file. The factory must accept a map of parameters [parameter name -> parameter value] that it may use to initialize the sink. The factory must return a non-NULL pointer to the constructed sink instance.</para><para> 5714</para></description></function> 5715<function name="register_sink_factory"><type>boost::enable_if_c< is_base_and_derived< <classname>sink_factory</classname>< typename FactoryT::char_type >, FactoryT >::value >::type</type><template> 5716 <template-type-parameter name="FactoryT"/> 5717 </template><parameter name="sink_name"><paramtype>const char *</paramtype><description><para>The custom sink name. Must point to a zero-terminated sequence of characters, must not be NULL. </para></description></parameter><parameter name="factory"><paramtype>shared_ptr< FactoryT > const &</paramtype><description><para>Pointer to the custom sink factory. Must not be NULL. </para></description></parameter><purpose>The function registers a factory for a custom sink. </purpose><description><para>The function registers a factory for a sink. The factory will be called to create sink instance when the parser discovers the specified sink type in the settings file. The factory must accept a map of parameters [parameter name -> parameter value] that it may use to initialize the sink. The factory must return a non-NULL pointer to the constructed sink instance.</para><para> 5718</para></description></function> 5719<function name="register_sink_factory"><type>boost::enable_if_c< is_base_and_derived< <classname>sink_factory</classname>< typename FactoryT::char_type >, FactoryT >::value >::type</type><template> 5720 <template-type-parameter name="FactoryT"/> 5721 </template><parameter name="sink_name"><paramtype>std::string const &</paramtype><description><para>The custom sink name </para></description></parameter><parameter name="factory"><paramtype>shared_ptr< FactoryT > const &</paramtype><description><para>Pointer to the custom sink factory. Must not be NULL. </para></description></parameter><purpose>The function registers a factory for a custom sink. </purpose><description><para>The function registers a factory for a sink. The factory will be called to create sink instance when the parser discovers the specified sink type in the settings file. The factory must accept a map of parameters [parameter name -> parameter value] that it may use to initialize the sink. The factory must return a non-NULL pointer to the constructed sink instance.</para><para> 5722</para></description></function> 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791</namespace> 5792</namespace> 5793</header> 5794<header name="boost/log/utility/setup/from_stream.hpp"> 5795<para><para>Andrey Semashev </para> 5796 5797<para>22.03.2008</para> 5798 5799The header contains definition of facilities that allows to initialize the library from a settings file. </para><namespace name="boost"> 5800<namespace name="log"> 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840<function name="init_from_stream"><type>void</type><template> 5841 <template-type-parameter name="CharT"/> 5842 </template><parameter name="strm"><paramtype>std::basic_istream< CharT > &</paramtype><description><para>Stream, that provides library settings</para></description></parameter><description><para>The function initializes the logging library from a stream containing logging settings</para><para> 5843<emphasis role="bold">Throws:</emphasis> An <computeroutput>std::exception</computeroutput>-based exception if the read data cannot be interpreted as the library settings </para></description></function> 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917</namespace> 5918</namespace> 5919</header> 5920<header name="boost/log/utility/setup/settings.hpp"> 5921<para><para>Andrey Semashev </para> 5922 5923<para>11.10.2009</para> 5924 5925The header contains definition of the library settings container. </para><namespace name="boost"> 5926<namespace name="log"> 5927<class name="basic_settings"><template> 5928 <template-type-parameter name="CharT"/> 5929 </template><inherit access="public">boost::log::basic_settings_section< CharT ></inherit><purpose>The class represents settings container. </purpose><description><para>All settings are presented as a number of named parameters divided into named sections. The parameters values are stored as strings. Individual parameters may be queried via subscript operators, like this:</para><para><computeroutput><programlisting> 5930optional< string > param = settings["Section1"]["Param1"]; // reads parameter "Param1" in section "Section1" 5931 // returns an empty value if no such parameter exists 5932settings["Section2"]["Param2"] = 10; // sets the parameter "Param2" in section "Section2" 5933 // to value "10" 5934</programlisting></computeroutput></para><para>There are also other methods to work with parameters. </para></description><typedef name="section"><purpose>Section type. </purpose><type><classname>basic_settings_section</classname>< CharT ></type></typedef> 5935<typedef name="property_tree_type"><purpose>Property tree type. </purpose><type>section::property_tree_type</type></typedef> 5936<method-group name="public member functions"> 5937</method-group> 5938<constructor><description><para>Default constructor. Creates an empty settings container. </para></description></constructor> 5939<constructor><parameter name="that"><paramtype><classname>basic_settings</classname> const &</paramtype></parameter><description><para>Copy constructor. </para></description></constructor> 5940<constructor cv="noexcept"><parameter name="that"><paramtype><classname>this_type</classname> &&</paramtype></parameter><description><para>Move constructor. </para></description></constructor> 5941<constructor specifiers="explicit"><parameter name="tree"><paramtype>property_tree_type const &</paramtype></parameter><description><para>Initializing constructor. Creates a settings container with the copy of the specified property tree. </para></description></constructor> 5942<destructor><description><para>Destructor </para></description></destructor> 5943<copy-assignment><type><classname>basic_settings</classname> &</type><parameter name="that"><paramtype><classname>basic_settings</classname> const &</paramtype></parameter><description><para>Copy assignment operator. </para></description></copy-assignment> 5944<copy-assignment cv="noexcept"><type><classname>basic_settings</classname> &</type><parameter name="that"><paramtype><classname>basic_settings</classname> &&</paramtype></parameter><description><para>Move assignment operator. </para></description></copy-assignment> 5945</class><class name="basic_settings_section"><template> 5946 <template-type-parameter name="CharT"/> 5947 </template><purpose>The class represents a reference to the settings container section. </purpose><description><para>The section refers to a sub-tree of the library settings container. It does not own the referred sub-tree but allows for convenient access to parameters within the subsection. </para></description><typedef name="char_type"><purpose>Character type. </purpose><type>CharT</type></typedef> 5948<typedef name="string_type"><purpose>String type. </purpose><type>std::basic_string< char_type ></type></typedef> 5949<typedef name="property_tree_type"><purpose>Property tree type. </purpose><type>property_tree::basic_ptree< std::string, string_type ></type></typedef> 5950<typedef name="path_type"><purpose>Property tree path type. </purpose><type>property_tree_type::path_type</type></typedef> 5951<typedef name="const_reference"><description><para>Constant reference to the parameter value </para></description><type>implementation_defined</type></typedef> 5952<typedef name="reference"><description><para>Mutable reference to the parameter value </para></description><type>implementation_defined</type></typedef> 5953<typedef name="const_iterator"><description><para>Constant iterator over nested parameters and subsections </para></description><type>implementation_defined</type></typedef> 5954<typedef name="iterator"><description><para>Mutable iterator over nested parameters and subsections </para></description><type>implementation_defined</type></typedef> 5955<method-group name="public member functions"> 5956<method name="conversion-operator" cv="const noexcept" specifiers="explicit"><type>bool</type><description><para>Checks if the section refers to the container. </para></description></method> 5957<method name="operator!" cv="const noexcept"><type>bool</type><description><para>Checks if the section refers to the container. </para></description></method> 5958<method name="begin"><type>iterator</type><description><para>Returns an iterator over the nested subsections and parameters. </para></description></method> 5959<method name="end"><type>iterator</type><description><para>Returns an iterator over the nested subsections and parameters. </para></description></method> 5960<method name="begin" cv="const"><type>const_iterator</type><description><para>Returns an iterator over the nested subsections and parameters. </para></description></method> 5961<method name="end" cv="const"><type>const_iterator</type><description><para>Returns an iterator over the nested subsections and parameters. </para></description></method> 5962<method name="rbegin"><type>reverse_iterator</type><description><para>Returns a reverse iterator over the nested subsections and parameters. </para></description></method> 5963<method name="rend"><type>reverse_iterator</type><description><para>Returns a reverse iterator over the nested subsections and parameters. </para></description></method> 5964<method name="rbegin" cv="const"><type>const_reverse_iterator</type><description><para>Returns a reverse iterator over the nested subsections and parameters. </para></description></method> 5965<method name="rend" cv="const"><type>const_reverse_iterator</type><description><para>Returns a reverse iterator over the nested subsections and parameters. </para></description></method> 5966<method name="empty" cv="const"><type>bool</type><description><para>Checks if the container is empty (i.e. contains no sections and parameters). </para></description></method> 5967<method name="operator[]"><type>reference</type><parameter name="section_name"><paramtype>std::string const &</paramtype><description><para>The name of the section in which the parameter resides </para></description></parameter><description><para>Accessor to a single parameter. This operator should be used in conjunction with the subsequent subscript operator that designates the parameter name.</para><para> 5968 5969</para></description><returns><para>An unspecified reference type that can be used for parameter name specifying </para> 5970</returns></method> 5971<method name="operator[]" cv="const"><type>const_reference</type><parameter name="section_name"><paramtype>std::string const &</paramtype><description><para>The name of the section in which the parameter resides </para></description></parameter><description><para>Accessor to a single parameter. This operator should be used in conjunction with the subsequent subscript operator that designates the parameter name.</para><para> 5972 5973</para></description><returns><para>An unspecified reference type that can be used for parameter name specifying </para> 5974</returns></method> 5975<method name="operator[]"><type>reference</type><parameter name="section_name"><paramtype>const char *</paramtype><description><para>The name of the section in which the parameter resides </para></description></parameter><description><para>Accessor to a single parameter. This operator should be used in conjunction with the subsequent subscript operator that designates the parameter name.</para><para> 5976 5977</para></description><returns><para>An unspecified reference type that can be used for parameter name specifying </para> 5978</returns></method> 5979<method name="operator[]" cv="const"><type>const_reference</type><parameter name="section_name"><paramtype>const char *</paramtype><description><para>The name of the section in which the parameter resides </para></description></parameter><description><para>Accessor to a single parameter. This operator should be used in conjunction with the subsequent subscript operator that designates the parameter name.</para><para> 5980 5981</para></description><returns><para>An unspecified reference type that can be used for parameter name specifying </para> 5982</returns></method> 5983<method name="property_tree" cv="const"><type>property_tree_type const &</type><description><para>Accessor for the embedded property tree </para></description></method> 5984<method name="property_tree"><type>property_tree_type &</type><description><para>Accessor for the embedded property tree </para></description></method> 5985<method name="has_section" cv="const"><type>bool</type><parameter name="section_name"><paramtype>string_type const &</paramtype><description><para>The name of the section </para></description></parameter><description><para>Checks if the specified section is present in the container.</para><para> 5986</para></description></method> 5987<method name="has_parameter" cv="const"><type>bool</type><parameter name="section_name"><paramtype>string_type const &</paramtype><description><para>The name of the section in which the parameter resides </para></description></parameter><parameter name="param_name"><paramtype>string_type const &</paramtype><description><para>The name of the parameter </para></description></parameter><description><para>Checks if the specified parameter is present in the container.</para><para> 5988</para></description></method> 5989<method name="swap" cv="noexcept"><type>void</type><parameter name="that"><paramtype><classname>basic_settings_section</classname> &</paramtype></parameter><description><para>Swaps two references to settings sections. </para></description></method> 5990</method-group> 5991<constructor cv="noexcept"><description><para>Default constructor. Creates an empty settings container. </para></description></constructor> 5992<constructor cv="noexcept"><parameter name="that"><paramtype><classname>basic_settings_section</classname> const &</paramtype></parameter><description><para>Copy constructor. </para></description></constructor> 5993<method-group name="protected member functions"> 5994</method-group> 5995<constructor specifiers="explicit" cv="noexcept"><parameter name="tree"><paramtype>property_tree_type *</paramtype></parameter></constructor> 5996</class><typedef name="settings"><purpose>Convenience typedef for narrow-character logging. </purpose><type><classname>basic_settings</classname>< char ></type></typedef> 5997<typedef name="settings_section"><purpose>Convenience typedef for narrow-character logging. </purpose><type><classname>basic_settings_section</classname>< char ></type></typedef> 5998<typedef name="wsettings"><purpose>Convenience typedef for wide-character logging. </purpose><type><classname>basic_settings</classname>< wchar_t ></type></typedef> 5999<typedef name="wsettings_section"><purpose>Convenience typedef for wide-character logging. </purpose><type><classname>basic_settings_section</classname>< wchar_t ></type></typedef> 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038<function name="swap"><type>void</type><template> 6039 <template-type-parameter name="CharT"/> 6040 </template><parameter name="left"><paramtype><classname>basic_settings_section</classname>< CharT > &</paramtype></parameter><parameter name="right"><paramtype><classname>basic_settings_section</classname>< CharT > &</paramtype></parameter></function> 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115</namespace> 6116</namespace> 6117</header> 6118<header name="boost/log/utility/setup/settings_parser.hpp"> 6119<para><para>Andrey Semashev </para> 6120 6121<para>20.07.2012</para> 6122 6123The header contains definition of a settings parser function. </para><namespace name="boost"> 6124<namespace name="log"> 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162<function name="parse_settings"><type><classname>basic_settings</classname>< CharT ></type><template> 6163 <template-type-parameter name="CharT"/> 6164 </template><parameter name="strm"><paramtype>std::basic_istream< CharT > &</paramtype><description><para>Stream, that provides library settings</para></description></parameter><description><para>The function parses library settings from an input stream</para><para> 6165<emphasis role="bold">Throws:</emphasis> An <computeroutput>std::exception</computeroutput>-based exception if the read data cannot be interpreted as the library settings </para></description></function> 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241</namespace> 6242</namespace> 6243</header> 6244<header name="boost/log/utility/strictest_lock.hpp"> 6245<para><para>Andrey Semashev </para> 6246 6247<para>30.05.2010</para> 6248 6249The header contains definition of the <computeroutput>strictest_lock</computeroutput> metafunction that allows to select a lock with the strictest access requirements. </para><namespace name="boost"> 6250<namespace name="log"> 6251<struct name="strictest_lock"><template> 6252 <template-nontype-parameter name="LocksT"><type>typename...</type></template-nontype-parameter> 6253 </template><purpose>The metafunction selects the most strict lock type of the specified. </purpose><description><para>The template supports all lock types provided by the Boost.Thread library (except for <computeroutput>upgrade_to_unique_lock</computeroutput>), plus additional pseudo-lock <computeroutput>no_lock</computeroutput> that indicates no locking at all. Exclusive locks are considered the strictest, shared locks are weaker, and <computeroutput>no_lock</computeroutput> is the weakest. </para></description><typedef name="type"><type>implementation_defined</type></typedef> 6254</struct><struct name="thread_access_mode_of"><template> 6255 <template-type-parameter name="LockT"/> 6256 </template><purpose>The trait allows to select an access mode by the lock type. </purpose></struct><struct-specialization name="thread_access_mode_of"><template> 6257 <template-type-parameter name="MutexT"/> 6258 </template><specialization><template-arg>boost::log::aux::exclusive_lock_guard< MutexT ></template-arg></specialization><inherit access="public">mpl::integral_c< lock_access_mode, exclusive_access ></inherit></struct-specialization><struct-specialization name="thread_access_mode_of"><template> 6259 <template-type-parameter name="MutexT1"/> 6260 <template-type-parameter name="MutexT2"/> 6261 </template><specialization><template-arg>boost::log::aux::multiple_unique_lock2< MutexT1</template-arg><template-arg>MutexT2 ></template-arg></specialization><inherit access="public">mpl::integral_c< lock_access_mode, exclusive_access ></inherit></struct-specialization><struct-specialization name="thread_access_mode_of"><template> 6262 <template-type-parameter name="MutexT"/> 6263 </template><specialization><template-arg>boost::log::aux::shared_lock_guard< MutexT ></template-arg></specialization><inherit access="public">mpl::integral_c< lock_access_mode, shared_access ></inherit></struct-specialization><struct-specialization name="thread_access_mode_of"><template> 6264 <template-type-parameter name="MutexT"/> 6265 </template><specialization><template-arg>lock_guard< MutexT ></template-arg></specialization><inherit access="public">mpl::integral_c< lock_access_mode, exclusive_access ></inherit></struct-specialization><struct-specialization name="thread_access_mode_of"><template> 6266 <template-type-parameter name="MutexT"/> 6267 </template><specialization><template-arg>no_lock< MutexT ></template-arg></specialization><inherit access="public">mpl::integral_c< lock_access_mode, unlocked_access ></inherit></struct-specialization><struct-specialization name="thread_access_mode_of"><template> 6268 <template-type-parameter name="MutexT"/> 6269 </template><specialization><template-arg>shared_lock< MutexT ></template-arg></specialization><inherit access="public">mpl::integral_c< lock_access_mode, shared_access ></inherit></struct-specialization><struct-specialization name="thread_access_mode_of"><template> 6270 <template-type-parameter name="MutexT"/> 6271 </template><specialization><template-arg>shared_lock_guard< MutexT ></template-arg></specialization><inherit access="public">mpl::integral_c< lock_access_mode, shared_access ></inherit></struct-specialization><struct-specialization name="thread_access_mode_of"><template> 6272 <template-type-parameter name="MutexT"/> 6273 </template><specialization><template-arg>unique_lock< MutexT ></template-arg></specialization><inherit access="public">mpl::integral_c< lock_access_mode, exclusive_access ></inherit></struct-specialization><struct-specialization name="thread_access_mode_of"><template> 6274 <template-type-parameter name="MutexT"/> 6275 </template><specialization><template-arg>upgrade_lock< MutexT ></template-arg></specialization><inherit access="public">mpl::integral_c< lock_access_mode, shared_access ></inherit></struct-specialization><enum name="lock_access_mode"><enumvalue name="unlocked_access"><purpose>A thread that owns this kind of lock doesn't restrict other threads in any way. </purpose></enumvalue><enumvalue name="shared_access"><purpose>A thread that owns this kind of lock requires that no other thread modify the locked data. </purpose></enumvalue><enumvalue name="exclusive_access"><purpose>A thread that owns this kind of lock requires that no other thread has access to the locked data. </purpose></enumvalue><purpose>Access modes for different types of locks. </purpose></enum> 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389</namespace> 6390</namespace> 6391</header> 6392<header name="boost/log/utility/string_literal.hpp"> 6393<para><para>Andrey Semashev </para> 6394 6395<para>24.06.2007</para> 6396 6397The header contains implementation of a constant string literal wrapper. </para><namespace name="boost"> 6398<namespace name="log"> 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420<function name="operator<<"><type>std::basic_ostream< CharT, StrmTraitsT > &</type><template> 6421 <template-type-parameter name="CharT"/> 6422 <template-type-parameter name="StrmTraitsT"/> 6423 <template-type-parameter name="LitTraitsT"/> 6424 </template><parameter name="strm"><paramtype>std::basic_ostream< CharT, StrmTraitsT > &</paramtype></parameter><parameter name="lit"><paramtype><classname>basic_string_literal</classname>< CharT, LitTraitsT > const &</paramtype></parameter><purpose>Output operator. </purpose></function> 6425<function name="swap"><type>constexpr void</type><template> 6426 <template-type-parameter name="CharT"/> 6427 <template-type-parameter name="TraitsT"/> 6428 </template><parameter name="left"><paramtype><classname>basic_string_literal</classname>< CharT, TraitsT > &</paramtype></parameter><parameter name="right"><paramtype><classname>basic_string_literal</classname>< CharT, TraitsT > &</paramtype></parameter><purpose>External swap. </purpose></function> 6429<function name="str_literal"><type>constexpr <classname>basic_string_literal</classname>< T ></type><template> 6430 <template-type-parameter name="T"/> 6431 <template-nontype-parameter name="LenV"><type>std::size_t</type></template-nontype-parameter> 6432 </template><parameter name="p"><paramtype>T(&)</paramtype></parameter><purpose>Creates a string literal wrapper from a constant string literal. </purpose></function> 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522</namespace> 6523</namespace> 6524</header> 6525<header name="boost/log/utility/string_literal_fwd.hpp"> 6526<para><para>Andrey Semashev </para> 6527 6528<para>24.06.2007</para> 6529 6530The header contains forward declaration of a constant string literal wrapper. </para><namespace name="boost"> 6531<namespace name="log"> 6532<class name="basic_string_literal"><template> 6533 <template-type-parameter name="CharT"/> 6534 <template-type-parameter name="TraitsT"/> 6535 </template><purpose>String literal wrapper. </purpose><description><para>The <computeroutput><classname alt="boost::log::basic_string_literal">basic_string_literal</classname></computeroutput> is a thin wrapper around a constant string literal. It provides interface similar to STL strings, but because of read-only nature of string literals, lacks ability to modify string contents. However, <computeroutput><classname alt="boost::log::basic_string_literal">basic_string_literal</classname></computeroutput> objects can be assigned to and cleared.</para><para>The main advantage of this class comparing to other string classes is that it doesn't dynamically allocate memory and therefore is fast, thin and exception safe. </para></description><method-group name="public member functions"> 6536<method name="operator==" cv="const noexcept"><type>bool</type><parameter name="that"><paramtype><classname>this_type</classname> const &</paramtype><description><para>Comparand </para></description></parameter><description><para>Lexicographical comparison (equality)</para><para> 6537 6538</para></description><returns><para><computeroutput>true</computeroutput> if the comparand string equals to this string, <computeroutput>false</computeroutput> otherwise </para> 6539</returns></method> 6540<method name="operator==" cv="const noexcept"><type>bool</type><parameter name="str"><paramtype>const_pointer</paramtype><description><para>Comparand. Must point to a zero-terminated sequence of characters, must not be NULL. </para></description></parameter><description><para>Lexicographical comparison (equality)</para><para> 6541 6542</para></description><returns><para><computeroutput>true</computeroutput> if the comparand string equals to this string, <computeroutput>false</computeroutput> otherwise </para> 6543</returns></method> 6544<method name="operator==" cv="const noexcept"><type>bool</type><parameter name="that"><paramtype>string_type const &</paramtype><description><para>Comparand </para></description></parameter><description><para>Lexicographical comparison (equality)</para><para> 6545 6546</para></description><returns><para><computeroutput>true</computeroutput> if the comparand string equals to this string, <computeroutput>false</computeroutput> otherwise </para> 6547</returns></method> 6548<method name="operator!=" cv="const noexcept"><type>bool</type><parameter name="that"><paramtype><classname>this_type</classname> const &</paramtype><description><para>Comparand </para></description></parameter><description><para>Lexicographical comparison (inequality)</para><para> 6549 6550</para></description><returns><para><computeroutput>true</computeroutput> if the comparand string is not equal to this string, <computeroutput>false</computeroutput> otherwise </para> 6551</returns></method> 6552<method name="operator!=" cv="const noexcept"><type>bool</type><parameter name="str"><paramtype>const_pointer</paramtype><description><para>Comparand. Must point to a zero-terminated sequence of characters, must not be NULL. </para></description></parameter><description><para>Lexicographical comparison (inequality)</para><para> 6553 6554</para></description><returns><para><computeroutput>true</computeroutput> if the comparand string is not equal to this string, <computeroutput>false</computeroutput> otherwise </para> 6555</returns></method> 6556<method name="operator!=" cv="const noexcept"><type>bool</type><parameter name="that"><paramtype>string_type const &</paramtype><description><para>Comparand </para></description></parameter><description><para>Lexicographical comparison (inequality)</para><para> 6557 6558</para></description><returns><para><computeroutput>true</computeroutput> if the comparand string is not equal to this string, <computeroutput>false</computeroutput> otherwise </para> 6559</returns></method> 6560<method name="operator<" cv="const noexcept"><type>bool</type><parameter name="that"><paramtype><classname>this_type</classname> const &</paramtype><description><para>Comparand </para></description></parameter><description><para>Lexicographical comparison (less ordering)</para><para> 6561 6562</para></description><returns><para><computeroutput>true</computeroutput> if this string is less than the comparand, <computeroutput>false</computeroutput> otherwise </para> 6563</returns></method> 6564<method name="operator<" cv="const noexcept"><type>bool</type><parameter name="str"><paramtype>const_pointer</paramtype><description><para>Comparand. Must point to a zero-terminated sequence of characters, must not be NULL. </para></description></parameter><description><para>Lexicographical comparison (less ordering)</para><para> 6565 6566</para></description><returns><para><computeroutput>true</computeroutput> if this string is less than the comparand, <computeroutput>false</computeroutput> otherwise </para> 6567</returns></method> 6568<method name="operator<" cv="const noexcept"><type>bool</type><parameter name="that"><paramtype>string_type const &</paramtype><description><para>Comparand </para></description></parameter><description><para>Lexicographical comparison (less ordering)</para><para> 6569 6570</para></description><returns><para><computeroutput>true</computeroutput> if this string is less than the comparand, <computeroutput>false</computeroutput> otherwise </para> 6571</returns></method> 6572<method name="operator<=" cv="const noexcept"><type>bool</type><parameter name="that"><paramtype><classname>this_type</classname> const &</paramtype><description><para>Comparand </para></description></parameter><description><para>Lexicographical comparison (less or equal ordering)</para><para> 6573 6574</para></description><returns><para><computeroutput>true</computeroutput> if this string is less or equal to the comparand, <computeroutput>false</computeroutput> otherwise </para> 6575</returns></method> 6576<method name="operator<=" cv="const noexcept"><type>bool</type><parameter name="str"><paramtype>const_pointer</paramtype><description><para>Comparand. Must point to a zero-terminated sequence of characters, must not be NULL. </para></description></parameter><description><para>Lexicographical comparison (less or equal ordering)</para><para> 6577 6578</para></description><returns><para><computeroutput>true</computeroutput> if this string is less or equal to the comparand, <computeroutput>false</computeroutput> otherwise </para> 6579</returns></method> 6580<method name="operator<=" cv="const noexcept"><type>bool</type><parameter name="that"><paramtype>string_type const &</paramtype><description><para>Comparand </para></description></parameter><description><para>Lexicographical comparison (less or equal ordering)</para><para> 6581 6582</para></description><returns><para><computeroutput>true</computeroutput> if this string is less or equal to the comparand, <computeroutput>false</computeroutput> otherwise </para> 6583</returns></method> 6584<method name="operator>" cv="const noexcept"><type>bool</type><parameter name="that"><paramtype><classname>this_type</classname> const &</paramtype><description><para>Comparand </para></description></parameter><description><para>Lexicographical comparison (greater ordering)</para><para> 6585 6586</para></description><returns><para><computeroutput>true</computeroutput> if this string is greater than the comparand, <computeroutput>false</computeroutput> otherwise </para> 6587</returns></method> 6588<method name="operator>" cv="const noexcept"><type>bool</type><parameter name="str"><paramtype>const_pointer</paramtype><description><para>Comparand. Must point to a zero-terminated sequence of characters, must not be NULL. </para></description></parameter><description><para>Lexicographical comparison (greater ordering)</para><para> 6589 6590</para></description><returns><para><computeroutput>true</computeroutput> if this string is greater than the comparand, <computeroutput>false</computeroutput> otherwise </para> 6591</returns></method> 6592<method name="operator>" cv="const noexcept"><type>bool</type><parameter name="that"><paramtype>string_type const &</paramtype><description><para>Comparand </para></description></parameter><description><para>Lexicographical comparison (greater ordering)</para><para> 6593 6594</para></description><returns><para><computeroutput>true</computeroutput> if this string is greater than the comparand, <computeroutput>false</computeroutput> otherwise </para> 6595</returns></method> 6596<method name="operator>=" cv="const noexcept"><type>bool</type><parameter name="that"><paramtype><classname>this_type</classname> const &</paramtype><description><para>Comparand </para></description></parameter><description><para>Lexicographical comparison (greater or equal ordering)</para><para> 6597 6598</para></description><returns><para><computeroutput>true</computeroutput> if this string is greater or equal to the comparand, <computeroutput>false</computeroutput> otherwise </para> 6599</returns></method> 6600<method name="operator>=" cv="const noexcept"><type>bool</type><parameter name="str"><paramtype>const_pointer</paramtype><description><para>Comparand. Must point to a zero-terminated sequence of characters, must not be NULL. </para></description></parameter><description><para>Lexicographical comparison (greater or qual ordering)</para><para> 6601 6602</para></description><returns><para><computeroutput>true</computeroutput> if this string is greater or equal to the comparand, <computeroutput>false</computeroutput> otherwise </para> 6603</returns></method> 6604<method name="operator>=" cv="const noexcept"><type>bool</type><parameter name="that"><paramtype>string_type const &</paramtype><description><para>Comparand </para></description></parameter><description><para>Lexicographical comparison (greater or equal ordering)</para><para> 6605 6606</para></description><returns><para><computeroutput>true</computeroutput> if this string is greater or equal to the comparand, <computeroutput>false</computeroutput> otherwise </para> 6607</returns></method> 6608<method name="operator[]" cv="const noexcept"><type>constexpr const_reference</type><parameter name="i"><paramtype>size_type</paramtype><description><para>Requested character index </para></description></parameter><description><para>Subscript operator</para><para> 6609 6610 6611</para></description><requires><para><computeroutput>i < size()</computeroutput> </para> 6612</requires><returns><para>Constant reference to the requested character </para> 6613</returns></method> 6614<method name="at" cv="const"><type>const_reference</type><parameter name="i"><paramtype>size_type</paramtype><description><para>Requested character index </para></description></parameter><description><para>Checked subscript</para><para> 6615 6616<emphasis role="bold">Throws:</emphasis> An <computeroutput>std::exception</computeroutput>-based exception if index <emphasis>i</emphasis> is out of string boundaries </para></description><returns><para>Constant reference to the requested character</para> 6617</returns></method> 6618<method name="c_str" cv="const noexcept"><type>constexpr const_pointer</type><description><para> 6619</para></description><returns><para>Pointer to the beginning of the literal </para> 6620</returns></method> 6621<method name="data" cv="const noexcept"><type>constexpr const_pointer</type><description><para> 6622</para></description><returns><para>Pointer to the beginning of the literal </para> 6623</returns></method> 6624<method name="size" cv="const noexcept"><type>constexpr size_type</type><description><para> 6625</para></description><returns><para>Length of the literal </para> 6626</returns></method> 6627<method name="length" cv="const noexcept"><type>constexpr size_type</type><description><para> 6628</para></description><returns><para>Length of the literal </para> 6629</returns></method> 6630<method name="empty" cv="const noexcept"><type>constexpr bool</type><description><para> 6631</para></description><returns><para><computeroutput>true</computeroutput> if the literal is an empty string, <computeroutput>false</computeroutput> otherwise </para> 6632</returns></method> 6633<method name="begin" cv="const noexcept"><type>constexpr const_iterator</type><description><para> 6634</para></description><returns><para>Iterator that points to the first character of the literal </para> 6635</returns></method> 6636<method name="end" cv="const noexcept"><type>constexpr const_iterator</type><description><para> 6637</para></description><returns><para>Iterator that points after the last character of the literal </para> 6638</returns></method> 6639<method name="rbegin" cv="const noexcept"><type>const_reverse_iterator</type><description><para> 6640</para></description><returns><para>Reverse iterator that points to the last character of the literal </para> 6641</returns></method> 6642<method name="rend" cv="const noexcept"><type>const_reverse_iterator</type><description><para> 6643</para></description><returns><para>Reverse iterator that points before the first character of the literal </para> 6644</returns></method> 6645<method name="str" cv="const"><type>string_type</type><description><para> 6646</para></description><returns><para>STL string constructed from the literal </para> 6647</returns></method> 6648<method name="clear" cv="noexcept"><type>constexpr void</type><description><para>The method clears the literal</para><para> 6649</para></description><postconditions><para><computeroutput>empty() == true</computeroutput> </para> 6650</postconditions></method> 6651<method name="swap" cv="noexcept"><type>constexpr void</type><parameter name="that"><paramtype><classname>this_type</classname> &</paramtype></parameter><description><para>The method swaps two literals </para></description></method> 6652<method name="assign" cv="noexcept"><type>constexpr <classname>this_type</classname> &</type><parameter name="that"><paramtype><classname>this_type</classname> const &</paramtype><description><para>Source literal to copy string from </para></description></parameter><description><para>Assignment from another literal</para><para> 6653 6654</para></description><postconditions><para><computeroutput>*this == that</computeroutput> </para> 6655</postconditions></method> 6656<method name="assign" cv="noexcept"><type>constexpr <classname>this_type</classname> &</type><template> 6657 <template-type-parameter name="T"/> 6658 <template-nontype-parameter name="LenV"><type>size_type</type></template-nontype-parameter> 6659 </template><parameter name="p"><paramtype>T(&)</paramtype><description><para>A zero-terminated constant sequence of characters </para></description></parameter><description><para>Assignment from another literal</para><para> 6660 6661</para></description><postconditions><para><computeroutput>*this == p</computeroutput> </para> 6662</postconditions></method> 6663<method name="copy" cv="const"><type>size_type</type><parameter name="str"><paramtype>value_type *</paramtype><description><para>Pointer to the external buffer beginning. Must not be NULL. The buffer must have enough capacity to accommodate the requested number of characters. </para></description></parameter><parameter name="n"><paramtype>size_type</paramtype><description><para>Maximum number of characters to copy </para></description></parameter><parameter name="pos"><paramtype>size_type</paramtype><default>0</default><description><para>Starting position to start copying from </para></description></parameter><description><para>The method copies the literal or its portion to an external buffer</para><para> 6664 6665 6666<emphasis role="bold">Throws:</emphasis> An <computeroutput>std::exception</computeroutput>-based exception if <emphasis>pos</emphasis> is out of range. </para></description><requires><para><computeroutput>pos <= size()</computeroutput> </para> 6667</requires><returns><para>Number of characters copied</para> 6668</returns></method> 6669<method name="compare" cv="const"><type>int</type><parameter name="pos"><paramtype>size_type</paramtype><description><para>Starting position within this string to perform comparison to </para></description></parameter><parameter name="n"><paramtype>size_type</paramtype><description><para>Length of the substring of this string to perform comparison to </para></description></parameter><parameter name="str"><paramtype>const_pointer</paramtype><description><para>Comparand. Must point to a sequence of characters, must not be NULL. </para></description></parameter><parameter name="len"><paramtype>size_type</paramtype><description><para>Number of characters in the sequence <emphasis>str</emphasis>. </para></description></parameter><description><para>Lexicographically compares the argument string to a part of this string</para><para> 6670 6671 6672<emphasis role="bold">Throws:</emphasis> An <computeroutput>std::exception</computeroutput>-based exception if <emphasis>pos</emphasis> is out of range. </para></description><requires><para><computeroutput>pos <= size()</computeroutput> </para> 6673</requires><returns><para>Zero if the comparand equals this string, a negative value if this string is less than the comparand, a positive value if this string is greater than the comparand.</para> 6674</returns></method> 6675<method name="compare" cv="const noexcept"><type>int</type><parameter name="pos"><paramtype>size_type</paramtype><description><para>Starting position within this string to perform comparison to </para></description></parameter><parameter name="n"><paramtype>size_type</paramtype><description><para>Length of the substring of this string to perform comparison to </para></description></parameter><parameter name="str"><paramtype>const_pointer</paramtype><description><para>Comparand. Must point to a zero-terminated sequence of characters, must not be NULL. </para></description></parameter><description><para>Lexicographically compares the argument string to a part of this string</para><para> 6676 6677 6678<emphasis role="bold">Throws:</emphasis> An <computeroutput>std::exception</computeroutput>-based exception if <emphasis>pos</emphasis> is out of range. </para></description><requires><para><computeroutput>pos <= size()</computeroutput> </para> 6679</requires><returns><para>Zero if the comparand equals this string, a negative value if this string is less than the comparand, a positive value if this string is greater than the comparand.</para> 6680</returns></method> 6681<method name="compare" cv="const noexcept"><type>int</type><parameter name="pos"><paramtype>size_type</paramtype><description><para>Starting position within this string to perform comparison to </para></description></parameter><parameter name="n"><paramtype>size_type</paramtype><description><para>Length of the substring of this string to perform comparison to </para></description></parameter><parameter name="that"><paramtype><classname>this_type</classname> const &</paramtype><description><para>Comparand </para></description></parameter><description><para>Lexicographically compares the argument string literal to a part of this string</para><para> 6682 6683 6684<emphasis role="bold">Throws:</emphasis> An <computeroutput>std::exception</computeroutput>-based exception if <emphasis>pos</emphasis> is out of range. </para></description><requires><para><computeroutput>pos <= size()</computeroutput> </para> 6685</requires><returns><para>Zero if the comparand equals this string, a negative value if this string is less than the comparand, a positive value if this string is greater than the comparand.</para> 6686</returns></method> 6687<method name="compare" cv="const noexcept"><type>int</type><parameter name="str"><paramtype>const_pointer</paramtype><description><para>Comparand. Must point to a sequence of characters, must not be NULL. </para></description></parameter><parameter name="len"><paramtype>size_type</paramtype><description><para>Number of characters in the sequence <emphasis>str</emphasis>. </para></description></parameter><description><para>Lexicographically compares the argument string to this string</para><para> 6688 6689</para></description><returns><para>Zero if the comparand equals this string, a negative value if this string is less than the comparand, a positive value if this string is greater than the comparand. </para> 6690</returns></method> 6691<method name="compare" cv="const noexcept"><type>int</type><parameter name="str"><paramtype>const_pointer</paramtype><description><para>Comparand. Must point to a zero-terminated sequence of characters, must not be NULL. </para></description></parameter><description><para>Lexicographically compares the argument string to this string</para><para> 6692 6693</para></description><returns><para>Zero if the comparand equals this string, a negative value if this string is less than the comparand, a positive value if this string is greater than the comparand. </para> 6694</returns></method> 6695<method name="compare" cv="const noexcept"><type>int</type><parameter name="that"><paramtype><classname>this_type</classname> const &</paramtype><description><para>Comparand </para></description></parameter><description><para>Lexicographically compares the argument string to this string</para><para> 6696 6697</para></description><returns><para>Zero if the comparand equals this string, a negative value if this string is less than the comparand, a positive value if this string is greater than the comparand. </para> 6698</returns></method> 6699</method-group> 6700<constructor cv="noexcept"><description><para>Constructor</para><para> 6701</para></description><postconditions><para><computeroutput>empty() == true</computeroutput> </para> 6702</postconditions></constructor> 6703<constructor cv="noexcept"><template> 6704 <template-type-parameter name="T"/> 6705 <template-nontype-parameter name="LenV"><type>size_type</type></template-nontype-parameter> 6706 </template><parameter name="p"><paramtype>T(&)</paramtype><description><para>A zero-terminated constant sequence of characters </para></description></parameter><description><para>Constructor from a string literal</para><para> 6707 6708</para></description><postconditions><para><computeroutput>*this == p</computeroutput> </para> 6709</postconditions></constructor> 6710<constructor cv="noexcept"><parameter name="that"><paramtype><classname>basic_string_literal</classname> const &</paramtype><description><para>Source literal to copy string from </para></description></parameter><description><para>Copy constructor</para><para> 6711 6712</para></description><postconditions><para><computeroutput>*this == that</computeroutput> </para> 6713</postconditions></constructor> 6714<copy-assignment cv="noexcept"><type>constexpr <classname>this_type</classname> &</type><parameter name="that"><paramtype><classname>this_type</classname> const &</paramtype><description><para>Source literal to copy string from </para></description></parameter><description><para>Assignment operator</para><para> 6715 6716</para></description><postconditions><para><computeroutput>*this == that</computeroutput> </para> 6717</postconditions></copy-assignment> 6718<copy-assignment cv="noexcept"><type>constexpr <classname>this_type</classname> &</type><template> 6719 <template-type-parameter name="T"/> 6720 <template-nontype-parameter name="LenV"><type>size_type</type></template-nontype-parameter> 6721 </template><parameter name="p"><paramtype>T(&)</paramtype><description><para>A zero-terminated constant sequence of characters </para></description></parameter><description><para>Assignment from a string literal</para><para> 6722 6723</para></description><postconditions><para><computeroutput>*this == p</computeroutput> </para> 6724</postconditions></copy-assignment> 6725</class><typedef name="string_literal"><purpose>String literal type for narrow characters. </purpose><type><classname>basic_string_literal</classname>< char ></type></typedef> 6726<typedef name="wstring_literal"><purpose>String literal type for wide characters. </purpose><type><classname>basic_string_literal</classname>< wchar_t ></type></typedef> 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840</namespace> 6841</namespace> 6842</header> 6843<header name="boost/log/utility/type_dispatch/date_time_types.hpp"> 6844<para><para>Andrey Semashev </para> 6845 6846<para>13.03.2008</para> 6847 6848The header contains definition of date and time-related types supported by the library by default. </para><namespace name="boost"> 6849<namespace name="log"> 6850<typedef name="native_date_time_types"><description><para>An MPL-sequence of natively supported date and time types of attributes </para></description><type>mpl::vector<></type></typedef> 6851<typedef name="boost_date_time_types"><description><para>An MPL-sequence of Boost date and time types of attributes </para></description><type>mpl::vector<></type></typedef> 6852<typedef name="date_time_types"><description><para>An MPL-sequence with the complete list of the supported date and time types </para></description><type>mpl::vector<></type></typedef> 6853<typedef name="native_date_types"><description><para>An MPL-sequence of natively supported date types of attributes </para></description><type>native_date_time_types</type></typedef> 6854<typedef name="boost_date_types"><description><para>An MPL-sequence of Boost date types of attributes </para></description><type>mpl::vector<></type></typedef> 6855<typedef name="date_types"><description><para>An MPL-sequence with the complete list of the supported date types </para></description><type>mpl::vector<></type></typedef> 6856<typedef name="native_time_types"><description><para>An MPL-sequence of natively supported time types </para></description><type>native_date_time_types</type></typedef> 6857<typedef name="boost_time_types"><purpose>An MPL-sequence of Boost time types. </purpose><type>boost_date_time_types</type></typedef> 6858<typedef name="time_types"><description><para>An MPL-sequence with the complete list of the supported time types </para></description><type>date_time_types</type></typedef> 6859<typedef name="native_time_duration_types"><description><para>An MPL-sequence of natively supported time duration types of attributes </para></description><type>mpl::vector<></type></typedef> 6860<typedef name="boost_time_duration_types"><description><para>An MPL-sequence of Boost time duration types of attributes </para></description><type>mpl::vector<></type></typedef> 6861<typedef name="time_duration_types"><description><para>An MPL-sequence with the complete list of the supported time duration types </para></description><type>mpl::vector<></type></typedef> 6862<typedef name="boost_time_period_types"><description><para>An MPL-sequence of Boost time duration types of attributes </para></description><type>mpl::vector<></type></typedef> 6863<typedef name="time_period_types"><description><para>An MPL-sequence with the complete list of the supported time period types </para></description><type>boost_time_period_types</type></typedef> 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977</namespace> 6978</namespace> 6979<macro name="BOOST_LOG_NATIVE_DATE_TIME_TYPES" kind="functionlike"><macro-parameter name=""/><purpose>Boost.Preprocessor sequence of the standard C date/time types. </purpose></macro> 6980<macro name="BOOST_LOG_NATIVE_DATE_TYPES" kind="functionlike"><macro-parameter name=""/><purpose>Boost.Preprocessor sequence of the standard C date types. </purpose></macro> 6981<macro name="BOOST_LOG_BOOST_DATE_TIME_TYPES" kind="functionlike"><macro-parameter name=""/><purpose>Boost.Preprocessor sequence of the Boost date/time types. </purpose></macro> 6982<macro name="BOOST_LOG_DATE_TIME_TYPES" kind="functionlike"><macro-parameter name=""/><purpose>Boost.Preprocessor sequence of date/time types. </purpose></macro> 6983<macro name="BOOST_LOG_BOOST_DATE_TYPES" kind="functionlike"><macro-parameter name=""/><purpose>Boost.Preprocessor sequence of the Boost date types. </purpose></macro> 6984<macro name="BOOST_LOG_DATE_TYPES" kind="functionlike"><macro-parameter name=""/><purpose>Boost.Preprocessor sequence of date types. </purpose></macro> 6985<macro name="BOOST_LOG_NATIVE_TIME_DURATION_TYPES" kind="functionlike"><macro-parameter name=""/><purpose>Boost.Preprocessor sequence of the standard time duration types. </purpose></macro> 6986<macro name="BOOST_LOG_BOOST_TIME_DURATION_TYPES" kind="functionlike"><macro-parameter name=""/><purpose>Boost.Preprocessor sequence of the Boost time duration types. </purpose></macro> 6987<macro name="BOOST_LOG_TIME_DURATION_TYPES" kind="functionlike"><macro-parameter name=""/><purpose>Boost.Preprocessor sequence of time duration types. </purpose></macro> 6988<macro name="BOOST_LOG_BOOST_TIME_PERIOD_TYPES" kind="functionlike"><macro-parameter name=""/><purpose>Boost.Preprocessor sequence of the Boost time period types. </purpose></macro> 6989<macro name="BOOST_LOG_TIME_PERIOD_TYPES" kind="functionlike"><macro-parameter name=""/><purpose>Boost.Preprocessor sequence of time period types. </purpose></macro> 6990</header> 6991<header name="boost/log/utility/type_dispatch/dynamic_type_dispatcher.hpp"> 6992<para><para>Andrey Semashev </para> 6993 6994<para>15.04.2007</para> 6995 6996The header contains implementation of the run-time type dispatcher. </para><namespace name="boost"> 6997<namespace name="log"> 6998<class name="dynamic_type_dispatcher"><inherit access="public">type_dispatcher</inherit><purpose>A dynamic type dispatcher. </purpose><description><para>The type dispatcher can be used to pass objects of arbitrary types from one component to another. With regard to the library, the type dispatcher can be used to extract attribute values.</para><para>The dynamic type dispatcher can be initialized in run time and, therefore, can support different types, depending on runtime conditions. Each supported type is associated with a functional object that will be called when an object of the type is dispatched. </para></description><method-group name="public member functions"> 6999<method name="register_type"><type>void</type><template> 7000 <template-type-parameter name="T"/> 7001 <template-type-parameter name="VisitorT"/> 7002 </template><parameter name="visitor"><paramtype>VisitorT const &</paramtype><description><para>Function object that will be associated with the type <computeroutput>T</computeroutput> </para></description></parameter><description><para>The method registers a new type</para><para> 7003</para></description></method> 7004<method name="registered_types_count" cv="const"><type>dispatching_map::size_type</type><description><para>The method returns the number of registered types </para></description></method> 7005</method-group> 7006<constructor><description><para>Default constructor </para></description></constructor> 7007<constructor><parameter name="that"><paramtype><classname>dynamic_type_dispatcher</classname> const &</paramtype></parameter><description><para>Copy constructor </para></description></constructor> 7008<copy-assignment><type><classname>dynamic_type_dispatcher</classname> &</type><parameter name="that"><paramtype><classname>dynamic_type_dispatcher</classname> const &</paramtype></parameter><description><para>Copy assignment </para></description></copy-assignment> 7009</class> 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122</namespace> 7123</namespace> 7124</header> 7125<header name="boost/log/utility/type_dispatch/standard_types.hpp"> 7126<para><para>Andrey Semashev </para> 7127 7128<para>19.05.2007</para> 7129 7130The header contains definition of standard types supported by the library by default. </para><namespace name="boost"> 7131<namespace name="log"> 7132<typedef name="integral_types"><description><para>An MPL-sequence of integral types of attributes, supported by default </para></description><type>mpl::vector<></type></typedef> 7133<typedef name="floating_point_types"><description><para>An MPL-sequence of FP types of attributes, supported by default </para></description><type>mpl::vector<></type></typedef> 7134<typedef name="arithmetic_types"><description><para>An MPL-sequence of all numeric types of attributes, supported by default </para></description><type>mpl::vector<></type></typedef> 7135<typedef name="numeric_types"><purpose>Deprecated alias. </purpose><type>arithmetic_types</type></typedef> 7136<typedef name="string_types"><description><para>An MPL-sequence of string types of attributes, supported by default </para></description><type>mpl::vector<></type></typedef> 7137<typedef name="default_attribute_types"><purpose>Deprecated alias. </purpose><type>default_attribute_value_types</type></typedef> 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203<function name="BOOST_PP_CAT"><type>typedef</type><parameter name=""><paramtype>mpl::vector</paramtype></parameter><parameter name=""><paramtype>BOOST_PP_SEQ_SIZE((bool)(signed char)(unsigned char)(short)(unsigned short)(int)(unsigned int)(long)(unsigned long)(char)(wchar_t)(char16_t)(char32_t)(float)(double)(long double)(std::string)(boost::log::string_literal)(std::wstring)(boost::log::wstring_literal))</paramtype></parameter><description><para>An MPL-sequence of all attribute value types that are supported by the library by default. </para></description></function> 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251</namespace> 7252</namespace> 7253<macro name="BOOST_LOG_AUX_STANDARD_TYPE_WCHAR_T" kind="functionlike"><macro-parameter name=""/></macro> 7254<macro name="BOOST_LOG_AUX_STANDARD_TYPE_CHAR16_T" kind="functionlike"><macro-parameter name=""/></macro> 7255<macro name="BOOST_LOG_AUX_STANDARD_TYPE_CHAR32_T" kind="functionlike"><macro-parameter name=""/></macro> 7256<macro name="BOOST_LOG_STANDARD_CHAR_TYPES" kind="functionlike"><macro-parameter name=""/><purpose>Boost.Preprocessor sequence of character types. </purpose></macro> 7257<macro name="BOOST_LOG_AUX_STANDARD_LONG_LONG_TYPES" kind="functionlike"><macro-parameter name=""/></macro> 7258<macro name="BOOST_LOG_STANDARD_INTEGRAL_TYPES" kind="functionlike"><macro-parameter name=""/><purpose>Boost.Preprocessor sequence of integral types. </purpose></macro> 7259<macro name="BOOST_LOG_STANDARD_FLOATING_POINT_TYPES" kind="functionlike"><macro-parameter name=""/><purpose>Boost.Preprocessor sequence of floating point types. </purpose></macro> 7260<macro name="BOOST_LOG_STANDARD_ARITHMETIC_TYPES" kind="functionlike"><macro-parameter name=""/><purpose>Boost.Preprocessor sequence of arithmetic types. </purpose></macro> 7261<macro name="BOOST_LOG_AUX_STANDARD_STRING_TYPES" kind="functionlike"><macro-parameter name=""/></macro> 7262<macro name="BOOST_LOG_AUX_STANDARD_WSTRING_TYPES" kind="functionlike"><macro-parameter name=""/></macro> 7263<macro name="BOOST_LOG_STANDARD_STRING_TYPES" kind="functionlike"><macro-parameter name=""/><purpose>Boost.Preprocessor sequence of string types. </purpose></macro> 7264<macro name="BOOST_LOG_DEFAULT_ATTRIBUTE_VALUE_TYPES" kind="functionlike"><macro-parameter name=""/><purpose>Boost.Preprocessor sequence of the default attribute value types supported by the library. </purpose></macro> 7265</header> 7266<header name="boost/log/utility/type_dispatch/static_type_dispatcher.hpp"> 7267<para><para>Andrey Semashev </para> 7268 7269<para>15.04.2007</para> 7270 7271The header contains implementation of a compile-time type dispatcher. </para><namespace name="boost"> 7272<namespace name="log"> 7273<class name="static_type_dispatcher"><template> 7274 <template-type-parameter name="T"/> 7275 </template><purpose>A static type dispatcher class. </purpose><description><para>The type dispatcher can be used to pass objects of arbitrary types from one component to another. With regard to the library, the type dispatcher can be used to extract attribute values.</para><para>Static type dispatchers allow to specify one or several supported types at compile time. </para></description><method-group name="public member functions"> 7276</method-group> 7277<constructor specifiers="explicit"><template> 7278 <template-type-parameter name="ReceiverT"/> 7279 </template><parameter name="receiver"><paramtype>ReceiverT &</paramtype><description><para>Unary function object that will be called on a dispatched value. The receiver must be callable with an argument of any of the supported types of the dispatcher. </para></description></parameter><description><para>Constructor. Initializes the dispatcher internals.</para><para>The <emphasis>receiver</emphasis> object is not copied inside the dispatcher, but references to it may be kept by the dispatcher after construction. The receiver object must remain valid until the dispatcher is destroyed.</para><para> 7280</para></description></constructor> 7281<constructor cv="= delete"><parameter name=""><paramtype><classname>static_type_dispatcher</classname> const &</paramtype></parameter></constructor> 7282<copy-assignment cv="= delete"><type><classname>static_type_dispatcher</classname> &</type><parameter name=""><paramtype><classname>static_type_dispatcher</classname> const &</paramtype></parameter></copy-assignment> 7283</class> 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396</namespace> 7397</namespace> 7398</header> 7399<header name="boost/log/utility/type_dispatch/type_dispatcher.hpp"> 7400<para><para>Andrey Semashev </para> 7401 7402<para>15.04.2007</para> 7403 7404The header contains definition of generic type dispatcher interfaces. </para><namespace name="boost"> 7405<namespace name="log"> 7406<class name="type_dispatcher"><purpose>A type dispatcher interface. </purpose><description><para>All type dispatchers support this interface. It is used to acquire the visitor interface for the requested type. </para></description><class name="callback"><template> 7407 <template-type-parameter name="T"/> 7408 </template><description><para>This interface is used by type dispatchers to consume the dispatched value. </para></description><method-group name="public member functions"> 7409<method name="operator()" cv="const"><type>void</type><parameter name="value"><paramtype>T const &</paramtype><description><para>The dispatched value </para></description></parameter><description><para>The operator invokes the visitor-specific logic with the given value</para><para> 7410</para></description></method> 7411<method name="conversion-operator" cv="const noexcept" specifiers="explicit"><type>bool</type><description><para>The operator checks if the visitor is attached to a receiver </para></description></method> 7412<method name="operator!" cv="const noexcept"><type>bool</type><description><para>The operator checks if the visitor is not attached to a receiver </para></description></method> 7413</method-group> 7414</class><method-group name="protected member functions"> 7415<method name="BOOST_DEFAULTED_FUNCTION"><type/><parameter name=""><paramtype><classname>type_dispatcher</classname>(<classname>type_dispatcher</classname> const &that)</paramtype></parameter><parameter name=""><paramtype>:m_get_callback_impl(that.m_get_callback_impl) {}</paramtype></parameter><description><para>The method requests a callback for the value of type <computeroutput>T</computeroutput> </para><para> 7416</para></description><returns><para>The type-specific callback or an empty value, if the type is not supported </para> 7417</returns></method> 7418</method-group> 7419<constructor specifiers="explicit" cv="noexcept"><parameter name="get_callback_impl"><paramtype>get_callback_impl_type</paramtype></parameter><description><para>Initializing constructor </para></description></constructor> 7420</class> 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533</namespace> 7534</namespace> 7535</header> 7536<header name="boost/log/utility/unique_identifier_name.hpp"> 7537<para><para>Andrey Semashev </para> 7538 7539<para>30.04.2008</para> 7540 7541The header contains <computeroutput>BOOST_LOG_UNIQUE_IDENTIFIER_NAME</computeroutput> macro definition. </para><macro name="BOOST_LOG_UNIQUE_IDENTIFIER_NAME" kind="functionlike"><macro-parameter name="prefix"/><description><para>Constructs a unique (in the current file scope) token that can be used as a variable name. The name will contain a prefix passed in the <emphasis>prefix</emphasis> argument. This allows to use the macro multiple times on a single line. </para></description></macro> 7542</header> 7543<header name="boost/log/utility/unused_variable.hpp"> 7544<para><para>Andrey Semashev </para> 7545 7546<para>10.05.2008</para> 7547 7548The header contains definition of a macro to suppress compiler warnings about unused variables. </para><namespace name="boost"> 7549<namespace name="log"> 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663</namespace> 7664</namespace> 7665<macro name="BOOST_LOG_UNUSED_VARIABLE" kind="functionlike"><macro-parameter name="type"/><macro-parameter name="var"/><macro-parameter name="initializer"/><purpose>The macro suppresses compiler warnings for <computeroutput>var</computeroutput> being unused. </purpose></macro> 7666</header> 7667<header name="boost/log/utility/value_ref.hpp"> 7668<para><para>Andrey Semashev </para> 7669 7670<para>27.07.2012</para> 7671 7672The header contains implementation of a value reference wrapper. </para><namespace name="boost"> 7673<namespace name="log"> 7674<function name="swap"><type>void</type><template> 7675 <template-type-parameter name="T"/> 7676 <template-type-parameter name="TagT"/> 7677 </template><parameter name="left"><paramtype><classname>value_ref</classname>< T, TagT > &</paramtype></parameter><parameter name="right"><paramtype><classname>value_ref</classname>< T, TagT > &</paramtype></parameter><purpose>Free swap function. </purpose></function> 7678<function name="operator<<"><type>std::basic_ostream< CharT, TraitsT > &</type><template> 7679 <template-type-parameter name="CharT"/> 7680 <template-type-parameter name="TraitsT"/> 7681 <template-type-parameter name="T"/> 7682 <template-type-parameter name="TagT"/> 7683 </template><parameter name="strm"><paramtype>std::basic_ostream< CharT, TraitsT > &</paramtype></parameter><parameter name="val"><paramtype><classname>value_ref</classname>< T, TagT > const &</paramtype></parameter><purpose>Stream output operator. </purpose></function> 7684<function name="operator<<"><type><classname>basic_formatting_ostream</classname>< CharT, TraitsT, AllocatorT > &</type><template> 7685 <template-type-parameter name="CharT"/> 7686 <template-type-parameter name="TraitsT"/> 7687 <template-type-parameter name="AllocatorT"/> 7688 <template-type-parameter name="T"/> 7689 <template-type-parameter name="TagT"/> 7690 </template><parameter name="strm"><paramtype><classname>basic_formatting_ostream</classname>< CharT, TraitsT, AllocatorT > &</paramtype></parameter><parameter name="val"><paramtype><classname>value_ref</classname>< T, TagT > const &</paramtype></parameter><purpose>Log formatting operator. </purpose></function> 7691<function name="operator=="><type>bool</type><template> 7692 <template-type-parameter name="T"/> 7693 <template-type-parameter name="TagT"/> 7694 <template-type-parameter name="U"/> 7695 </template><parameter name="left"><paramtype><classname>value_ref</classname>< T, TagT > const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter></function> 7696<function name="operator=="><type>bool</type><template> 7697 <template-type-parameter name="U"/> 7698 <template-type-parameter name="T"/> 7699 <template-type-parameter name="TagT"/> 7700 </template><parameter name="left"><paramtype>U const &</paramtype></parameter><parameter name="right"><paramtype><classname>value_ref</classname>< T, TagT > const &</paramtype></parameter></function> 7701<function name="operator=="><type>bool</type><template> 7702 <template-type-parameter name="T1"/> 7703 <template-type-parameter name="TagT1"/> 7704 <template-type-parameter name="T2"/> 7705 <template-type-parameter name="TagT2"/> 7706 </template><parameter name="left"><paramtype><classname>value_ref</classname>< T1, TagT1 > const &</paramtype></parameter><parameter name="right"><paramtype><classname>value_ref</classname>< T2, TagT2 > const &</paramtype></parameter></function> 7707<function name="operator!="><type>bool</type><template> 7708 <template-type-parameter name="T"/> 7709 <template-type-parameter name="TagT"/> 7710 <template-type-parameter name="U"/> 7711 </template><parameter name="left"><paramtype><classname>value_ref</classname>< T, TagT > const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter></function> 7712<function name="operator!="><type>bool</type><template> 7713 <template-type-parameter name="U"/> 7714 <template-type-parameter name="T"/> 7715 <template-type-parameter name="TagT"/> 7716 </template><parameter name="left"><paramtype>U const &</paramtype></parameter><parameter name="right"><paramtype><classname>value_ref</classname>< T, TagT > const &</paramtype></parameter></function> 7717<function name="operator!="><type>bool</type><template> 7718 <template-type-parameter name="T1"/> 7719 <template-type-parameter name="TagT1"/> 7720 <template-type-parameter name="T2"/> 7721 <template-type-parameter name="TagT2"/> 7722 </template><parameter name="left"><paramtype><classname>value_ref</classname>< T1, TagT1 > const &</paramtype></parameter><parameter name="right"><paramtype><classname>value_ref</classname>< T2, TagT2 > const &</paramtype></parameter></function> 7723<function name="operator<"><type>bool</type><template> 7724 <template-type-parameter name="T"/> 7725 <template-type-parameter name="TagT"/> 7726 <template-type-parameter name="U"/> 7727 </template><parameter name="left"><paramtype><classname>value_ref</classname>< T, TagT > const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter></function> 7728<function name="operator<"><type>bool</type><template> 7729 <template-type-parameter name="U"/> 7730 <template-type-parameter name="T"/> 7731 <template-type-parameter name="TagT"/> 7732 </template><parameter name="left"><paramtype>U const &</paramtype></parameter><parameter name="right"><paramtype><classname>value_ref</classname>< T, TagT > const &</paramtype></parameter></function> 7733<function name="operator<"><type>bool</type><template> 7734 <template-type-parameter name="T1"/> 7735 <template-type-parameter name="TagT1"/> 7736 <template-type-parameter name="T2"/> 7737 <template-type-parameter name="TagT2"/> 7738 </template><parameter name="left"><paramtype><classname>value_ref</classname>< T1, TagT1 > const &</paramtype></parameter><parameter name="right"><paramtype><classname>value_ref</classname>< T2, TagT2 > const &</paramtype></parameter></function> 7739<function name="operator>"><type>bool</type><template> 7740 <template-type-parameter name="T"/> 7741 <template-type-parameter name="TagT"/> 7742 <template-type-parameter name="U"/> 7743 </template><parameter name="left"><paramtype><classname>value_ref</classname>< T, TagT > const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter></function> 7744<function name="operator>"><type>bool</type><template> 7745 <template-type-parameter name="U"/> 7746 <template-type-parameter name="T"/> 7747 <template-type-parameter name="TagT"/> 7748 </template><parameter name="left"><paramtype>U const &</paramtype></parameter><parameter name="right"><paramtype><classname>value_ref</classname>< T, TagT > const &</paramtype></parameter></function> 7749<function name="operator>"><type>bool</type><template> 7750 <template-type-parameter name="T1"/> 7751 <template-type-parameter name="TagT1"/> 7752 <template-type-parameter name="T2"/> 7753 <template-type-parameter name="TagT2"/> 7754 </template><parameter name="left"><paramtype><classname>value_ref</classname>< T1, TagT1 > const &</paramtype></parameter><parameter name="right"><paramtype><classname>value_ref</classname>< T2, TagT2 > const &</paramtype></parameter></function> 7755<function name="operator<="><type>bool</type><template> 7756 <template-type-parameter name="T"/> 7757 <template-type-parameter name="TagT"/> 7758 <template-type-parameter name="U"/> 7759 </template><parameter name="left"><paramtype><classname>value_ref</classname>< T, TagT > const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter></function> 7760<function name="operator<="><type>bool</type><template> 7761 <template-type-parameter name="U"/> 7762 <template-type-parameter name="T"/> 7763 <template-type-parameter name="TagT"/> 7764 </template><parameter name="left"><paramtype>U const &</paramtype></parameter><parameter name="right"><paramtype><classname>value_ref</classname>< T, TagT > const &</paramtype></parameter></function> 7765<function name="operator<="><type>bool</type><template> 7766 <template-type-parameter name="T1"/> 7767 <template-type-parameter name="TagT1"/> 7768 <template-type-parameter name="T2"/> 7769 <template-type-parameter name="TagT2"/> 7770 </template><parameter name="left"><paramtype><classname>value_ref</classname>< T1, TagT1 > const &</paramtype></parameter><parameter name="right"><paramtype><classname>value_ref</classname>< T2, TagT2 > const &</paramtype></parameter></function> 7771<function name="operator>="><type>bool</type><template> 7772 <template-type-parameter name="T"/> 7773 <template-type-parameter name="TagT"/> 7774 <template-type-parameter name="U"/> 7775 </template><parameter name="left"><paramtype><classname>value_ref</classname>< T, TagT > const &</paramtype></parameter><parameter name="right"><paramtype>U const &</paramtype></parameter></function> 7776<function name="operator>="><type>bool</type><template> 7777 <template-type-parameter name="U"/> 7778 <template-type-parameter name="T"/> 7779 <template-type-parameter name="TagT"/> 7780 </template><parameter name="left"><paramtype>U const &</paramtype></parameter><parameter name="right"><paramtype><classname>value_ref</classname>< T, TagT > const &</paramtype></parameter></function> 7781<function name="operator>="><type>bool</type><template> 7782 <template-type-parameter name="T1"/> 7783 <template-type-parameter name="TagT1"/> 7784 <template-type-parameter name="T2"/> 7785 <template-type-parameter name="TagT2"/> 7786 </template><parameter name="left"><paramtype><classname>value_ref</classname>< T1, TagT1 > const &</paramtype></parameter><parameter name="right"><paramtype><classname>value_ref</classname>< T2, TagT2 > const &</paramtype></parameter></function> 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879</namespace> 7880</namespace> 7881</header> 7882<header name="boost/log/utility/value_ref_fwd.hpp"> 7883<para><para>Andrey Semashev </para> 7884 7885<para>27.07.2012</para> 7886 7887The header contains forward declaration of a value reference wrapper. </para><namespace name="boost"> 7888<namespace name="log"> 7889<class name="value_ref"><template> 7890 <template-type-parameter name="T"/> 7891 <template-type-parameter name="TagT"/> 7892 </template><purpose>Reference wrapper for a stored attribute value. </purpose><description><para>The <computeroutput><classname alt="boost::log::value_ref">value_ref</classname></computeroutput> class template provides access to the stored attribute value. It is not a traditional reference wrapper since it may be empty (i.e. refer to no value at all) and it can also refer to values of different types. Therefore its interface and behavior combines features of Boost.Ref, Boost.Optional and Boost.Variant, depending on the use case.</para><para>The template parameter <computeroutput>T</computeroutput> can be a single type or an MPL sequence of possible types being referred. The reference wrapper will act as either an optional reference or an optional variant of references to the specified types. In any case, the referred values will not be modifiable (i.e. <computeroutput><classname alt="boost::log::value_ref">value_ref</classname></computeroutput> always models a const reference).</para><para>Template parameter <computeroutput>TagT</computeroutput> is optional. It can be used for customizing the operations on this reference wrapper, such as putting the referred value to log. </para></description><method-group name="public member functions"> 7893<method name="BOOST_DEFAULTED_FUNCTION" cv="const noexcept"><type/><parameter name=""><paramtype><classname>value_ref</classname>(<classname>value_ref</classname> const &that)</paramtype></parameter><parameter name=""><paramtype>noexcept :base_type(static_cast< base_type const & >(that)) {}</paramtype></parameter><description><para>Default constructor. Creates a reference wrapper that does not refer to a value.</para><para>Copy constructor.</para><para>Initializing constructor. Creates a reference wrapper that refers to the specified value. </para></description></method> 7894<method name="conversion-operator" cv="const noexcept" specifiers="explicit"><type>bool</type><description><para>The operator verifies if the wrapper refers to a value. </para></description></method> 7895<method name="operator!" cv="const noexcept"><type>bool</type><description><para>The operator verifies if the wrapper does not refer to a value. </para></description></method> 7896<method name="empty" cv="const noexcept"><type>bool</type><description><para> 7897</para></description><returns><para><computeroutput>true</computeroutput> if the wrapper does not refer to a value. </para> 7898</returns></method> 7899<method name="swap" cv="noexcept"><type>void</type><parameter name="that"><paramtype><classname>value_ref</classname> &</paramtype></parameter><description><para>Swaps two reference wrappers </para></description></method> 7900</method-group> 7901</class> 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014</namespace> 8015</namespace> 8016</header> 8017</library-reference>