summaryrefslogtreecommitdiffstats
path: root/src/uscxml/interpreter/EventQueue.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/uscxml/interpreter/EventQueue.h')
-rw-r--r--src/uscxml/interpreter/EventQueue.h65
1 files changed, 65 insertions, 0 deletions
diff --git a/src/uscxml/interpreter/EventQueue.h b/src/uscxml/interpreter/EventQueue.h
new file mode 100644
index 0000000..4409b72
--- /dev/null
+++ b/src/uscxml/interpreter/EventQueue.h
@@ -0,0 +1,65 @@
+/**
+ * @file
+ * @author 2016 Stefan Radomski (stefan.radomski@cs.tu-darmstadt.de)
+ * @copyright Simplified BSD
+ *
+ * @cond
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the FreeBSD license as published by the FreeBSD
+ * project.
+ *
+ * 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.
+ *
+ * You should have received a copy of the FreeBSD license along with this
+ * program. If not, see <http://www.opensource.org/licenses/bsd-license>.
+ * @endcond
+ */
+
+#ifndef EVENTQUEUE_H_C5C41BEE
+#define EVENTQUEUE_H_C5C41BEE
+
+#include "uscxml/Common.h"
+#include "uscxml/messages/Event.h"
+
+namespace uscxml {
+
+class EventQueueImpl;
+class DelayedEventQueueImpl;
+
+/**
+ * @ingroup eventqueue
+ * @ingroup facade
+ */
+class USCXML_API EventQueue {
+public:
+ PIMPL_OPERATORS(EventQueue);
+
+ virtual Event dequeue(bool blocking);
+ virtual void enqueue(const Event& event);
+
+protected:
+ std::shared_ptr<EventQueueImpl> _impl;
+
+};
+
+/**
+ * @ingroup eventqueue
+ * @ingroup facade
+ */
+class USCXML_API DelayedEventQueue : public EventQueue {
+public:
+ PIMPL_OPERATORS_INHERIT(DelayedEventQueue, EventQueue);
+
+ void enqueueDelayed(const Event& event, size_t delayMs, const std::string& eventUUID);
+ void cancelDelayed(const std::string& eventUUID);
+ void cancelAllDelayed();
+
+protected:
+ std::shared_ptr<DelayedEventQueueImpl> _impl;
+};
+
+}
+
+#endif /* end of include guard: EVENTQUEUE_H_C5C41BEE */