From 7e1b2a0e3c014bc23aaa7a045efb5f1109818051 Mon Sep 17 00:00:00 2001
From: Josh Blum <josh@joshknows.com>
Date: Wed, 13 Jul 2011 17:25:40 -0700
Subject: uhd: added tasks to simplify thread spawning use cases

---
 host/include/uhd/utils/CMakeLists.txt |  1 +
 host/include/uhd/utils/tasks.hpp      | 53 +++++++++++++++++++++++++++++++++++
 2 files changed, 54 insertions(+)
 create mode 100644 host/include/uhd/utils/tasks.hpp

(limited to 'host/include')

diff --git a/host/include/uhd/utils/CMakeLists.txt b/host/include/uhd/utils/CMakeLists.txt
index 88a0e612b..0bf98fb67 100644
--- a/host/include/uhd/utils/CMakeLists.txt
+++ b/host/include/uhd/utils/CMakeLists.txt
@@ -30,6 +30,7 @@ INSTALL(FILES
     safe_call.hpp
     safe_main.hpp
     static.hpp
+    tasks.hpp
     thread_priority.hpp
     DESTINATION ${INCLUDE_DIR}/uhd/utils
     COMPONENT headers
diff --git a/host/include/uhd/utils/tasks.hpp b/host/include/uhd/utils/tasks.hpp
new file mode 100644
index 000000000..38b2bddf0
--- /dev/null
+++ b/host/include/uhd/utils/tasks.hpp
@@ -0,0 +1,53 @@
+//
+// Copyright 2011 Ettus Research LLC
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+#ifndef INCLUDED_UHD_UTILS_TASKS_HPP
+#define INCLUDED_UHD_UTILS_TASKS_HPP
+
+#include <uhd/config.hpp>
+#include <boost/shared_ptr.hpp>
+#include <boost/function.hpp>
+#include <boost/utility.hpp>
+
+namespace uhd{
+
+    class task : boost::noncopyable{
+    public:
+        typedef boost::shared_ptr<task> sptr;
+        typedef boost::function<void(void)> task_fcn_type;
+
+        /*!
+         * Create a new task object with function callback.
+         * The task function callback will be run in a loop.
+         * until the thread is interrupted by the deconstructor.
+         *
+         * A task should return in a reasonable amount of time
+         * or may block forever under the following conditions:
+         *  - The blocking call is interruptible.
+         *  - The task polls the interrupt condition.
+         *
+         * \param task_fcn the task callback function
+         * \return a new task object
+         */
+        static sptr make(const task_fcn_type &task_fcn);
+
+    };
+
+} //namespace uhd
+
+#endif /* INCLUDED_UHD_UTILS_TASKS_HPP */
+
-- 
cgit v1.2.3