Commit 746e2f18 by Marcus Winter

Merge branch 'embb533_worker_thread_os_priorities' into embb609_doxygen_warnings

# Conflicts:
#	mtapi_cpp/include/embb/mtapi/action.h
#	mtapi_cpp/include/embb/mtapi/group.h
#	mtapi_cpp/include/embb/mtapi/node.h
#	mtapi_cpp/include/embb/mtapi/queue.h
#	mtapi_cpp/include/embb/mtapi/task_attributes.h
parents 8890b584 9789d867
......@@ -289,26 +289,27 @@ class Node {
}
/**
* Get the job with the given id in the domain of the node.
* Retrieves a handle to the Job identified by \c job_id within the domain
* of the local Node.
*
* \returns The handle for the requested Job.
* \returns The handle to the requested Job.
* \waitfree
*/
Job GetJob(
mtapi_job_id_t job_id /**< ID of the job to return */
mtapi_job_id_t job_id /**< [in] The id of the job */
) {
return Job(job_id, domain_id_);
}
/**
* Get the job with the given id in the specified domain.
* Retrieves a handle to the Job identified by \c job_id and \c domain_id.
*
* \returns The handle for the requested Job.
* \returns The handle to the requested Job.
* \waitfree
*/
Job GetJob(
mtapi_job_id_t job_id, /**< ID of the job to return */
mtapi_domain_t domain_id /**< Domain to get the job from */
mtapi_job_id_t job_id, /**< [in] The id of the job */
mtapi_domain_t domain_id /**< [in] The domain id to use */
) {
return Job(job_id, domain_id);
}
......@@ -316,7 +317,7 @@ class Node {
/**
* Constructs an Action.
*
* \returns The handle for the new Action.
* \returns The handle to the new Action.
* \lockfree
*/
Action CreateAction(
......@@ -335,7 +336,7 @@ class Node {
/**
* Constructs an Action.
*
* \returns The handle for the new Action.
* \returns The handle to the new Action.
* \lockfree
*/
Action CreateAction(
......@@ -352,7 +353,7 @@ class Node {
/**
* Constructs an Action.
*
* \returns The handle for the new Action.
* \returns The handle to the new Action.
* \lockfree
*/
Action CreateAction(
......@@ -367,7 +368,7 @@ class Node {
/**
* Constructs an Action.
*
* \returns The handle for the new Action.
* \returns The handle to the new Action.
* \lockfree
*/
Action CreateAction(
......@@ -380,7 +381,7 @@ class Node {
/**
* Constructs a Group object with default attributes.
*
* \returns The handle for the new Group.
* \returns The handle to the new Group.
* \lockfree
*/
Group CreateGroup() {
......@@ -390,7 +391,7 @@ class Node {
/**
* Constructs a Group object with default attributes and the given ID.
*
* \returns The handle for the new Group.
* \returns The handle to the new Group.
* \lockfree
*/
Group CreateGroup(
......@@ -402,11 +403,11 @@ class Node {
/**
* Constructs a Group object using the given Attributes.
*
* \returns The handle for the new Group.
* \returns The handle to the new Group.
* \lockfree
*/
Group CreateGroup(
GroupAttributes const & group_attr /**< Attributes for the Group. */
GroupAttributes const & group_attr /**< The GroupAttributes to use. */
) {
return Group(MTAPI_GROUP_ID_NONE, &group_attr.GetInternal());
}
......@@ -414,7 +415,7 @@ class Node {
/**
* Constructs a Group object with given attributes and ID.
*
* \returns The handle for the new Group.
* \returns The handle to the new Group.
* \lockfree
*/
Group CreateGroup(
......@@ -427,7 +428,7 @@ class Node {
/**
* Constructs a Queue with the given Job and default attributes.
*
* \returns The handle for the new Queue.
* \returns The handle to the new Queue.
* \lockfree
*/
Queue CreateQueue(
......@@ -439,7 +440,7 @@ class Node {
/**
* Constructs a Queue with the given Job and QueueAttributes.
*
* \returns The handle for the new Queue.
* \returns The handle to the new Queue.
* \lockfree
*/
Queue CreateQueue(
......
......@@ -105,13 +105,13 @@ class TaskAttributes {
/**
* Sets the ExecutionPolicy of a Task.
* The policy influences the priority and affinity of a Task.
* The ExecutionPolicy determines the affinity and priority of a Task.
*
* \returns Reference to this object.
* \notthreadsafe
*/
TaskAttributes & SetPolicy(
ExecutionPolicy const & policy /**< The policy to set. */
ExecutionPolicy const & policy /**< The ExecutionPolicy to set. */
) {
SetPriority(policy.GetPriority());
SetAffinity(policy.GetAffinity());
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment