queue_attributes.h

/*
 * Copyright (c) 2014-2015, Siemens AG. All rights reserved.
 *
 * 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.
 */

#ifndef EMBB_MTAPI_QUEUE_ATTRIBUTES_H_
#define EMBB_MTAPI_QUEUE_ATTRIBUTES_H_

#include <embb/mtapi/c/mtapi.h>
#include <embb/mtapi_ext/internal/check_status.h>

namespace embb {
namespace mtapi {

/**
 * Contains attributes of a Queue.
 *
 * \ingroup CPP_MTAPI_EXT
 */
class QueueAttributes {
public:
  /**
   * Constructs a QueueAttributes object.
   */
  QueueAttributes() {
    mtapi_status_t status;
    mtapi_queueattr_init(&attributes_, &status);
    internal::CheckStatus(status);
  }

  /**
   * Sets the global property of a Queue.
   * This determines whether the object will be visible across nodes.
   *
   * \returns Reference to this object.
   */
  QueueAttributes & SetGlobal(
    bool state                         /**< The state to set. */
    ) {
    mtapi_status_t status;
    mtapi_boolean_t st = state ? MTAPI_TRUE : MTAPI_FALSE;
    mtapi_queueattr_set(&attributes_, MTAPI_QUEUE_GLOBAL,
      &st, sizeof(st), &status);
    internal::CheckStatus(status);
    return *this;
  }

  /**
   * Sets the ordered property of a Queue.
   * If set to \c true, tasks enqueued will be executed in order.
   *
   * \returns Reference to this object.
   */
  QueueAttributes & SetOrdered(
    bool state                         /**< The state to set. */
    ) {
    mtapi_status_t status;
    mtapi_boolean_t st = state ? MTAPI_TRUE : MTAPI_FALSE;
    mtapi_queueattr_set(&attributes_, MTAPI_QUEUE_ORDERED,
      &st, sizeof(st), &status);
    internal::CheckStatus(status);
    return *this;
  }

  /**
   * Sets the retain property of a Queue.
   * If set to \c true, tasks will be retained while a queue is disabled.
   * Otherwise the will be canceled.
   *
   * \returns Reference to this object.
   */
  QueueAttributes & SetRetain(
    bool state                         /**< The state to set. */
    ) {
    mtapi_status_t status;
    mtapi_boolean_t st = state ? MTAPI_TRUE : MTAPI_FALSE;
    mtapi_queueattr_set(&attributes_, MTAPI_QUEUE_RETAIN,
      &st, sizeof(st), &status);
    internal::CheckStatus(status);
    return *this;
  }

  /**
   * Sets the domain shared property of a Queue.
   * This determines whether the object will be visible across domains.
   *
   * \returns Reference to this object.
   */
  QueueAttributes & SetDomainShared(
    bool state                         /**< The state to set. */
    ) {
    mtapi_status_t status;
    mtapi_boolean_t st = state ? MTAPI_TRUE : MTAPI_FALSE;
    mtapi_queueattr_set(&attributes_, MTAPI_QUEUE_DOMAIN_SHARED,
      &st, sizeof(st), &status);
    internal::CheckStatus(status);
    return *this;
  }

  /**
   * Sets the priority of a Queue.
   * The priority influences the order in which tasks are chosen for execution.
   *
   * \returns Reference to this object.
   */
  QueueAttributes & SetPriority(
    mtapi_uint_t priority              /**< The priority to set. */
    ) {
    mtapi_status_t status;
    mtapi_queueattr_set(&attributes_, MTAPI_QUEUE_PRIORITY,
      &priority, sizeof(priority), &status);
    internal::CheckStatus(status);
    return *this;
  }

  /**
   * Sets the limit (capacity) of a Queue.
   *
   * \returns Reference to this object.
   */
  QueueAttributes & SetLimit(
    mtapi_uint_t limit                 /**< The limit to set. */
    ) {
    mtapi_status_t status;
    mtapi_queueattr_set(&attributes_, MTAPI_QUEUE_LIMIT,
      &limit, sizeof(limit), &status);
    internal::CheckStatus(status);
    return *this;
  }

  /**
   * Returns the internal representation of this object.
   * Allows for interoperability with the C interface.
   *
   * \returns A reference to the internal mtapi_queue_attributes_t structure.
   */
  mtapi_queue_attributes_t const & GetInternal() const {
    return attributes_;
  }

private:
  mtapi_queue_attributes_t attributes_;
};

} // namespace mtapi
} // namespace embb

#endif // EMBB_MTAPI_QUEUE_ATTRIBUTES_H_