summaryrefslogtreecommitdiffstats
path: root/xbmc/peripherals/EventLockHandle.h
diff options
context:
space:
mode:
Diffstat (limited to 'xbmc/peripherals/EventLockHandle.h')
-rw-r--r--xbmc/peripherals/EventLockHandle.h48
1 files changed, 48 insertions, 0 deletions
diff --git a/xbmc/peripherals/EventLockHandle.h b/xbmc/peripherals/EventLockHandle.h
new file mode 100644
index 0000000..7012ea8
--- /dev/null
+++ b/xbmc/peripherals/EventLockHandle.h
@@ -0,0 +1,48 @@
+/*
+ * Copyright (C) 2018 Team Kodi
+ * This file is part of Kodi - https://kodi.tv
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ * See LICENSES/README.md for more information.
+ */
+
+#pragma once
+
+namespace PERIPHERALS
+{
+class CEventLockHandle;
+
+/*!
+ * \brief Callback implemented by event scanner
+ */
+class IEventLockCallback
+{
+public:
+ virtual ~IEventLockCallback(void) = default;
+
+ virtual void ReleaseLock(CEventLockHandle& handle) = 0;
+};
+
+/*!
+ * \brief Handle returned by the event scanner to disable event processing
+ *
+ * When held, this disables event processing.
+ */
+class CEventLockHandle
+{
+public:
+ /*!
+ * \brief Create an event lock handle
+ */
+ CEventLockHandle(IEventLockCallback& callback);
+
+ /*!
+ * \brief Handle is automatically released when this class is destructed
+ */
+ ~CEventLockHandle(void);
+
+private:
+ // Construction parameters
+ IEventLockCallback& m_callback;
+};
+} // namespace PERIPHERALS