[common] clipboard: define streamed clipboard ABIs

idd/LGCommon/CClipboardRing.h

@@ -0,0 +1,40 @@
+/**
+ * Looking Glass
+ * Copyright © 2017-2026 The Looking Glass Authors
+ * https://looking-glass.io
+ *
+ * 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 2 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, write to the Free Software Foundation, Inc., 59
+ * Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+#pragma once
+
+#include "ClipboardRing.h"
+
+class CClipboardRing
+{
+public:
+  static void Initialize(ClipboardMapping& mapping, uint64_t epoch);
+  static bool Valid(const ClipboardMapping& mapping, uint64_t epoch);
+
+  static ClipboardRingSlot * BeginWrite(
+    ClipboardRing& ring, uint32_t& ticket);
+  static bool EndWrite(ClipboardRing& ring, uint32_t ticket);
+
+  static const ClipboardRingSlot * BeginRead(
+    ClipboardRing& ring, uint32_t& ticket);
+  static bool EndRead(ClipboardRing& ring, uint32_t ticket);
+
+  static bool Valid(const ClipboardRingSlot& slot);
+};