この関数は、新しいメッセージ・オブジェクトを構文解析するパーサーを作成します。 これは、メッセージ・フローでメッセージ内容を (各メッセージについて) 最初に構文解析する際に呼び出されます。
offset パラメーターは、構文解析を始めるメッセージ・バッファー内のオフセットを示します。 他のパーサーがメッセージの前の部分を所有している (例えば、MQMD ヘッダーが、ブローカーが所有する内部パーサーによって構文解析される) 可能性があるため、この指示は必須です。 オフセットは正の数で、バッファーのサイズより小さくなければなりません。 この関数で、オフセットが有効であることを確認し、以前のパーサーに関連する問題を除去します。
パーサーは、所有権を持っている残りのバッファーのサイズを戻さなければなりません。 このサイズは、バッファーから現行のオフセットを引いたサイズ以下でなければなりません。
パーサーは、例えばルート・エレメントおよび他の分岐にナビゲートすることによって、構文エレメント・ツリーの他の部分の構文解析を実行しようとしてはなりません。 このアクションが予測不可能な問題の原因となる可能性があります。
このインプリメンテーション関数が CPI_VFT 構造で提供されている場合、cpiParseBufferEncoded() または cpiParseBufferFormatted() のどちらも呼び出せません。呼び出した場合、cpiDefineParserClass() 関数は失敗し、CCI_INVALID_IMPL_FUNCTION の戻りコードが出されます。
定義されている場所 | タイプ | メンバー |
---|---|---|
CPI_VFT | 条件付き | iFpParseBuffer |
int cpiParseBuffer(
CciParser* parser,
CciContext* context,
int 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);
}