op_pk_nfd_set_ptr()

摘要

为指定数据包中的结构体字段赋值;目标字段通过名称指定。

语法

op_pk_nfd_set_ptr (pkptr, fd_name, value, copy_proc, dealloc_proc, alloc_size)
参数 类型 说明
pkptr Packet* 目标数据包指针
[数据包指针可以从许多内核过程获得,包括 op_pk_create_fmt()、op_pk_copy()、op_pk_get()、op_subq_pk_access() 和 op_subq_pk_remove()。]
fd_name const char* 目标字段名称
[该名称必须是数据包格式中已定义的字段,否则会发生错误。]
value void* 要赋给该字段的值
copy_proc SimT_Pk_Fd_Struct_Copy_Proc 指定数据结构的复制过程,通常为内核过程 op_prg_mem_copy_create()(见详情)
dealloc_proc SimT_Pk_Fd_Struct_Dealloc_Proc 指定数据结构的释放过程,通常为内核过程 op_prg_mem_free()(见详情)
alloc_size size_t 传递给 copy_proc 的参数
[可以指示指定数据结构的实际大小(字节)。]

返回类型

Compcode

若字段值设置成功,返回 OPC_COMPCODE_SUCCESS;否则返回 OPC_COMPCODE_FAILURE。

示例

	{
	/* declarations */
	Packet *f_pkptr; struct Custom_DS *ds_ptr;

	/* create a formatted packet */
	f_pkptr = op_pk_create_fmt ("struct_pkt");

	/* allocate a new data structure */
	ds_ptr = (struct Custom_DS *) op_prg_mem_alloc (sizeof (Custom_DS));

	/* fill in certain data structure values */
	ds_ptr->int_value = 455;
	sprintf (ds_ptr->name, "Custom Data Structure #1");

	/* assign the data structure to a field in the packet */
	op_pk_nfd_set_ptr (f_pkptr, "ds_field", ds_ptr, op_prg_mem_copy_create,
		op_prg_mem_free, sizeof (Custom_DS));

	/* send the defined packet out of the processor */
	op_pk_send (f_pkptr, OUTSTRM);
	}

详情

value 参数可以接受任何类型数据结构的指针。如果指定的字段此前未被设置过,新字段的大小将根据数据包格式确定,并累加到数据包的总大小中。

必须指定字段的 value。被赋值到字段的结构体会被“封装”在本内核过程所操作的数据包内部,调用该过程的进程通常不应继续引用被赋值的结构体指针(这偶尔可作为一种远程进程间通信的手段,但结构体内存必须非常小心地处理)。

指定的复制和释放过程分别在指定数据包被复制或销毁时被调用。复制过程用于为字段中包含的结构体分配内存并进行复制。copy_proc 的函数原型为:

typedef void * (*SimT_Pk_Fd_Struct_Copy_Proc)(void * org_ptr, size_t size)

当指定的复制过程为 op_prg_mem_copy_create() 时,alloc_size 指定在分配结构体副本时预留正确内存量所需的字节数。copy_proc 不能为空;至少必须是一个仅返回 org_ptr 的桩函数。

释放过程用于释放字段中包含的结构体所占用的内存。dealloc_proc 的函数原型为:

typedef void (*SimT_Pk_Fd_Struct_Dealloc_Proc)(void * ptr)

dealloc_proc 可以为空,此时内存不会被释放。

注意: 由于数据包被复制时字段不会被自动复制,复制和释放过程可能不会在预期的时机被调用。复制过程仅在结构体字段发生变化时被调用,而不是在数据包被复制时。释放过程仅当被销毁的结构体字段为该数据包所独有(即未被该数据包的副本引用)时被调用。详见 op_pk_copy() 的说明。

用途

提供了一种在数据包内设置结构体字段值的方法。由于数据包是已格式化的,只需指定字段的值和分配信息;字段的类型和大小会自动从格式中获取。该内核过程只应应用于已格式化的数据包,否则会发生错误

错误

参考

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com