Milestone 5: deliver embedded RDP sessions and lifecycle hardening

third_party/FreeRDP/include/freerdp/cache/persistent.h

@@ -0,0 +1,109 @@
+/**
+ * FreeRDP: A Remote Desktop Protocol Implementation
+ * Persistent Bitmap Cache
+ *
+ * Copyright 2016 Marc-Andre Moreau <marcandre.moreau@gmail.com>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef FREERDP_PERSISTENT_CACHE_H
+#define FREERDP_PERSISTENT_CACHE_H
+
+#include <freerdp/api.h>
+#include <freerdp/types.h>
+#include <freerdp/update.h>
+
+#include <winpr/crt.h>
+#include <winpr/stream.h>
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+	typedef struct rdp_persistent_cache rdpPersistentCache;
+
+#pragma pack(push, 1)
+
+/* 12 bytes */
+
+	typedef struct
+	{
+		BYTE sig[8];
+		UINT32 flags; /* 0x00000003, 0x00000006 */
+	} PERSISTENT_CACHE_HEADER_V3;
+
+/* 12 bytes */
+
+	typedef struct
+	{
+		UINT64 key64;
+		UINT16 width;
+		UINT16 height;
+	} PERSISTENT_CACHE_ENTRY_V3;
+
+/* 20 bytes */
+
+	typedef struct
+	{
+		UINT64 key64;
+		UINT16 width;
+		UINT16 height;
+		UINT32 size;
+		UINT32 flags; /* 0x00000011 */
+	} PERSISTENT_CACHE_ENTRY_V2;
+
+#pragma pack(pop)
+
+	typedef struct
+	{
+		UINT64 key64;
+		UINT16 width;
+		UINT16 height;
+		UINT32 size;
+		UINT32 flags;
+		BYTE* data;
+	} PERSISTENT_CACHE_ENTRY;
+
+	WINPR_ATTR_NODISCARD
+	FREERDP_API int persistent_cache_get_version(rdpPersistentCache* persistent);
+
+	WINPR_ATTR_NODISCARD
+	FREERDP_API int persistent_cache_get_count(rdpPersistentCache* persistent);
+
+	WINPR_ATTR_NODISCARD
+	FREERDP_API int persistent_cache_read_entry(rdpPersistentCache* persistent,
+	                                            PERSISTENT_CACHE_ENTRY* entry);
+
+	WINPR_ATTR_NODISCARD
+	FREERDP_API int persistent_cache_write_entry(rdpPersistentCache* persistent,
+	                                             const PERSISTENT_CACHE_ENTRY* entry);
+
+	WINPR_ATTR_NODISCARD
+	FREERDP_API int persistent_cache_open(rdpPersistentCache* persistent, const char* filename,
+	                                      BOOL write, UINT32 version);
+
+	FREERDP_API int persistent_cache_close(rdpPersistentCache* persistent);
+
+	FREERDP_API void persistent_cache_free(rdpPersistentCache* persistent);
+
+	WINPR_ATTR_MALLOC(persistent_cache_free, 1)
+	WINPR_ATTR_NODISCARD
+	FREERDP_API rdpPersistentCache* persistent_cache_new(void);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* FREERDP_PERSISTENT_CACHE_H */