op_pk_nfd_get()

已弃用——请使用显式指定类型的 op_pk_nfd_get_<type>()

摘要

获取指定数据包中某字段的值,并会将某些字段类型的状态变为未设置(unset);目标字段通过名称指定。

语法

op_pk_nfd_get (pkptr, fd_name, value_ptr)
参数 类型 说明
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_ptr void* 指向某个变量的指针,用于存放指定字段的值
[该参数可以接受指向整型、双精度、数据包指针或任何其他数据结构的指针。参数指针的数据类型必须与指定字段的数据类型一致,否则会发生错误。]

返回类型

Compcode

完成代码,指示是否成功获取指定字段的值。

如果发生错误,将返回常量 OPC_COMPCODE_FAILURE。

示例

	{
	/* variable declarations */
	int i; double d; Packet *pkptr, *enc_pkptr; struct Custom_DS *ds_ptr;

	/* obtain an arriving packet */
	pkptr = op_pk_get (0);

	/* obtain the simple field types */
	op_pk_nfd_get (pkptr, "int_value", &i);
	op_pk_nfd_get (pkptr, "double_value", &d);
	printf ("packet contents: integer (%d), double (%g)\n", i, d);

	/* decapsulate a higher-level packet from the arriving packet */
	op_pk_nfd_get (pkptr, "packet_value", &enc_pkptr);
	op_pk_print (enc_pkptr);

	/* extract a data structure from a packet field */
	op_pk_nfd_get (pkptr, "structure_value", &ds_ptr);

	op_pk_destroy (pkptr);
	}

详情

该内核过程支持对全部五种数据包字段类型的值访问:整型(integer)、双精度(double)、数据包(packet)、信息(information)和结构(structure)。但是,其行为因类型不同而有所差异,如下所述。

整型与双精度字段

简单数据包字段(整型和双精度)的值会被复制到传入的变量中,除此之外不受该内核过程影响(即这些类型的字段仍保持已设置且可访问的状态,并继续为数据包的总大小贡献相同的比特数)。

数据包与结构字段

数据包中的数据包字段和结构字段的值(即指向数据包或数据结构的指针)同样会被复制到传入的变量中。

**注意:**访问数据包和结构的值会产生副作用:这些字段实际上会从数据包中被剥离——其状态变为未设置,其内容对后续的 op_pk_nfd_get() 调用不再可访问,其对数据包总大小的贡献也会被减去。这些副作用旨在强制对被封装字段内容实行严格的所有权规则。访问这些字段的内容在概念上相当于从数据包内部解封装出其中的数据包或数据结构。

信息字段

访问信息字段的值没有有效用途,因为该字段没有确定的值;但该操作不会导致错误,而是将字符串 “unspecified” 复制到传入的值指针中(传入的地址必须指向一个长度足以容纳该字符串的字符数组)。

目的

提供一种获取数据包字段值的机制。这一操作是「将数据包用作进程间通信数据容器」这一目标的基础。通常,当数据包到达某个处理器或队列的输入流、并且该数据包:

  • 需要被处理
  • 需要被存储
  • 需要生成响应消息

时,会调用该内核过程。

该内核过程存在针对特定数据类型的版本。这些替代内核过程比这种可变参数版本更高效;此外,它们还能让编译器捕获该内核过程遗漏的参数错误。详情参见 op_pk_nfd_get_dbl()、op_pk_nfd_get_int32()、op_pk_nfd_get_int64()、op_pk_nfd_get_objid()、op_pk_nfd_get_pkid()、op_pk_nfd_get_pkt() 和 op_pk_nfd_get_ptr()。

错误

  • 程序中止:段违例。(由无效的数据包指针或格式错误的数据包引起)
  • 程序中止:数据包指针为 NIL。
  • 程序中止:数据包指针指向已被销毁的数据包。
  • 程序中止:数据包指针指向无主数据包 (<pk_id>)。

参考

  • 使用内核过程 op_pk_nfd_set() 的变体为数据包字段赋值
  • 使用内核过程 op_pk_nfd_get_dbl() 从数据包获取双精度字段的值,通过数字索引指定字段
  • 使用内核过程 op_pk_nfd_get_int32() 从数据包获取 32 位整型字段的值,通过数字索引指定字段
  • 使用内核过程 op_pk_nfd_get_int64() 从数据包获取 64 位整型字段的值,通过数字索引指定字段
  • 使用内核过程 op_pk_nfd_get_objid() 从数据包获取对象 ID 字段的值,通过数字索引指定字段
  • 使用内核过程 op_pk_nfd_get_pkid() 从数据包获取数据包 ID 字段的值,通过数字索引指定字段
  • 使用内核过程 op_pk_nfd_get_pkt() 从数据包获取数据包字段的值,通过数字索引指定字段
  • 使用内核过程 op_pk_nfd_get_ptr() 从数据包获取结构字段的值,通过数字索引指定字段
  • 使用内核过程 op_pk_fd_get() 的变体,从未格式化(或已格式化)的数据包获取字段的值,通过数字索引指定要访问的字段
  • 使用内核过程 op_pk_nfd_type() 确定数据包字段的类型
  • 使用内核过程 op_pk_nfd_size() 确定数据包字段的大小
  • 使用内核过程 op_pk_nfd_is_set() 判断数据包字段是否已设置

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · 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