townforge/fiber
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
1,840 Commits 1 Branch 0 Tags 13 MiB
cc
Commit Graph

328 Commits

Author SHA1 Message Date
Nat Goodspeed
f5c153bf2c Merge branch 'develop' of github.com:olk/boost-fiber into develop 2015-08-31 20:12:13 -04:00
Nat Goodspeed
f3d80ef589 Update some remarks about Asio; add cross-references. 2015-08-31 20:11:05 -04:00
Oliver Kowalke
6a1230f02f fix formating in documentation 2015-08-31 21:32:12 +02:00
Nat Goodspeed
d8f82dfb09 Fix table descriptions, appending source-file links below each. 
Too bad we can't embed such links within a table description.
 2015-08-31 12:41:50 -04:00
Nat Goodspeed
b81a65c566 Add note about interrupting detached fiber at main-fiber shutdown. 2015-08-31 12:34:38 -04:00
Nat Goodspeed
58fa3add01 Change set_scheduling_algorithm() to use_scheduling_algorithm<>(). 2015-08-31 12:21:53 -04:00
Nat Goodspeed
23bcafa0be Add note about barrier reset behavior. 2015-08-31 12:03:52 -04:00
Nat Goodspeed
62d7060475 Discuss destroying future before corresponding promise::set_value(). 2015-08-31 11:44:17 -04:00
Nat Goodspeed
b491696b54 Clarify that neither ~future() nor ~shared_future() blocks. 2015-08-31 11:37:42 -04:00
Nat Goodspeed
e3bb470376 Fill in section on adapting to nonblocking I/O. 2015-08-31 11:29:26 -04:00
Nat Goodspeed
2ed2bb4827 Add when_all_members() description. 2015-08-31 10:38:40 -04:00
Nat Goodspeed
f15fccb4b9 Add wait_all_collect_errors() description. 2015-08-31 10:08:31 -04:00
Nat Goodspeed
cc8acb1fee Add wait_all_until_error(), wait_all_until_error_source() description. 2015-08-31 10:00:38 -04:00
Nat Goodspeed
56191d5190 Add wait_all_values(), wait_all_values_source() description. 2015-08-31 08:15:06 -04:00
Nat Goodspeed
5cb215f741 Add wait_all_simple() description. 2015-08-30 20:49:45 -04:00
Nat Goodspeed
6d8821cf0b Add cross-references between when_any examples. 2015-08-30 20:12:22 -04:00
Nat Goodspeed
53127efe42 Add wait_first_value_het() description. 2015-08-30 19:56:40 -04:00
Nat Goodspeed
7e9213779e Break 'when_any' etc. into subsections. 
This puts subsection entries into the table of contents.
 2015-08-30 19:39:50 -04:00
Nat Goodspeed
ec251c3c02 Add wait_first_success() description. 2015-08-30 19:28:44 -04:00
Nat Goodspeed
bed11fe0a1 Add wait_first_outcome() description. 2015-08-30 18:42:50 -04:00
Nat Goodspeed
93a73835b8 Add [mdash] template and use it to replace --. 
Also place an anchor concerning uncaught exceptions.
 2015-08-30 18:36:10 -04:00
Nat Goodspeed
70b79515bf Correct phrasing for [xchannel_push_effects] template. 
Affects wording for unbounded_channel::push(), bounded_channel::push().
 2015-08-30 18:27:06 -04:00
Nat Goodspeed
4d1984e490 Add warning about tying lifespan of barrier to any waiting fiber. 2015-08-30 08:21:26 -04:00
Nat Goodspeed
455b160aad Add wait_first_value() description. 2015-08-29 21:34:18 -04:00
Nat Goodspeed
a8debb9201 Add first when_any passage (wait_first_simple())... work in progress. 2015-08-29 19:42:53 -04:00
Nat Goodspeed
8e21537c3e Recommend std::unique_lock instead of std::lock_guard for mutex. 
The condition_variable examples spoke about std::lock_guard. But this doesn't
work in practice, as lock_guard has no unlock() method. Use unique_lock
instead, as test_condition.cpp does.
 2015-08-25 12:56:53 -04:00
Oliver Kowalke
91555307e5 fix typo in documentation 2015-08-24 19:52:26 +02:00
Oliver Kowalke
de8feb7ff9 documentation: add link to boost.context for WinFiber support 2015-08-24 17:40:27 +02:00
Nat Goodspeed
1e3e2b8887 Add callbacks.qbk about interfacing Fiber with async callbacks. 
This covers both generic callbacks (adapt_callbacks.cpp,
adapt_method_calls.cpp) and custom Asio completion tokens (yield.hpp,
promise_completion_token.hpp, detail/yield.hpp, detail/promise_handler.hpp).
Mark up the relevant source files to provide code snippets for callbacks.qbk.
 2015-08-24 09:28:16 -04:00
Nat Goodspeed
99db8d50a8 Add section about integration with another main loop. 
Asio integration may be a much larger topic, per email.
 2015-08-19 06:18:08 -04:00
Nat Goodspeed
a2b18c51de Fix cross-references to other Boost libraries, per Paul Bristow. 
As Paul points out, links of the form [@boost:/libs/something/index.html] (as
recommended by
http://www.boost.org/doc/libs/release/doc/html/quickbook/syntax/phrase.html#quickbook.syntax.phrase.links)
do not work when generating PDF, or even when locally generating just one
library's HTML documentation. He suggests linking explicitly to the relevant
boost.org URL. This is much more satisfying as the link can be tested.
 2015-08-17 08:26:07 -04:00
Nat Goodspeed
42cfefa25f Fix [@path] links referencing .cpp files, per Paul Bristow. 2015-08-17 08:14:13 -04:00
Nat Goodspeed
fd9f16776a Flesh out Customization section with step-by-step directions. 
Mark up examples/priority.cpp with code snippets for use in Customization.

Also clarify the effect of changing wait_interval().
 2015-08-16 16:38:21 -04:00
Nat Goodspeed
95cc663e43 Correctly describe bounded_channel's behavior with lwm items. 
I originally assumed that a blocked bounded_channel::push() would only unblock
once the number of items in the channel dropped _below_ lwm, and described it
that way. But in fact the push unblocks as soon as the number of items in the
channel drops as low as lwm. Update documentation accordingly.
 2015-08-15 11:20:19 -04:00
Nat Goodspeed
7a7e10295d Track renamed rationale.qbk. Move it just after overview.qbk. 2015-08-14 11:22:13 -04:00
Nat Goodspeed
666ada61ec Review rationale.qbk. 2015-08-14 11:21:42 -04:00
Nat Goodspeed
e08611555b Rename rational.qbk to rationale.qbk. 2015-08-14 11:10:44 -04:00
Nat Goodspeed
7c7bb2a6d1 Consolidate performance tables. 
Make separate columns for Fiber with default synchronization and Fiber
compiled with BOOST_FIBERS_NO_ATOMICS.

Attempt to link tables to corresponding source files. Attempt does not yet
appear successful.
 2015-08-13 17:40:42 -04:00
Nat Goodspeed
d1df99fab1 A couple small edits to fls.qbk. 2015-08-13 15:23:40 -04:00
Nat Goodspeed
90ea0e30c4 Update packaged_task documentation. 
Describe conventional usage of packaged_task.

Remove documentation for removed members operator safe_bool() and operator!().
 2015-08-13 15:17:53 -04:00
Nat Goodspeed
4d36df2085 Proofread new discussion of fiber migration in Rationale. 2015-08-13 07:38:30 -04:00
Oliver Kowalke
5112f9b4b5 documentation: add notice why fiber migration is not supported 
- interaction of TLS and coroutines/fibers
- NUMA architecutes and memory latency
 2015-08-13 09:47:52 +02:00
Nat Goodspeed
a249f98f14 Reconcile promise.qbk with current implementation. 
Add a cross-reference to shared state.

Remove doc for operator safe_bool() and operator!().

Clarify that set_exception() accepts specifically std::exception_ptr.
 2015-08-12 20:35:05 -04:00
Nat Goodspeed
bd8e43ffa7 Merge branch 'develop' of github.com:olk/boost-fiber into develop 2015-08-12 16:35:08 -04:00
Nat Goodspeed
a0490413cd Further work on futures documentation. 
Explain "shared state", and provide links to the explanation wherever it's
referenced.

We don't need the doc to enumerate 'R& future<R&>::get()' or 'void
future<void>::get()' separately from 'R future<R>::get()': all three
specializations are exactly as the reader expects, given the generic
template (unlike shared_future, where it's useful to spell them out).

Encapsulate some of the necessary redundancies between future and
shared_future documentation.

Explain the effect of promise::set_value() vs. promise::set_exception() on
each of [shared_]future::get(), get_exception_ptr(), wait(), wait_for() and
wait_until().

Add get_exception_ptr() method to shared_future exposition class.

Clarify distinction between shared_future move assignment vs. copy assignment.

Document that async() is now variadic. Document its StackAllocator overload,
and the effect of passing StackAllocator. Remove warning about launch policy
'deferred' since async() has no launch policy parameter.
 2015-08-12 16:32:54 -04:00
Oliver Kowalke
2fcf006f90 fix docu 2015-08-12 19:40:09 +02:00
Nat Goodspeed
3d945b76bd Proofread today's documentation updates. 2015-08-08 11:03:47 -04:00
Oliver Kowalke
dc8af4ea7a documentation: remove refrence to boost.chrono ad boost.move 2015-08-06 17:21:29 +02:00
Oliver Kowalke
7c25c83465 (un)bounded_channel: remove is_empty()/is_closed()/is_full() 2015-08-05 19:59:47 +02:00
Oliver Kowalke
236494717f documentation: add comment regarding to migration of fibers 2015-08-05 19:59:22 +02:00
Nat Goodspeed
1897a2a9fc Explain that is_closed() doesn't imply is_empty(). 2015-08-05 07:51:10 -04:00
Oliver Kowalke
4cdb326754 documentation: link to supported architectures 2015-08-04 20:00:07 +02:00
Oliver Kowalke
ac691acce9 documentation: tested compilers 2015-08-04 19:54:57 +02:00
Oliver Kowalke
f456902492 add test for bounded_channel (basics) 2015-08-02 21:17:04 +02:00
Oliver Kowalke
f275125b93 fixes for unbounded_channel 2015-08-02 20:48:52 +02:00
Nat Goodspeed
23434ca2e2 Tweaks to new documentation 2015-07-29 09:21:49 -04:00
Oliver Kowalke
7a792810c9 documentation: some notes to boost.asio integration 2015-07-29 12:24:00 +02:00
Oliver Kowalke
5feef62a49 documentation: add description for mutext types 2015-07-29 12:13:33 +02:00
Oliver Kowalke
b8e2520b29 documentation: formating 2015-07-29 11:48:42 +02:00
Oliver Kowalke
4140e10330 this_fiber::yield() is not an interruption point 2015-07-29 11:47:17 +02:00
Oliver Kowalke
37b22812f8 documentation: note about thread-safe synchronization 
- note added to section 'Synchronization"
 2015-07-29 11:35:01 +02:00
Oliver Kowalke
5c9cbd0307 documentation: add missing function descriptions 2015-07-29 11:30:43 +02:00
Oliver Kowalke
88d44ffee6 documentation: fix fals function-links in interruption points 2015-07-29 11:19:18 +02:00
Oliver Kowalke
2cbe22d8af documentation: add free function wait_interval() 
- wait_itneval() sets/returns the time interval the thread is set to
sleep if not fiber is ready to run
 2015-07-29 11:18:09 +02:00
Oliver Kowalke
3dbca594df documentation: add missing interruption points in list 2015-07-29 10:59:07 +02:00
Oliver Kowalke
2d07f7b47b documentation: future throw fiber_interrupted 2015-07-29 10:58:26 +02:00
Oliver Kowalke
d5858a2677 documentation: remove invalid functions 2015-07-29 10:38:42 +02:00
Oliver Kowalke
1c139895e0 documentation: rename queue.qbk -> channel.qbk 2015-07-29 10:25:18 +02:00
Oliver Kowalke
519a8924a9 documentation: barrier:wait() is interruption point 2015-07-29 10:20:01 +02:00
Oliver Kowalke
caf55428a1 documentation: fiber::join() asserts on not-a-fiber 2015-07-29 10:12:31 +02:00
Nat Goodspeed
e1c9b2b54c Make Rationale section reference new BOOST_FIBERS_NO_ATOMICS passage. 
Tweaks to new wording.
 2015-07-28 22:31:35 -04:00
Nat Goodspeed
dbca64d7d0 Merge branch 'develop' of github.com:olk/boost-fiber into develop 2015-07-28 22:07:13 -04:00
Nat Goodspeed
ac248e75f8 Couple tweaks to futures.qbk. 2015-07-28 22:06:44 -04:00
Oliver Kowalke
b63f95758d documentation: formating of code in scheduler.qbk 2015-07-28 18:24:25 +02:00
Oliver Kowalke
161f2a134c documentation: default scheduler is not heap-allocated 
- round_robin, the default scheduler, is created at thread-creation
  as thread-local, local static
 2015-07-28 18:20:31 +02:00
Oliver Kowalke
1413406fab documentation: ready_fibers() returns zero if scheduler has no fibers 2015-07-28 17:22:12 +02:00
Oliver Kowalke
6740de6761 documentation: synch. objects are threadsafe per default 
- lib uses atomics to safely synchronize objects running in
different threads
- use BOOST_FIBERS_NO_ATOMICS to remove safety
 2015-07-28 09:57:00 +02:00
Oliver Kowalke
3fac431abc documentation: this_fiber::yield() is a interruption point 
- this_fiber::yield() calls fiber_manager::yield() that calls
fiber_manager::run() -> interruption point
 2015-07-28 09:51:58 +02:00
Oliver Kowalke
350a26b27a documentation: cycles of fiber switch 
- a context switch between fibers costs less than 100 cycles
 2015-07-28 09:20:27 +02:00
Nat Goodspeed
018972f69a Describe bounded_channel::pop() et al. same as unbounded_channel. 
Well, almost the same: bounded_channel pop operations include the note about
unblocking blocked push operations. Parameterize xchannel_pop (et al.) to
allow this divergence between unbounded_channel and bounded_channel pop
methods.
 2015-07-22 08:24:17 -04:00
Nat Goodspeed
0004ac676f Fix "enchanneled"/"dechanneled". Encapsulate some redundant wording. 
The descriptions of [un]bounded_channel::push() and the other push variants
are very similar, and must be kept consistent. Similarly, all the pop variants
must be kept consistent. Use QuickBook templates to supply much of the wording
for these methods.
 2015-07-21 10:44:49 -04:00
Nat Goodspeed
a4de0bb7a5 More documentation. 
Add note explaining why synchronization objects can neither be moved nor
copied.

Introduce line breaks for some code lines that get broken strangely by doc
toolchain.

Eliminate reference to mutex::scoped_lock.
 2015-07-20 09:40:01 -04:00
Nat Goodspeed
3674114094 Merge branch 'develop' of github.com:olk/boost-fiber into develop 2015-07-19 23:11:02 -04:00
Nat Goodspeed
1dadc51ec4 Add reference documentation for custom scheduling classes. 
Also resolve certain previously-dangling internal documentation
cross-references: custom, synchronization, scheduling, stack.

Add documentation placeholders for mutex (and friends) lock(), try_lock(),
unlock() methods.

Add documentation placeholders for future (and shared_future)
get_exception_ptr() methods.

Remove documentation for obsolete future (and shared_future) swap(), operator
safe_bool() and operator!() methods.
 2015-07-19 22:57:56 -04:00
Nat Goodspeed
bbdd101393 Snapshot of incomplete documentation review. 2015-07-10 09:47:11 -04:00
Oliver Kowalke
e7b1ee131c add function ready_fibers() 2015-07-03 18:03:14 +02:00
Oliver Kowalke
5d18cd5a4e add interruption point after fiber_manager::run() 
- functions fiber_manager::join()/fiber_manager::yield()/fiber_manager:.wait()/fiber_manager_wait_until()
  check for interrption of the current fiber
 2015-06-21 10:53:37 +02:00
Oliver Kowalke
6c35324727 use atomics per default 
- atomics can be disable using BOOST_FIBERS_NO_ATOMICS compiler flag
 2015-06-20 21:31:34 +02:00
Oliver Kowalke
20d08d98cd enable atomics with BOOST_FIBERS_USE_ATOMCIS 2015-06-19 21:39:34 +02:00
Nat Goodspeed
050d974e5e Merge branch 'develop' of github.com:olk/boost-fiber into develop 2015-06-14 21:14:42 -04:00
Nat Goodspeed
2946b35b0d Fix minor Quickbook syntax error. 2015-06-14 21:14:02 -04:00
Oliver Kowalke
5f2c8e47d4 update documentation: using Windows Fiber API 2015-06-06 09:02:01 +02:00
Oliver Kowalke
ca7e8be37c update docu 2015-05-23 18:27:08 +02:00
Nat Goodspeed
77a443b03b Merge branch 'develop' of github.com:olk/boost-fiber into sched-props-dev 2015-05-11 05:51:14 -04:00
Nat Goodspeed
2687814477 Merge branch 'develop' of github.com:olk/boost-fiber into sched-props-dev 
Resolved conflicts:
	doc/condition_variables.qbk
	examples/cpp03/migration/workstealing_round_robin.cpp
	examples/cpp03/migration/workstealing_round_robin.hpp
	include/boost/fiber/algorithm.hpp
	include/boost/fiber/bounded_queue.hpp
	include/boost/fiber/detail/fiber_base.hpp
	include/boost/fiber/detail/fifo.hpp
	include/boost/fiber/detail/waiting_queue.hpp
	include/boost/fiber/detail/worker_fiber.hpp
	include/boost/fiber/fiber.hpp
	include/boost/fiber/fiber_manager.hpp
	include/boost/fiber/fixedsize_stack.hpp
	include/boost/fiber/operations.hpp
	include/boost/fiber/round_robin.hpp
	include/boost/fiber/unbounded_queue.hpp
	src/detail/worker_fiber.cpp
	src/fiber.cpp
	src/fiber_manager.cpp
	src/round_robin.cpp
 2015-05-10 22:03:35 -04:00
Oliver Kowalke
e1bd9b8151 docu 2015-04-18 13:23:08 +02:00
Oliver Kowalke
266ae8dc4b update docu 2015-02-19 19:07:46 +01:00
Oliver Kowalke
5756de290c docu 2015-02-15 19:54:43 +01:00
Oliver Kowalke
3b9382f8df update docu 2015-02-14 11:11:11 +01:00
Oliver Kowalke
13bf486fea update stack-allocators 2015-02-06 18:29:26 +01:00
Oliver Kowalke
f6c7ab7826 rename (un)bounded_queue -> (un)bounded_channel + use allocator 2014-12-28 21:30:14 +01:00
Oliver Kowalke
2f19be6d67 use C++11 2014-12-27 19:07:42 +01:00
Oliver Kowalke
7fb469cd10 some fixes 2014-09-24 19:18:44 +02:00
Oliver Kowalke
244c539a2e Add some explanatory material in scheduling.qbk about coding your own 
scheduler and setting it with set_scheduling_algorithm(). Document
sched_algorithm interface class.

Fix the example in condition_variables.qbk to explicitly unlock 'lk'
before
calling process_data().
 2014-09-22 19:11:22 +02:00
Nat Goodspeed
6fb1b04789 Change some doc references from 'algorithm' to 'sched_algorithm'. 
Add some explanatory material in scheduling.qbk about coding your own
scheduler and setting it with set_scheduling_algorithm(). Document
sched_algorithm interface class.

Fix the example in condition_variables.qbk to explicitly unlock 'lk' before
calling process_data().
 2014-09-22 10:00:34 -04:00
Oliver Kowalke
a21b18b856 update docu 2014-09-19 16:58:16 +02:00
Oliver Kowalke
8dc8dce605 docu update 2014-09-15 17:03:31 +02:00
Oliver Kowalke
184455bca4 remove html 2014-09-15 16:56:01 +02:00
Oliver Kowalke
bdab3735ed update docu 2014-09-12 16:58:07 +02:00
Oliver Kowalke
c161e095af docu update 2014-09-09 21:02:12 +02:00
Oliver Kowalke
c005bb2c8f doc update 2014-09-09 20:40:26 +02:00
Oliver Kowalke
ef7eff3d43 update docu 2014-09-07 10:51:33 +02:00
Oliver Kowalke
491012776f update docu 2014-09-05 17:55:49 +02:00
Oliver Kowalke
e48252837f accept any clock type for lock_until() etc. 2014-09-05 17:55:16 +02:00
Oliver Kowalke
32d4a056d0 update documentation 2014-08-20 17:37:47 +02:00
Oliver Kowalke
ccbda7c04a improve performance tests and docu 2014-07-31 18:04:25 +02:00
Oliver Kowalke
c58eb91807 consolidate performance tests 2014-07-26 10:18:27 +02:00
Oliver Kowalke
142dd2cd5b some doc corrections 2014-07-21 20:04:38 +02:00
Nat Goodspeed
bcaff62763 Update docs for barrier.hpp and bounded_queue.hpp. 
Use std::size_t as argument type for barrier constructor.

Add bounded_queue::upper_bound(), lower_bound(), value_pop().

Make is_empty(), is_full() const.

Add TimePointType template param to push_wait_until(), pop_wait_until().
 2014-07-16 17:25:10 -04:00
Oliver Kowalke
a2d3eba716 fix migrating a fiber between threads 2014-06-26 19:01:49 +02:00
Oliver Kowalke
d4199de28a update docu -> performance counters 2014-03-22 20:54:54 +01:00
Oliver Kowalke
5b6d77b6b5 renaming of fiber classes 2014-03-05 17:30:11 +01:00
Oliver Kowalke
7cf2cabc99 allow different stack-allocators 2014-02-26 19:40:28 +01:00
Oliver Kowalke
fc608cdaf7 use symmetric_coroutine<> (from coroutine branch develop) 2014-02-22 21:38:24 +01:00
Oliver Kowalke
2b37b33011 use asymmetric_coroutine<> from (coroutine branch develop) 2014-02-22 21:26:28 +01:00
Oliver Kowalke
f20cb844e5 documentation of performance 2014-02-22 20:02:38 +01:00
Mario Lang
d471d7133d Fix some typos. 2013-12-29 14:00:36 +01:00
Oliver Kowalke
40d469d346 let notifier for thread's initial context allocate by algoritm 2013-12-28 10:19:06 +01:00
Oliver Kowalke
aa6f0b1bce add a note to destructor of fiber in documentation 2013-12-16 17:33:17 +01:00
Oliver Kowalke
3b7ed1f45a changed template args for packaged_task in documentation 2013-12-15 08:31:58 +01:00
Oliver Kowalke
240a57a8ed fix signature template arg of packaged_task 2013-12-12 20:19:17 +01:00
Oliver Kowalke
7ea3a8968c html updated 2013-12-08 22:09:03 +01:00
Oliver Kowalke
909c8ed3fc some smalle fixes in documentation 2013-12-06 08:52:22 +01:00
Nat Goodspeed
8432f8b864 Update doc for set_scheduling_algorithm() for void return. 
Add note to set_scheduling_algorithm() about caller's responsibility to
eventually destroy the passed scheduler object.
 2013-12-04 13:26:30 -05:00
Nat Goodspeed
025a31d9e2 Add notes for algorithm::active() and get_main_id() methods. 
This reflects my improved understanding of these methods based on our mail
conversation.
Also state explicitly that you are permitted to supply your own scheduler.
 2013-12-04 09:51:27 -05:00
Nat Goodspeed
7eca9fb5fb Document set_scheduling_algorithm(). 
Add cross-references for that and for algorithm, round_robin and
round_robin_ws.
 2013-12-03 22:41:25 -05:00
Oliver Kowalke
511b740ec2 default-scheduler allocated 2013-12-02 19:45:48 +01:00
Nat Goodspeed
d49383151e Review of recent queue documentation changes and scheduling doc. 2013-11-27 10:57:22 -05:00
Nat Goodspeed
bf5428c5d5 Remove extra line containing unmatched double ]]. 2013-11-25 12:01:33 -05:00
Oliver Kowalke
e1adfd666c add doc about scheduling 2013-11-24 17:29:06 +01:00
Oliver Kowalke
ddd4f8fff6 update docu 2013-11-21 17:49:08 +01:00
Nat Goodspeed
b0d09be850 Fix doc about fiber::operator safe_bool(): NOT same as joinable(). 
Looking at the implementation, it seems that operator safe_bool() and its
companion, operator!(), interrogate whether the referenced fiber has or has
not terminated. joinable() does not.
Add more joinable() cross-references, and cross-reference joinable(), operator
safe_bool() and operator!().
 2013-11-18 22:15:49 -05:00
Nat Goodspeed
e436bc991d Add class_heading, member_heading et al. QuickBook templates and use for cross-referencing. 2013-11-08 18:30:11 -05:00
Nat Goodspeed
d7b4be06c7 Link this_fiber::thread_affinity() to fiber::thread_affinity(). 
Use [#named_anchor] QuickBook functionality rather than trying to predict the
normalized link for [heading Member function `thread_affinity( bool)`], which
looks like this:

fiber.fiber_mgmt.fiber.member_function__code__phrase_role__identifier__thread_affinity__phrase__phrase_role__special_____phrase___phrase_role__keyword__bool__phrase__phrase_role__special_____phrase___code_
 2013-11-07 08:22:58 -05:00
Nat Goodspeed
7c7683ad41 Start adding internal cross-references to fiber documentation 2013-11-06 22:02:43 -05:00
Nat Goodspeed
32af998f3c Fix markup error in fiber::thread_affinity() Note. 2013-11-06 17:02:24 -05:00
Nat Goodspeed
d9c1272df6 Describe this_fiber::thread_affinity() in terms of fiber::thread_affinity(). 
Also mention that fiber::thread_affinity() is off by default.
 2013-11-06 16:31:20 -05:00
Nat Goodspeed
938de04829 Document that bounded_queue constructor can in fact throw. 2013-11-06 16:28:56 -05:00
Nat Goodspeed
919a2993c2 Document new [un]bounded_queue API, plus a bit of guessing. 
Change certain [un]bounded_queue method signatures to return queue_op_status.
Their previous signatures didn't provide any way to report a closed queue.
For Note: interruption point, document Throws: fiber_interrupted.
Write a few more words about bounded_queue's high water mark and low water
mark.
 2013-11-06 15:53:34 -05:00
Nat Goodspeed
634fa3fe6a Document desired behavior for fiber::thread_affinity(). 
Also clarify Preconditions for fiber::priority().
 2013-11-06 15:28:46 -05:00
Oliver Kowalke
64c372d059 add thread_affinity() to fiber's public interface 2013-11-02 16:56:24 +01:00
Oliver Kowalke
6bb976b4d3 fix queues 2013-11-02 14:15:05 +01:00
Oliver Kowalke
99cb841259 some corrections for noexcept specifier 2013-11-02 07:05:03 +01:00
Oliver Kowalke
fbc1e67c25 make fibers thread affin 2013-11-02 06:53:21 +01:00
Nat Goodspeed
2d79ce67a0 Clarify condition_variable vs. condition_variable_any. 
Make condition_variable::wait_until() and wait_for() consistently use 'lk' instead of 'lt' because explanations only describe 'lk'.
Explain condition_variable::wait(), wait_until() and wait_for() Precondition.
Distinguish values returned by wait_until(), wait_for() overloads with and without predicates.
Update request for section concerning algorithm, set_scheduling_algorithm(), round_robin and round_robin_ws.
Clarify lifespan implications of fiber_group::add_fiber(). Explain requirement for a heap fiber object.
Experiment with cross-reference links to other Boost libraries.
 2013-10-31 11:19:22 -04:00
Oliver Kowalke
f5d9d6536b docuemntation 2013-10-28 14:54:00 +01:00
Oliver Kowalke
5b236bc132 add description in code example 2013-10-26 10:31:23 +02:00
Oliver Kowalke
676b9616d6 documentation update (pass #3) 2013-10-26 10:18:35 +02:00
Oliver Kowalke
de58203ea8 docu 2013-10-14 19:31:43 +02:00
Oliver Kowalke
9b1a76ad2f docu 2013-10-14 19:24:43 +02:00
Oliver Kowalke
3a0d0309e5 docu 2013-10-14 17:24:37 +02:00
Oliver Kowalke
4f60f804ff docuemtnation update 2013-10-13 11:01:38 +02:00
Oliver Kowalke
045a40e5c6 docu 2013-09-29 10:42:29 +02:00
Oliver Kowalke
49cb3692bd docu 2013-09-26 20:27:25 +02:00
Oliver Kowalke
2d005f743e docu 2013-09-26 19:26:18 +02:00
Oliver Kowalke
5be0757ffd docu updated 2013-09-24 17:17:57 +02:00
Oliver Kowalke
13e52fdb23 docu 2013-09-16 17:33:15 +02:00
Oliver Kowalke
327104ffe3 dou 2013-09-15 19:38:29 +02:00
Oliver Kowalke
5e59b45c8d documentation 2013-09-13 17:38:36 +02:00
Oliver Kowalke
00ec9d32a3 update 2013-08-28 21:57:14 +02:00
Oliver Kowalke
2e000575e1 docu 2013-08-27 22:04:12 +02:00
Oliver Kowalke
1e838db13d docu 2013-08-25 19:52:15 +02:00
Oliver Kowalke
0cf8661315 documentation prepared 2013-08-21 17:30:00 +02:00
Oliver Kowalke
f06b6cf0d4 fix auto-link in config.hpp 2013-08-13 10:27:02 +02:00
Oliver Kowalke
31c764b7bc some code clean-up 2013-06-14 16:53:46 +02:00
Oliver Kowalke
b9542e1745 enhance docuemntation 2013-06-12 16:59:10 +02:00
Oliver Kowalke
645281a2ba add fiber::detach() 2012-12-13 17:59:13 +01:00
Oliver Kowalke
81e62e8962 changed directory structure as required by modularized-boost 2012-12-09 15:22:59 +01:00