Embedded Multicore Building Blocks V1.0.0
job.h
1 /*
2  * Copyright (c) 2014-2017, Siemens AG. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
18  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24  * POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #ifndef EMBB_MTAPI_JOB_H_
28 #define EMBB_MTAPI_JOB_H_
29 
30 #include <embb/mtapi/c/mtapi.h>
31 #include <embb/mtapi/internal/check_status.h>
32 
33 namespace embb {
34 namespace mtapi {
35 
41 class Job {
42  public:
48  Job() {
49  handle_.id = 0;
50  handle_.tag = 0;
51  }
52 
57  Job(
58  Job const & other
59  ) : handle_(other.handle_) {
60  // empty
61  }
62 
67  void operator=(
68  Job const & other
69  ) {
70  handle_ = other.handle_;
71  }
72 
80  mtapi_job_hndl_t GetInternal() const {
81  return handle_;
82  }
83 
84  friend class Node;
85 
86  private:
91  Job(
92  mtapi_job_id_t job_id,
93  mtapi_domain_t domain_id
94  ) {
95  mtapi_status_t status;
96  handle_ = mtapi_job_get(job_id, domain_id, &status);
97  internal::CheckStatus(status);
98  }
99 
100  mtapi_job_hndl_t handle_;
101 };
102 
103 } // namespace mtapi
104 } // namespace embb
105 
106 #endif // EMBB_MTAPI_JOB_H_
Definition: lock_free_mpmc_queue.h:40
A singleton representing the MTAPI runtime.
Definition: node.h:70
Job()
Constructs a Job.
Definition: job.h:48
Represents a collection of Actions.
Definition: job.h:41
void operator=(Job const &other)
Copies a Job object.
Definition: job.h:67
mtapi_job_hndl_t mtapi_job_get(const mtapi_job_id_t job_id, const mtapi_domain_t domain_id, mtapi_status_t *status)
Given a job_id, this function returns the MTAPI handle for referencing the actions implementing the j...
Job(Job const &other)
Copies a Job object.
Definition: job.h:57
mtapi_job_hndl_t GetInternal() const
Returns the internal representation of this object.
Definition: job.h:80