mormot.core.threads--TBlockingProcess

mormot.core.threads--TBlockingProcess

1. type
2.   /// TBlockingProcess 实例的当前状态
3.   TBlockingEvent = (
4.     evNone,       // 无状态
5.     evWaiting,    // 等待状态
6.     evTimeOut,    // 超时状态
7.     evRaised);    // 触发状态
9.   {$M+} // 开启内存管理消息，用于调试
10.   /// 用于等待某个进程完成的信号量
11.   // - 例如，在mormot.rest.server.pas中的TBlockingCallback使用
12.   // - 一旦创建，进程将通过WaitFor调用阻塞，当后台线程调用NotifyFinished时释放
13.   TBlockingProcess = class(TSynEvent)
14.   protected
15.     fTimeOutMs: integer;       // 超时毫秒数
16.     fEvent: TBlockingEvent;    // 当前事件状态
17.     fOwnedSafe: boolean;       // 是否拥有同步锁
18.     fSafe: PSynLocker;         // 同步锁指针
19.     procedure ResetInternal; virtual; // 重置关联参数（可重写）
20.   public
21.     /// 初始化信号量实例
22.     // - 指定阻塞执行应视为失败的超时毫秒数（如果设置为0，则使用默认值3000）
23.     // - 应提供一个关联的互斥锁
24.     constructor Create(aTimeOutMs: integer; aSafe: PSynLocker);
25.       reintroduce; overload; virtual;
26.     /// 初始化信号量实例
27.     // - 指定阻塞执行应视为失败的超时毫秒数（如果设置为0，则使用默认值3000）
28.     // - 将创建并拥有一个关联的互斥锁
29.     constructor Create(aTimeOutMs: integer); reintroduce; overload; virtual;
30.     /// 销毁实例
31.     destructor Destroy; override;
32.     /// 等待NotifyFinished()被调用或触发超时
33.     // - 返回进程的最终状态，即evRaised或evTimeOut
34.     function WaitFor: TBlockingEvent; reintroduce; overload; virtual;
35.     /// 等待NotifyFinished()被调用或指定超时时间后触发超时
36.     // - 返回进程的最终状态，即evRaised或evTimeOut
37.     function WaitFor(TimeOutMS: integer): TBlockingEvent; reintroduce; overload; virtual;
38.     /// 应在后台进程完成时调用
39.     // - 调用者随后将允许其WaitFor方法返回
40.     // - 如果成功（即状态不是evRaised或evTimeout），则返回TRUE
41.     // - 如果实例已被锁定（例如，从TBlockingProcessPool.FromCallLocked检索时），您可以设置alreadyLocked=TRUE
42.     function NotifyFinished(alreadyLocked: boolean = false): boolean; virtual;
43.     /// 重置内部事件状态为evNone的包装器
44.     // - 在WaitFor/NotifyFinished过程成功后，可用于重用相同的TBlockingProcess实例
45.     // - 如果成功（即状态不是evWaiting），则返回TRUE，并将当前状态设置为evNone，并将Call属性设置为0
46.     // - 如果有WaitFor当前正在进行，则返回FALSE
47.     function Reset: boolean; virtual;
48.     /// 围绕fSafe^.Lock的包装器
49.     procedure Lock;
50.     /// 围绕fSafe^.Unlock的包装器
51.     procedure Unlock;
52.   published
53.     /// 进程的当前状态
54.     // - 在WaitFor过程后，使用Reset方法来重用此实例
55.     property Event: TBlockingEvent
56.       read fEvent;
57.     /// 构造函数中定义的超时周期（毫秒）
58.     property TimeOutMs: integer
59.       read fTimeOutMS;
60.   end;
61.   {$M-} // 关闭内存管理消息
63.   /// 用于标识每个TBlockingProcessPool调用的类型
64.   // - 允许匹配给定的TBlockingProcessPoolItem信号量
65.   TBlockingProcessPoolCall = type integer;
67.   /// 在TBlockingProcessPool中使用的信号量
68.   // - 该信号量具有一个Call字段来标识每次执行
69.   TBlockingProcessPoolItem = class(TBlockingProcess)
70.   protected
71.     fCall: TBlockingProcessPoolCall; // 调用标识符
72.     procedure ResetInternal; override; // 重置内部状态
73.   published
74.     /// 当由TBlockingProcessPool拥有时的唯一标识符
75.     // - Reset会将此字段恢复为其默认值0
76.     property Call: TBlockingProcessPoolCall
77.       read fCall;
78.   end;
80.   /// TBlockingProcess的类引用类型（元类）
81.   TBlockingProcessPoolItemClass = class of TBlockingProcessPoolItem;
83.   /// 管理TBlockingProcessPoolItem实例的池
84.   // - 每个调用将通过唯一的TBlockingProcessPoolCall值进行标识
85.   // - 用于模拟例如从异步事件驱动DDD进程中的阻塞执行
86.   // - 它还允许重用TEvent系统资源
87.   TBlockingProcessPool = class(TSynPersistent)
88.   protected
89.     fClass: TBlockingProcessPoolItemClass; // 池项类
90.     fPool: TSynObjectListLightLocked;      // 池
91.     fCallCounter: TBlockingProcessPoolCall; // 设置TBlockingProcessPoolItem.Call
92.   public
93.     /// 初始化池，对于给定的实现类
94.     constructor Create(aClass: TBlockingProcessPoolItemClass = nil); reintroduce;
95.     /// 销毁池
96.     // - 还将强制所有挂起的WaitFor触发evTimeOut
97.     destructor Destroy; override;
98.     /// 从内部池中预订一个TBlockingProcess
99.     // - 出错时返回nil（例如，实例正在销毁）
100.     // - 或者返回与此调用相对应的阻塞进程实例；
101.     // 其Call属性将标识异步回调的调用，然后在WaitFor之后，应运行Reset方法来释放池的互斥锁
102.     function NewProcess(aTimeOutMs: integer): TBlockingProcessPoolItem; virtual;
103.     /// 从其调用标识符检索TBlockingProcess
104.     // - 可用于例如从异步进程的回调中
105.     // 设置继承自TBlockingProcess的一些附加参数，
106.     // 然后调用NotifyFinished来释放调用者的WaitFor
107.     // - 如果leavelocked为TRUE，则返回的实例将被锁定：调用者应在使用后执行result.Unlock或NotifyFinished(true)
108.     function FromCall(call: TBlockingProcessPoolCall;
109.       locked: boolean = false): TBlockingProcessPoolItem; virtual;
110.   end;

复制代码

根据上述类定义编写的 TBlockingProcess和 TBlockingProcessPool的例程代码。请留意，由于这些类可能依靠于特定的库（如mORMot），以下示例将尽量保持通用性，并假设您已经有一个适当的环境来运行这些代码。
TBlockingProcess 例程代码

1. uses
2.   SysUtils, Classes, // 引入SysUtils和Classes单元以使用WriteLn和TSynLocker等
3.   // 假设YourSynapseUnit包含了TSynLocker和TBlockingProcess的定义
4.   YourSynapseUnit;
6. var
7.   Process: TBlockingProcess;
8.   EventState: TBlockingEvent;
9.   Safe: TSynLocker;
11. begin
12.   try
13.     // 创建一个同步锁
14.     Safe := TSynLocker.Create;
15.     try
16.       // 创建一个TBlockingProcess实例，超时设置为5000毫秒，并传递同步锁
17.       Process := TBlockingProcess.Create(5000, @Safe);
18.       try
19.         // 模拟异步操作，这里我们直接调用WaitFor来阻塞当前线程
20.         EventState := Process.WaitFor;
21.         case EventState of
22.           evNone: WriteLn('Process state is evNone (should not happen)');
23.           evWaiting: WriteLn('Process state is evWaiting (should not happen during WaitFor)');
24.           evTimeOut: WriteLn('Process timed out');
25.           evRaised: WriteLn('Process was notified successfully');
26.         end;
28.         // 在实际应用中，这里可能是另一个线程调用NotifyFinished来释放WaitFor
29.         // 但为了演示，我们直接调用NotifyFinished（尽管这在实际应用中可能是不必要的）
30.         if Process.NotifyFinished then
31.           WriteLn('NotifyFinished called successfully (for demonstration purposes only)');
33.         // 重置TBlockingProcess实例以供重用（如果需要的话）
34.         // 在这个例子中，我们不会重用它，但展示如何调用Reset
35.         if Process.Reset then
36.           WriteLn('Process reset successfully');
38.       finally
39.         // 销毁TBlockingProcess实例
40.         Process.Free;
41.       end;
42.     finally
43.       // 销毁同步锁
44.       Safe.Free;
45.     end;
46.   except
47.     on E: Exception do
48.       WriteLn('Error: ' + E.Message);
49.   end;
50. end.

复制代码

留意：在上面的示例中，NotifyFinished的调用可能是不必要的，由于在实际应用中，它通常是由另一个线程在异步操作完成时调用的。此外，Reset的调用也取决于您是否需要重用 TBlockingProcess实例。
TBlockingProcessPool 例程代码

1. uses
2.   SysUtils, Classes, // 引入SysUtils和Classes单元
3.   // 假设YourSynapseUnit包含了TBlockingProcessPool及其相关类的定义
4.   YourSynapseUnit;
6. procedure SimulateAsyncCallback(Call: TBlockingProcessPoolCall);
7. var
8.   Process: TBlockingProcessPoolItem;
9. begin
10.   // 从池中检索与调用标识符匹配的TBlockingProcessPoolItem
11.   Process := TBlockingProcessPool(Owner).FromCall(Call, True); // 假设Owner是TBlockingProcessPool的引用
12.   try
13.     // 在这里模拟异步操作的完成
14.     // ...
16.     // 通知等待的进程，异步操作已完成
17.     Process.NotifyFinished(True); // 由于我们之前已经锁定了Process，所以这里传递True
18.   finally
19.     // 如果我们之前没有调用NotifyFinished(True)，则需要在这里解锁
20.     // 但在这个例子中，我们调用了NotifyFinished(True)，所以不需要再次解锁
21.     // Process.Unlock; // 这行是注释掉的，因为不需要在这里解锁
22.   end;
23. end;
25. var
26.   Pool: TBlockingProcessPool;
27.   Process: TBlockingProcessPoolItem;
28.   Call: TBlockingProcessPoolCall;
30. begin
31.   try
32.     // 创建一个TBlockingProcessPool实例
33.     Pool := TBlockingProcessPool.Create(TBlockingProcessPoolItem);
34.     try
35.       // 从池中预订一个新的TBlockingProcessPoolItem
36.       Process := Pool.NewProcess(5000);
37.       if Assigned(Process) then
38.       begin
39.         // 获取调用标识符（在这个例子中，我们可能不需要直接使用它，但它对于回调是必需的）
40.         Call := Process.Call;
42.         // 在这里，您可能会启动一个异步操作，并在其回调中调用SimulateAsyncCallback
43.         // 但为了演示，我们直接调用SimulateAsyncCallback（尽管这在实际应用中可能是不必要的）
44.         SimulateAsyncCallback(Call);
46.         // 注意：在实际应用中，您不会在这里立即调用SimulateAsyncCallback，
47.         // 因为异步操作将在另一个线程或事件处理器中完成。
48.         // 在这里，我们只是模拟了异步回调的行为。
50.         // 由于我们直接模拟了回调，因此不需要再次调用WaitFor。
51.         // 在实际应用中，您将在启动异步操作后调用Process.WaitFor来等待其完成。
53.         // 重置TBlockingProcessPoolItem以供重用（如果需要的话）
54.         // 注意：在大多数情况下，您可能不需要在池中重用项，因为池会管理它们。
55.         // 但如果您确实需要重置它（例如，在异常情况下），您应该小心处理锁定。
56.         // 在这个例子中，我们不会重置它，因为池会处理它。
58.       end;
59.     finally
60.       // 销毁TBlockingProcessPool实例
61.       // 注意：在销毁池时，所有挂起的WaitFor调用都将被强制超时。
62.       Pool.Free;
63.     end;
64.   except
65.     on E: Exception do
66.       WriteLn('Error: ' + E.Message);
67.   end;
68. end.

复制代码

留意：在上面的 TBlockingProcessPool示例中，SimulateAsyncCallback过程模拟了异步操作的回调。然而，在实际应用中，回调将由异步操作本身（例如，在另一个线程或事件处置处罚器中）触发，而不是由您直接调用。此外，请留意 Owner的假设，它在这个例子中并未定义，但在实际应用中，您可能需要以某种方式访问 TBlockingProcessPool的实例，以便从回调中检索 TBlockingProcessPoolItem。这通常通过传递池实例的引用或将其存储在可从回调访问的全局/静态变量中来实现。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。