Trait Plugin

Source

pub trait Plugin:
    Any
    + Send
    + Sync {
Show 13 methods    // Required methods
    fn name(&self) -> &str;
    fn on_mail(&self, event: &Event);

    // Provided methods
    fn kind(&self) -> &str { ... }
    fn deps(&self) -> &[&str] { ... }
    fn routes(&self) -> Vec<Cow<'static, str>> { ... }
    fn mailbox_soft_cap(&self) -> u64 { ... }
    fn version(&self) -> Cow<'static, str> { ... }
    fn as_any(&self) -> Option<&dyn Any> { ... }
    fn as_configurable(&self) -> Option<&dyn Configurable> { ... }
    fn services(&self) -> Vec<ServiceDesc> { ... }
    fn on_init(&self, _ctx: &PluginContext) { ... }
    fn on_start(&self) { ... }
    fn on_stop(&self) { ... }
}

Required Methods§

Source

fn name(&self) -> &str

注册键(D2 校验)。

Source

fn on_mail(&self, event: &Event)

★ 唯一业务入口:永远在本插件 worker 线程上串行执行。广播事件、寻址请求(eReq.<本名>)、定向通知(eTo.<本名>)都从这里进。

Provided Methods§

Source

fn kind(&self) -> &str

模块名(0.5.5,「插件界面 = 一模块一菜单」波)。

语义分工:

name() = 实例名,唯一,如 ctp_278153(派生网关名);
kind() = 模块名,同一模块的多个实例必须相同,如 ctp。

界面层按 kind() 归组:一个模块一个菜单项、一扇窗,该模块的所有实例交给那扇窗自己呈现(表格 / tab / 分栏由模块决定)。缺省 = name(),即单实例插件 (dm/oms/…)零改动仍是“自己一类“;多实例插件(ctp/tq)覆写成固定模块名。

⚠ 纯/静态/无锁(与 Self::services 同纪律:宿主会在渲染线程上调用)。

Source

fn deps(&self) -> &[&str]

D1 显式依赖清单(宿主注册期校验存在性,start 期拓扑排序)。

Source

fn routes(&self) -> Vec<Cow<'static, str>>

订阅的 type 集合:广播 type(如业务常量 “eTick.”)、自身的寻址 type(e_req_type(本名)/e_to_type(本名))。宿主 start() 装配 forwarder → 邮箱 → on_mail。

Source

fn mailbox_soft_cap(&self) -> u64

邮箱软顶覆写(D5 改案:缺省 MAILBOX_SOFT_CAP,按插件可大可小)。

语义是软顶(到顶才丢),不是容量(到顶必丢):默认无界不丢。给小是为了让某个插件在洪峰下更早显形,不是为了省内存。

Source

fn version(&self) -> Cow<'static, str>

插件版本(约定填 crate 版本)。默认空串 = 「未知版本」。

⚠ 陷阱(审核 F6):默认实现无法用 env!(CARGO_PKG_VERSION) —— 该宏在 ek-core 定义处展开,填出的是 ek-core 的版本。插件侧必须显式覆写:

fn version(&self) -> Cow<'static, str> {
    Cow::Borrowed(env!("CARGO_PKG_VERSION"))
}

Source

fn as_any(&self) -> Option<&dyn Any>

向下转型口(0.5.2,「插件即 App」波)。

宿主侧要按具体插件类型挂它自带的界面面(ui_face::render)或调它的读数口,而 Arc<dyn Plugin> 不能直接 downcast —— trait 已含 Any 超弦, 这里补一条口。默认 None = 不支持转型(老插件零改动零炸);要挂面的插件侧覆写成 Some(self)。转型口只给宿主挂面用,不是插件间通信口 (插件间只走总线,老纪律不动)。

Source