cyber_effects_cmd_register()
摘要
向节点的 cyber-effects manager 注册一个受支持的效应。
语法
cyber_effects_cmd_register (mgr_ptr, cmd_category, cmd_index, module, process, cmd_proc, cancel_proc, intrpt_code, client_state_vptr)
| 参数 | 类型 | 说明 |
|---|---|---|
mgr_ptr |
CyberT_Effect_Mgr* |
要注册效应的 cyber-effects manager。该句柄可通过调用 cyber_effects_mgr_handle_get() 获取。 |
cmd_category |
int |
用于标识效应类别的取值。已定义的类别有: 0–General 1–IP 客户端模块可以添加新的类别值。 |
cmd_index |
int |
在给定类别内唯一标识该效应的整数值 |
module |
Objid |
客户端模块的对象 ID |
process |
Prohandle |
注册该效应的客户端进程的进程 ID |
cmd_proc |
CyberT_Effect_Proc_Ptr |
指向在客户端模块内实现该效应的回调过程的指针 |
cancel_proc |
CyberT_Effect_Proc_Ptr |
指向在客户端模块内实现该效应取消操作的回调过程的指针 |
intrpt_code |
int |
当 cyber-effects manager 命令执行该效应时,客户端模块/进程希望收到的中断代码值 |
client_state_vptr |
void* |
客户端模块/进程中的一块本地内存,可用于存储表示该效应所用数据的初始状态的信息。它作为 CyberT_Effect_Proc_Ptr 的 model_data_vptr 参数传入。例如,可以在 cancel_proc 中使用它来帮助取消该效应。 |
返回类型
void
无返回值
头文件
cyber_effects.h
示例
来自 ip_rte_central_cpu 的 function block:
double one_over_service_rate; /* Number of packets handled by routing processor per second */
static void
ip_rte_routing_processor_info_init (void)
{
...
/* Cyber Effects settings. */
effects_mgr_ptr = cyber_effects_mgr_handle_get ();
/* If a Cyber Effects manager is present in the node... */
if (effects_mgr_ptr != OPC_NIL)
{
// Allocate memory to store any data to undo the effects if needed.
effects_cancel_data_ptr = op_prg_mem_alloc (sizeof(Ip_Central_Cpu_Effect_State));
effects_cancel_data_ptr->one_over_service_rate_backup = one_over_service_rate;
/* Register Cyber Effects available at this process model. */
cyber_effects_cmd_register
(effects_mgr_ptr,
CyberC_IP, // Effect Category.
CyberC_Decrease_Fwd_Rate, // Effect: Decrease IP forwarding rate.
own_id, // Client module ID.
own_prohandle, // Client process handle.
cyber_effect_change_service_rate_to_cmd_proc, // Effect callback
cyber_effect_change_service_rate_to_cancel_cmd_proc, // Cancel callback
CMD_INTRPT_CODE_CHANGE_FWD_RATE, // Interrupt code number to receive when this process is interrupted to execute this effect.
effects_cancel_data_ptr // Data to undo the effect (used by cancel proc if needed).
);
...
}
}
详细说明
cyber effects 框架的模块客户端调用此函数,以注册由该模块实现的效应。效应注册之后,当需要执行该效应时(以及是否需要执行),cyber-effects manager 会通知该模块。
在注册效应之前,确认该节点包含 cyber-effects manager 模块非常重要。