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 から取られています (428 行~ 466 行)。

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);
  }

関連概念
ユーザー定義の入力ノード
ユーザー定義拡張機能

関連タスク
C でのパーサーの作成

関連資料
cpiParseBufferEncoded
cpiParseBufferFormatted
パーサー・インプリメンテーション関数