cpiParseBuffer

此函数准备解析器以解析新消息对象。 它调用消息流引起解析消息内容的第一时间(对于每条消息)。

对于用来解析特定消息格式的每个用户定义解析器,都将调用此函数以完成以下操作:
  • 执行所需的所有初始化
  • 返回它所具有的消息内容的长度

offset 参数表明开始解析的消息缓冲区内的偏移量。 由于另一个解析器可能拥有消息的前一部分(例如,MQMD 头由集成节点所拥有的内部解析器解析),因此需要此指示信息。 偏移量必须是正数并且小于缓冲区 的大小。 在此函数中验证偏移量是否有效,以除去与先前解析器相关联的问题。

解析器必须返回它所占有的剩余缓冲区的大小。 这个大小必须小于或等于缓冲区的大小减去当前偏移量。

解析器不能尝试引起解析其他的语法元素树部分,例如,通过浏览到根元素并到另一个分支。 此操作可能产生不可预测的结果。

如果在 CPI_VFT 结构中提供了此实现函数,那么既不能调用 cpiParseBufferEncoded() 也不能调用 cpiParseBufferFormatted(),这是因为 cpiDefineParserClass() 函数将失败,返回码为 CCI_INVALID_IMPL_FUNCTION。

定义位置 类型 成员
CPI_VFT 有条件的 iFpParseBuffer

语法

int cpiParseBuffer(
  CciParser*   parser,
  CciContext*  context,
  int          offset);

参数

parser
解析器对象的地址(输入)。
context
解析器对象拥有的上下文的地址(输入)。
offset
开始(输入)解析的消息缓冲区内的偏移

返回值

解析器取得所有权的消息缓冲区的剩余部分的大小(以字节为单位)。

样本

此示例取自样本解析器文件 BipSampPluginParser.c

int cpiParseBuffer(
  CciParser*  parser,
  CciContext* context,
  int         offset,
){
  PARSER_CONTEXT_ST* pc = (PARSER_CONTEXT_ST *)context ;
  int                rc;

  /* Get a pointer to the message buffer and set the offset */
  pc->iBuffer = (void *)cpiBufferPointer(&rc, parser);
  pc->iIndex = 0;

  /* Save size of the buffer */
  pc->iSize = cpiBufferSize(&rc, parser);

  /* Prime the first byte in the stream */
  pc->iCurrentCharacter = cpiBufferByte(&rc, parser, pc->iIndex);

  /* Set the current element to the root element */
  pc->iCurrentElement = cpiRootElement(&rc, parser);

  /* Reset flag to ensure parsing is reset correctly */
  pc->iInTag = 0;

  if (pc->trace) {
    fprintf(pc->tracefile, "PLUGIN: <- cpiParseBuffer() 
    retvalue=%d\n", pc->iSize);
    fflush(pc->tracefile);
  }