chore: import upstream snapshot with attribution

2026-07-13 13:02:50 +08:00
commit 0fc60fdcb1
5008 changed files with 910633 additions and 0 deletions
@@ -0,0 +1,100 @@
+/*
+ * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
+ * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect 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.
+*/
+
+using System;
+using QuantConnect.Packets;
+using System.Collections.Generic;
+using System.ComponentModel.Composition;
+
+namespace QuantConnect.Interfaces
+{
+    /// <summary>
+    /// Provides object storage for data persistence.
+    /// </summary>
+    [InheritedExport(typeof(IObjectStore))]
+    public interface IObjectStore : IDisposable, IEnumerable<KeyValuePair<string, byte[]>>
+    {
+        /// <summary>
+        /// Gets the maximum storage limit in bytes
+        /// </summary>
+        long MaxSize { get; }
+
+        /// <summary>
+        /// Gets the maximum number of files allowed
+        /// </summary>
+        int MaxFiles { get; }
+
+        /// <summary>
+        /// Event raised each time there's an error
+        /// </summary>
+        event EventHandler<ObjectStoreErrorRaisedEventArgs> ErrorRaised;
+
+        /// <summary>
+        /// Initializes the object store
+        /// </summary>
+        /// <param name="userId">The user id</param>
+        /// <param name="projectId">The project id</param>
+        /// <param name="userToken">The user token</param>
+        /// <param name="controls">The job controls instance</param>
+        /// <param name="algorithmMode">The algorithm mode</param>
+        void Initialize(int userId, int projectId, string userToken, Controls controls, AlgorithmMode algorithmMode);
+
+        /// <summary>
+        /// Determines whether the store contains data for the specified path
+        /// </summary>
+        /// <param name="path">The object path</param>
+        /// <returns>True if the key was found</returns>
+        bool ContainsKey(string path);
+
+        /// <summary>
+        /// Returns the object data for the specified key
+        /// </summary>
+        /// <param name="path">The object key</param>
+        /// <returns>A byte array containing the data</returns>
+        byte[] ReadBytes(string path);
+
+        /// <summary>
+        /// Saves the object data for the specified path
+        /// </summary>
+        /// <param name="path">The object path</param>
+        /// <param name="contents">The object data</param>
+        /// <returns>True if the save operation was successful</returns>
+        bool SaveBytes(string path, byte[] contents);
+
+        /// <summary>
+        /// Deletes the object data for the specified path
+        /// </summary>
+        /// <param name="path">The object path</param>
+        /// <returns>True if the delete operation was successful</returns>
+        bool Delete(string path);
+
+        /// <summary>
+        /// Returns the file path for the specified path
+        /// </summary>
+        /// <param name="path">The object path</param>
+        /// <returns>The path for the file</returns>
+        string GetFilePath(string path);
+
+        /// <summary>
+        /// Returns the file paths present in the object store. This is specially useful not to load the object store into memory
+        /// </summary>
+        ICollection<string> Keys { get; }
+
+        /// <summary>
+        /// Will clear the object store state cache. This is useful when the object store is used concurrently by nodes which want to share information
+        /// </summary>
+        void Clear();
+    }
+}