2 Copyright Oliver Kowalke 2014.
3 Distributed under the Boost Software License, Version 1.0.
4 (See accompanying file LICENSE_1_0.txt or copy at
5 http://www.boost.org/LICENSE_1_0.txt
8 [section:attributes Attributes]
10 Class `attributes` is used to specify parameters required to setup a
28 flag_unwind_t do_unwind;
29 flag_fpu_t preserve_fpu;
31 attributes() noexcept;
33 explicit attributes( std::size_t size_) noexcept;
35 explicit attributes( flag_unwind_t do_unwind_) noexcept;
37 explicit attributes( flag_fpu_t preserve_fpu_) noexcept;
39 explicit attributes( std::size_t size_, flag_unwind_t do_unwind_) noexcept;
41 explicit attributes( std::size_t size_, flag_fpu_t preserve_fpu_) noexcept;
43 explicit attributes( flag_unwind_t do_unwind_, flag_fpu_t preserve_fpu_) noexcept;
45 explicit attributes( std::size_t size_, flag_unwind_t do_unwind_, flag_fpu_t preserve_fpu_) noexcept;
48 [heading `attributes()`]
50 [[Effects:] [Default constructor using `boost::context::default_stacksize()`, does unwind
51 the stack after coroutine/generator is complete and preserves FPU registers.]]
52 [[Throws:] [Nothing.]]
55 [heading `attributes( std::size_t size)`]
57 [[Effects:] [Argument `size` defines stack size of the new coroutine.
58 Stack unwinding after termination and preserving FPU registers is set by
60 [[Throws:] [Nothing.]]
63 [heading `attributes( flag_unwind_t do_unwind)`]
65 [[Effects:] [Argument `do_unwind` determines if stack will be unwound after
66 termination or not. The default stacksize is used for the new coroutine
67 and FPU registers are preserved.]]
68 [[Throws:] [Nothing.]]
71 [heading `attributes( flag_fpu_t preserve_fpu)`]
73 [[Effects:] [Argument `preserve_fpu` determines if FPU register have to be
74 preserved across context switches. The default stacksize is used for the
75 new coroutine and its stack will be unwound after termination.]]
76 [[Throws:] [Nothing.]]
79 [heading `attributes( std::size_t size, flag_unwind_t do_unwind)`]
81 [[Effects:] [Arguments `size` and `do_unwind` are given by the user.
82 FPU registers are preserved across each context switch.]]
83 [[Throws:] [Nothing.]]
86 [heading `attributes( std::size_t size, flag_fpu_t preserve_fpu)`]
88 [[Effects:] [Arguments `size` and `preserve_fpu` are given by the user.
89 The stack is automatically unwound after coroutine/generator terminates.]]
90 [[Throws:] [Nothing.]]
93 [heading `attributes( flag_unwind_t do_unwind, flag_fpu_t preserve_fpu)`]
95 [[Effects:] [Arguments `do_unwind` and `preserve_fpu` are given by the user.
96 The stack gets a default value of `boost::context::default_stacksize()`.]]
97 [[Throws:] [Nothing.]]
100 [heading `attributes( std::size_t size, flag_unwind_t do_unwind, flag_fpu_t preserve_fpu)`]
102 [[Effects:] [Arguments `size`, `do_unwind` and `preserve_fpu` are given by the
104 [[Throws:] [Nothing.]]