Move mcrouter/lib/fibers to folly/experimental/fibers
[folly.git] / folly / experimental / fibers / ForEach.h
1 /*
2  * Copyright 2015 Facebook, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *   http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #pragma once
17
18 namespace folly { namespace fibers {
19
20 /**
21  * Schedules several tasks and blocks until all of them are completed.
22  * In the process of their successfull completion given callback would be called
23  * for each of them with the index of the task and the result it returned (if
24  * not void).
25  * If any of these n tasks throws an exception, this exception will be
26  * re-thrown, but only when all tasks are complete. If several tasks throw
27  * exceptions one of them will be re-thrown. Callback won't be called for
28  * tasks that throw exception.
29  *
30  * @param first  Range of tasks to be scheduled
31  * @param last
32  * @param F      callback to call for each result.
33  *               In case of each task returning void it should be callable
34  *                  F(size_t id)
35  *               otherwise should be callable
36  *                  F(size_t id, Result)
37  */
38 template <class InputIterator, class F>
39 inline void forEach(InputIterator first, InputIterator last, F&& f);
40
41 }}  // folly::fibers
42
43 #include <folly/experimental/fibers/ForEach-inl.h>