mirror of
https://gitee.com/langsisi_admin/serein-flow
synced 2026-04-12 10:56:34 +08:00
修改了自述文件
This commit is contained in:
20
README.md
20
README.md
@@ -22,19 +22,21 @@ https://space.bilibili.com/33526379
|
||||
|
||||
## 1. 不生成节点控件的枚举值:
|
||||
* **Init - 初始化方法**
|
||||
* 入参:**DynamicContext**(有且只有一个参数)。
|
||||
* 入参:**IDynamicContext**(有且只有一个参数)。
|
||||
* 返回值:自定义,但软件目前不支持接收返回值。
|
||||
* 描述:在运行时首先被调用。语义类似于构造方法。建议在Init方法内初始化类、注册类等一切需要在构造函数中执行的方法。
|
||||
|
||||
* **Loading - 加载方法**
|
||||
* 入参:**DynamicContext**(有且只有一个参数)。
|
||||
* 入参:**IDynamicContext**(有且只有一个参数)。
|
||||
* 返回值:自定义,但软件目前不支持接收返回值。
|
||||
* 描述:当所有Dll的Init方法调用完成后,首先调用、也才会调用DLL的Loading方法。建议在Loading方法内进行业务上的初始化(例如启动Web,启动第三方服务)。
|
||||
|
||||
* **Exit - 结束方法**
|
||||
* 入参:**DynamicContext**(有且只有一个参数)。
|
||||
* 入参:**IDynamicContext**(有且只有一个参数)。
|
||||
* 返回值:自定义,但软件目前不支持接收返回值。
|
||||
* 描述:当结束/手动结束运行时,会调用所有Dll的Exit方法。使用场景类似于:终止内部的其它线程,通知其它进程关闭,例如停止第三方服务。
|
||||
* **关于IDynamicContext说明**
|
||||
* 基本说明:IDynamicContext是动态上下文接口,内部提供用以注册、获取实例的IOC容器SereinIoc接口,以及运行环境IFlowEnvironment接口,一般情况下,你无须关注IFlowEnvironment对外暴露的属性方法。除此之外,还有一个用以创建定时循环任务的方法CreateTimingTask,通过该方法可以实现类似于定时器的功能,它的运行周期收到运行环境管理。
|
||||
|
||||
## 2. 基础节点
|
||||
* 待更新
|
||||
@@ -48,15 +50,17 @@ https://space.bilibili.com/33526379
|
||||
* **Flipflop - 触发器**
|
||||
* 全局触发器
|
||||
* 入参:依照Action节点。
|
||||
* 返回值:Task<FlipflopContext>
|
||||
* 返回值:Task<IFlipflopContext>
|
||||
* 描述:运行开始时,所有无上级节点的触发器节点(在当前分支中作为起始节点),分别建立新的线程运行,然后异步等待触发(如果有)。这种触发器拥有独自的DynamicContext上下文(共用同一个Ioc),执行完成之后,会重新从分支起点的触发器开始等待。
|
||||
* 分支中的触发器
|
||||
* 入参:依照Action节点。
|
||||
* 返回值:Task<FlipflopContext>
|
||||
* 返回值:Task<IFlipflopContext>
|
||||
* 描述:接收上一节点传递的上下文,同样进入异步等待,但执行完成后不会再次等待自身(只会触发一次)。
|
||||
* FlipflopContext
|
||||
* 描述:内部有一套枚举描述,Succeed、Cancel,如果返回Succeed,会通过所有下级节点集合创建Task集合,然后调用WaitAll()进行等待(每个Task会新建新的DynamicContext上下文(共用同一个Ioc))。如果返回Cancel,则什么也不做。
|
||||
* 使用场景:配合TcsSignal<TEnum>使用,定时从PLC中获取状态,当某个变量发生改变时,会通知持有TaskCompletionSource的触发器,如果需要,可以传递对应的数据。
|
||||
* IFlipflopContext
|
||||
* 基本说明:IFlipflopContext是一个接口,你无须关心内部实现。
|
||||
* 参数描述:State,状态枚举描述(Succeed、Cancel、Error、Cancel),如果返回Cancel,则不会执行后继分支,如果返回其它状态,则会获取对应的后继分支,开始执行。
|
||||
* 参数描述:TriggerData,内部分别有状态描述、触发的参数。触发状态有两种(External外部触发,Overtime超时触发),当你在代码中的其他地方主动触发了触发器,则该次触发类型为External,当你在创建触发器后超过了指定时间(创建触发器时会要求声明超时时间),则会自动触发,但触发类型为Overtime,触发参数未你在创建触发器时指定的值)
|
||||
* 使用场景:配合ChannelFlowTrigger<TEnum>使用,定时从PLC中获取状态,当某个变量发生改变时,会通知持有 Channel<TriggerData>的触发器,如果需要,可以传递对应的数据。
|
||||
演示:
|
||||

|
||||

|
||||
|
||||
Reference in New Issue
Block a user