找回密码
 立即注册
首页 资源区 代码 mormot.core.threads--TBlockingProcess

mormot.core.threads--TBlockingProcess

炀餮氢 3 天前
mormot.core.threads--TBlockingProcess
  1. type
  2.   /// TBlockingProcess 实例的当前状态
  3.   TBlockingEvent = (
  4.     evNone,       // 无状态
  5.     evWaiting,    // 等待状态
  6.     evTimeOut,    // 超时状态
  7.     evRaised);    // 触发状态
  8.   {$M+} // 开启RTTI详细信息模式,用于调试
  9.   
  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;
  25.                        aSafe: PSynLocker
  26.                       );
  27.       reintroduce; overload; virtual;
  28.   
  29.     /// 初始化信号量实例
  30.     // - 指定阻塞执行应视为失败的超时毫秒数(如果设置为0,则使用默认值3000)
  31.     // - 将创建并拥有一个关联的互斥锁
  32.     constructor Create(aTimeOutMs: integer); reintroduce; overload; virtual;
  33.   
  34.     /// 销毁实例
  35.     destructor Destroy; override;
  36.   
  37.     /// 等待NotifyFinished()被调用或触发超时
  38.     // - 返回进程的最终状态,即evRaised或evTimeOut
  39.     function WaitFor: TBlockingEvent; reintroduce; overload; virtual;
  40.   
  41.     /// 等待NotifyFinished()被调用或指定超时时间后触发超时
  42.     // - 返回进程的最终状态,即evRaised或evTimeOut
  43.     function WaitFor(TimeOutMS: integer): TBlockingEvent; reintroduce; overload; virtual;
  44.   
  45.     /// 应在后台进程完成时调用
  46.     // - 调用者随后将允许其WaitFor方法返回
  47.     // - 如果成功(即状态不是evRaised或evTimeout),则返回TRUE
  48.     // - 如果实例已被锁定(例如,从TBlockingProcessPool.FromCallLocked检索时),您可以设置alreadyLocked=TRUE
  49.     function NotifyFinished(alreadyLocked: boolean = false): boolean; virtual;
  50.   
  51.     /// 重置内部事件状态为evNone的包装器
  52.     // - 在WaitFor/NotifyFinished过程成功后,可用于重用相同的TBlockingProcess实例
  53.     // - 如果成功(即状态不是evWaiting),则返回TRUE,并将当前状态设置为evNone,并将Call属性设置为0
  54.     // - 如果有WaitFor当前正在进行,则返回FALSE
  55.     function Reset: boolean; virtual;
  56.   
  57.     /// 围绕fSafe^.Lock的包装器
  58.     procedure Lock;
  59.   
  60.     /// 围绕fSafe^.Unlock的包装器
  61.     procedure Unlock;
  62.   published
  63.     /// 进程的当前状态
  64.     // - 在WaitFor过程后,使用Reset方法来重用此实例
  65.     property Event: TBlockingEvent
  66.       read fEvent;
  67.   
  68.     /// 构造函数中定义的超时周期(毫秒)
  69.     property TimeOutMs: integer
  70.       read fTimeOutMS;
  71.   end;
  72.   {$M-} // 关闭RTTI详细信息模式
  73.   /// 用于标识每个TBlockingProcessPool调用的类型
  74.   // - 允许匹配给定的TBlockingProcessPoolItem信号量
  75.   TBlockingProcessPoolCall = type integer;
  76.   /// 在TBlockingProcessPool中使用的信号量
  77.   // - 该信号量具有一个Call字段来标识每次执行
  78.   TBlockingProcessPoolItem = class(TBlockingProcess)
  79.   protected
  80.     fCall: TBlockingProcessPoolCall; // 调用标识符
  81.     procedure ResetInternal; override; // 重置内部状态
  82.   published
  83.     /// 当由TBlockingProcessPool拥有时的唯一标识符
  84.     // - Reset会将此字段恢复为其默认值0
  85.     property Call: TBlockingProcessPoolCall
  86.       read fCall;
  87.   end;
  88.   /// TBlockingProcess的类引用类型(元类)
  89.   TBlockingProcessPoolItemClass = class of TBlockingProcessPoolItem;
  90.   /// 管理TBlockingProcessPoolItem实例的池
  91.   // - 每个调用将通过唯一的TBlockingProcessPoolCall值进行标识
  92.   // - 用于模拟例如从异步事件驱动DDD进程中的阻塞执行
  93.   // - 它还允许重用TEvent系统资源
  94.   TBlockingProcessPool = class(TSynPersistent)
  95.   protected
  96.     fClass: TBlockingProcessPoolItemClass; // 池项类
  97.     fPool: TSynObjectListLightLocked;      // 池
  98.     fCallCounter: TBlockingProcessPoolCall; // 设置TBlockingProcessPoolItem.Call
  99.   public
  100.     /// 初始化池,对于给定的实现类
  101.     constructor Create(aClass: TBlockingProcessPoolItemClass = nil); reintroduce;
  102.   
  103.     /// 销毁池
  104.     // - 还将强制所有挂起的WaitFor触发evTimeOut
  105.     destructor Destroy; override;
  106.   
  107.     /// 从内部池中预订一个TBlockingProcess
  108.     // - 出错时返回nil(例如,实例正在销毁)
  109.     // - 或者返回与此调用相对应的阻塞进程实例;
  110.     // 其Call属性将标识异步回调的调用,然后在WaitFor之后,应运行Reset方法来释放池的互斥锁
  111.     function NewProcess(aTimeOutMs: integer): TBlockingProcessPoolItem; virtual;
  112.   
  113.     /// 从其调用标识符检索TBlockingProcess
  114.     // - 可用于例如从异步进程的回调中
  115.     // 设置继承自TBlockingProcess的一些附加参数,
  116.     // 然后调用NotifyFinished来释放调用者的WaitFor
  117.     // - 如果leavelocked为TRUE,则返回的实例将被锁定:调用者应在使用后执行result.Unlock或NotifyFinished(true)
  118.     function FromCall(call: TBlockingProcessPoolCall;
  119.       locked: boolean = false): TBlockingProcessPoolItem; virtual;
  120.   end;
复制代码
根据上述类定义编写的 TBlockingProcess和 TBlockingProcessPool的例程代码。请注意,由于这些类可能依赖于特定的库(如mORMot),以下示例将尽量保持通用性,并假设您已经有一个适当的环境来运行这些代码。
TBlockingProcess 例程代码
  1. uses
  2.   SysUtils, Classes, // 引入SysUtils和Classes单元以使用WriteLn和TSynLocker等
  3.   // 假设YourSynapseUnit包含了TSynLocker和TBlockingProcess的定义
  4.   mormot.core.os,
  5.   mormot.core.thread;
  6. var
  7.   Process: TBlockingProcess;
  8.   EventState: TBlockingEvent;
  9.   Safe: TSynLocker;
  10. begin
  11.   try
  12.     // 创建一个同步锁
  13.     Safe := TSynLocker.Create;
  14.     try
  15.       // 创建一个TBlockingProcess实例,超时设置为5000毫秒,并传递同步锁
  16.       Process := TBlockingProcess.Create(5000, @Safe);
  17.       try
  18.         // 模拟异步操作,这里我们直接调用WaitFor来阻塞当前线程
  19.         EventState := Process.WaitFor;
  20.         case EventState of
  21.           evNone: WriteLn('Process state is evNone (should not happen)');
  22.           evWaiting: WriteLn('Process state is evWaiting (should not happen during WaitFor)');
  23.           evTimeOut: WriteLn('Process timed out');
  24.           evRaised: WriteLn('Process was notified successfully');
  25.         end;
  26.         // 在实际应用中,这里可能是另一个线程调用NotifyFinished来释放WaitFor
  27.         // 但为了演示,我们直接调用NotifyFinished(尽管这在实际应用中可能是不必要的)
  28.         if Process.NotifyFinished then
  29.           WriteLn('NotifyFinished called successfully (for demonstration purposes only)');
  30.         // 重置TBlockingProcess实例以供重用(如果需要的话)
  31.         // 在这个例子中,我们不会重用它,但展示如何调用Reset
  32.         if Process.Reset then
  33.           WriteLn('Process reset successfully');
  34.       finally
  35.         // 销毁TBlockingProcess实例
  36.         Process.Free;
  37.       end;
  38.     finally
  39.       // 销毁同步锁
  40.       Safe.Free;
  41.     end;
  42.   except
  43.     on E: Exception do
  44.       WriteLn('Error: ' + E.Message);
  45.   end;
  46. end.
复制代码
注意:在上面的示例中,NotifyFinished的调用可能是不必要的,因为在实际应用中,它通常是由另一个线程在异步操作完成时调用的。此外,Reset的调用也取决于您是否需要重用 TBlockingProcess实例。
TBlockingProcessPool 例程代码
  1. uses
  2.   SysUtils, Classes, // 引入SysUtils和Classes单元
  3.   // 假设YourSynapseUnit包含了TBlockingProcessPool及其相关类的定义
  4.   YourSynapseUnit;
  5. procedure SimulateAsyncCallback(Call: TBlockingProcessPoolCall);
  6. var
  7.   Process: TBlockingProcessPoolItem;
  8. begin
  9.   // 从池中检索与调用标识符匹配的TBlockingProcessPoolItem
  10.   Process := TBlockingProcessPool(Owner).FromCall(Call, True); // 假设Owner是TBlockingProcessPool的引用
  11.   try
  12.     // 在这里模拟异步操作的完成
  13.     // ...
  14.     // 通知等待的进程,异步操作已完成
  15.     Process.NotifyFinished(True); // 由于我们之前已经锁定了Process,所以这里传递True
  16.   finally
  17.     // 如果我们之前没有调用NotifyFinished(True),则需要在这里解锁
  18.     // 但在这个例子中,我们调用了NotifyFinished(True),所以不需要再次解锁
  19.     // Process.Unlock; // 这行是注释掉的,因为不需要在这里解锁
  20.   end;
  21. end;
  22. var
  23.   Pool: TBlockingProcessPool;
  24.   Process: TBlockingProcessPoolItem;
  25.   Call: TBlockingProcessPoolCall;
  26. begin
  27.   try
  28.     // 创建一个TBlockingProcessPool实例
  29.     Pool := TBlockingProcessPool.Create(TBlockingProcessPoolItem);
  30.     try
  31.       // 从池中预订一个新的TBlockingProcessPoolItem
  32.       Process := Pool.NewProcess(5000);
  33.       if Assigned(Process) then
  34.       begin
  35.         // 获取调用标识符(在这个例子中,我们可能不需要直接使用它,但它对于回调是必需的)
  36.         Call := Process.Call;
  37.         // 在这里,您可能会启动一个异步操作,并在其回调中调用SimulateAsyncCallback
  38.         // 但为了演示,我们直接调用SimulateAsyncCallback(尽管这在实际应用中可能是不必要的)
  39.         SimulateAsyncCallback(Call);
  40.         // 注意:在实际应用中,您不会在这里立即调用SimulateAsyncCallback,
  41.         // 因为异步操作将在另一个线程或事件处理器中完成。
  42.         // 在这里,我们只是模拟了异步回调的行为。
  43.         // 由于我们直接模拟了回调,因此不需要再次调用WaitFor。
  44.         // 在实际应用中,您将在启动异步操作后调用Process.WaitFor来等待其完成。
  45.         // 重置TBlockingProcessPoolItem以供重用(如果需要的话)
  46.         // 注意:在大多数情况下,您可能不需要在池中重用项,因为池会管理它们。
  47.         // 但如果您确实需要重置它(例如,在异常情况下),您应该小心处理锁定。
  48.         // 在这个例子中,我们不会重置它,因为池会处理它。
  49.       end;
  50.     finally
  51.       // 销毁TBlockingProcessPool实例
  52.       // 注意:在销毁池时,所有挂起的WaitFor调用都将被强制超时。
  53.       Pool.Free;
  54.     end;
  55.   except
  56.     on E: Exception do
  57.       WriteLn('Error: ' + E.Message);
  58.   end;
  59. end.
复制代码
注意:在上面的 TBlockingProcessPool示例中,SimulateAsyncCallback过程模拟了异步操作的回调。然而,在实际应用中,回调将由异步操作本身(例如,在另一个线程或事件处理器中)触发,而不是由您直接调用。此外,请注意 Owner的假设,它在这个例子中并未定义,但在实际应用中,您可能需要以某种方式访问 TBlockingProcessPool的实例,以便从回调中检索 TBlockingProcessPoolItem。这通常通过传递池实例的引用或将其存储在可从回调访问的全局/静态变量中来实现。

来源:程序园用户自行投稿发布,如果侵权,请联系站长删除
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!
您需要登录后才可以回帖 登录 | 立即注册