Files
quantconnect--lean/Common/Interfaces/IJobQueueHandler.cs
T
2026-07-13 13:02:50 +08:00

46 lines
1.5 KiB
C#

/*
* 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.ComponentModel.Composition;
using QuantConnect.Packets;
namespace QuantConnect.Interfaces
{
/// <summary>
/// Task requestor interface with cloud system
/// </summary>
[InheritedExport(typeof(IJobQueueHandler))]
public interface IJobQueueHandler
{
/// <summary>
/// Initialize the internal state
/// </summary>
void Initialize(IApi api, IMessagingHandler messagingHandler);
/// <summary>
/// Request the next task to run through the engine:
/// </summary>
/// <returns>Algorithm job to process</returns>
AlgorithmNodePacket NextJob(out string algorithmPath);
/// <summary>
/// Signal task complete
/// </summary>
/// <param name="job">Work to do.</param>
void AcknowledgeJob(AlgorithmNodePacket job);
}
}