continuation.h 2.98 KB
Newer Older
1
/*
2
 * Copyright (c) 2014-2015, Siemens AG. All rights reserved.
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

27 28
#ifndef EMBB_TASKS_CONTINUATION_H_
#define EMBB_TASKS_CONTINUATION_H_
29 30

#include <embb/mtapi/c/mtapi.h>
31 32 33
#include <embb/tasks/task_context.h>
#include <embb/tasks/action.h>
#include <embb/tasks/task.h>
34 35

namespace embb {
36
namespace tasks {
37 38

/**
39 40 41 42
 *  Helper struct for Continuation.
 *
 *  \ingroup CPP_TASKS
 */
43 44 45
struct ContinuationStage;

/**
46 47 48 49 50
 * A Continuation encapsulates a chain of \link Action Actions \endlink to be
 * executed consecutively.
 *
 * \ingroup CPP_TASKS
 */
51 52 53
class Continuation {
 public:
  /**
54 55
   * Copies a Continuation.
   */
56 57 58 59 60
  Continuation(
    Continuation const & cont          /**< [in] The Continuation to copy. */
    );

  /**
61 62
   * Destroys a Continuation.
   */
63 64 65
  ~Continuation();

  /**
66 67 68 69
   * Appends an Action to the Continuation chain.
   * \returns A reference to this Continuation chain.
   * \notthreadsafe
   */
70 71 72 73 74 75
  Continuation & Then(
    Action action                      /**< [in] The Action to append to the
                                            continuation */
    );

  /**
76 77 78 79
   * Runs the Continuation chain.
   * \returns The Task representing the Continuation chain.
   * \notthreadsafe
   */
80 81 82
  Task Spawn();

  /**
83 84 85 86
   * Runs the Continuation chain with the specified execution_policy.
   * \returns The Task representing the Continuation chain.
   * \notthreadsafe
   */
87
  Task Spawn(
88
    ExecutionPolicy execution_policy   /**< [in] The execution policy to use */
89 90 91 92 93 94 95 96 97 98 99 100 101
    );

  friend class Node;

 private:
  explicit Continuation(Action action);

  void ExecuteContinuation(TaskContext & context);

  ContinuationStage * first_;
  ContinuationStage * last_;
};

102
} // namespace tasks
103 104
} // namespace embb

105
#endif // EMBB_TASKS_CONTINUATION_H_