First commit of MeshAgent for MeshCentral

microstack/ILibSimpleDataStore.h

@@ -0,0 +1,76 @@
+/*
+Copyright 2006 - 2017 Intel Corporation
+
+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.
+*/
+
+/*
+This is a simple data store that implements a hash table in a file. New keys are appended at the end of the file and the file can be compacted when needed.
+The store will automatically create a hash of each value and store the hash. Upon reading the data, the hash is always checked.
+*/
+
+#ifndef __ILIBSIMPLEDATASTORE__
+#define __ILIBSIMPLEDATASTORE__
+
+#include "ILibParsers.h"
+
+#if defined(WIN32) && defined(EXPORT_LIB)
+#define __EXPORT_TYPE __declspec(dllexport)
+#else
+#define __EXPORT_TYPE 
+#endif
+
+#define ILibSimpleDataStore_MaxKeyLength 1024
+#define ILibSimpleDataStore_MaxUnspecifiedValueLen 16384
+#define ILibSimpleDataStore_MaxFilePath 4096
+
+typedef void* ILibSimpleDataStore;
+
+const extern int ILibMemory_SimpleDataStore_CONTAINERSIZE;
+
+typedef void(*ILibSimpleDataStore_KeyEnumerationHandler)(ILibSimpleDataStore sender, char* Key, int KeyLen, void *user);
+
+// Create the data store.
+__EXPORT_TYPE ILibSimpleDataStore ILibSimpleDataStore_CreateEx(char* filePath, int userExtraMemorySize);
+#define ILibSimpleDataStore_Create(filePath) ILibSimpleDataStore_CreateEx(filePath, 0)
+
+// Close the data store.
+__EXPORT_TYPE void ILibSimpleDataStore_Close(ILibSimpleDataStore dataStore);
+
+
+__EXPORT_TYPE int ILibSimpleDataStore_PutEx(ILibSimpleDataStore dataStore, char* key, int keyLen, char* value, int valueLen);
+#define ILibSimpleDataStore_Put(dataStore, key, value) ILibSimpleDataStore_PutEx(dataStore, key, (int)strnlen_s(key, ILibSimpleDataStore_MaxKeyLength), value, (int)strnlen_s(value, ILibSimpleDataStore_MaxUnspecifiedValueLen))
+
+// Get a value from the datastore of given a key.
+__EXPORT_TYPE int ILibSimpleDataStore_GetEx(ILibSimpleDataStore dataStore, char* key, int keyLen, char* buffer, int bufferLen);
+#define ILibSimpleDataStore_Get(dataStore, key, buffer, bufferLen) ILibSimpleDataStore_GetEx(dataStore, key, (int)strnlen_s(key, ILibSimpleDataStore_MaxKeyLength), buffer, bufferLen)
+
+// Get the SHA256 hash value from the datastore for a given a key.
+__EXPORT_TYPE char* ILibSimpleDataStore_GetHashEx(ILibSimpleDataStore dataStore, char* key, int keyLen);
+#define ILibSimpleDataStore_GetHash(dataStore, key) ILibSimpleDataStore_GetHashEx(dataStore, key, (int)strnlen_s(key, ILibSimpleDataStore_MaxKeyLength))
+
+// Delete a key from the data store
+__EXPORT_TYPE int ILibSimpleDataStore_DeleteEx(ILibSimpleDataStore dataStore, char* key, int keyLen);
+#define ILibSimpleDataStore_Delete(dataStore, key) ILibSimpleDataStore_DeleteEx(dataStore, key, (int)strnlen_s(key, ILibSimpleDataStore_MaxKeyLength))
+
+// Enumerate all keys from the data store
+__EXPORT_TYPE void ILibSimpleDataStore_EnumerateKeys(ILibSimpleDataStore dataStore, ILibSimpleDataStore_KeyEnumerationHandler handler, void *user);
+
+// Compacts the data store
+__EXPORT_TYPE int ILibSimpleDataStore_Compact(ILibSimpleDataStore dataStore);
+
+// Lock and unlock the data store. This is useful if we need to access this store from many threads.
+__EXPORT_TYPE void ILibSimpleDataStore_Lock(ILibSimpleDataStore dataStore);
+__EXPORT_TYPE void ILibSimpleDataStore_UnLock(ILibSimpleDataStore dataStore);
+
+#endif