deploy: f807508

Author: nick-zh

index.xml

@@ -5,7 +5,7 @@
 <label for=navtree-481fd653 class="flex justify-between"><span class=flex>Functions</span><svg class="icon keyborad_arrow_left"><use xlink:href="#keyborad_arrow_left"/></svg><svg class="icon keyborad_arrow_down hidden"><use xlink:href="#keyborad_arrow_down"/></svg></label><ul class=gdoc-nav__list><li><span class=flex><a href=/functions/kafka_err2name/ class=gdoc-nav__entry>kafka_err2name</a></span></li><li><span class=flex><a href=/functions/kafka_err2str/ class=gdoc-nav__entry>kafka_err2str</a></span></li><li><span class=flex><a href=/functions/kafka_get_err_descs/ class=gdoc-nav__entry>kafka_get_err_descs</a></span></li><li><span class=flex><a href=/functions/kafka_offset_tail/ class=gdoc-nav__entry>kafka_offset_tail</a></span></li><li><span class=flex><a href=/functions/kafka_thread_cnt/ class=gdoc-nav__entry>kafka_thread_cnt</a></span></li></ul></li><li><span class=flex><a href=/installation/ class=gdoc-nav__entry>Installation</a></span></li><li><input type=checkbox id=navtree-a7bd8b12 class=gdoc-nav__toggle checked>
 <label for=navtree-a7bd8b12 class="flex justify-between"><span class=flex>Producer</span><svg class="icon keyborad_arrow_left"><use xlink:href="#keyborad_arrow_left"/></svg><svg class="icon keyborad_arrow_down hidden"><use xlink:href="#keyborad_arrow_down"/></svg></label><ul class=gdoc-nav__list><li><span class=flex><a href=/producer/__construct/ class=gdoc-nav__entry>__construct</a></span></li><li><span class=flex><a href=/producer/abortTransaction/ class=gdoc-nav__entry>abortTransaction</a></span></li><li><span class=flex><a href=/producer/beginTransaction/ class="gdoc-nav__entry is-active">beginTransaction</a></span></li><li><span class=flex><a href=/producer/commitTransaction/ class=gdoc-nav__entry>commitTransaction</a></span></li><li><span class=flex><a href=/producer/flush/ class=gdoc-nav__entry>flush</a></span></li><li><span class=flex><a href=/producer/initTransactions/ class=gdoc-nav__entry>initTransactions</a></span></li><li><span class=flex><a href=/producer/purge/ class=gdoc-nav__entry>purge</a></span></li></ul></li><li><input type=checkbox id=navtree-c68f3d15 class=gdoc-nav__toggle>
 <label for=navtree-c68f3d15 class="flex justify-between"><span class=flex>What's new</span><svg class="icon keyborad_arrow_left"><use xlink:href="#keyborad_arrow_left"/></svg><svg class="icon keyborad_arrow_down hidden"><use xlink:href="#keyborad_arrow_down"/></svg></label><ul class=gdoc-nav__list><li><span class=flex><a href=/whats-new/release-1.0.0/ class=gdoc-nav__entry>Release v1.0.0</a></span></li></ul></li></ul></section><section class=gdoc-nav--more><h2>More</h2><ul class=gdoc-nav__list><li><span class=flex><svg class="icon github"><use xlink:href="#github"/></svg><a href=https://github.com/php-kafka/php-kafka.github.io class=gdoc-nav__entry>View Source</a></span></li></ul></section></nav></aside><div class=gdoc-page><div class="gdoc-page__header flex flex-wrap justify-between" itemscope itemtype=http://data-vocabulary.org/Breadcrumb><span></span><span><span class=editpage><svg class="icon code"><use xlink:href="#code"/></svg><a href=https://github.com/php-kafka/php-kafka.github.io/tree/main/content/producer/beginTransaction.md>Edit this page</a></span></span></div><article class=gdoc-markdown><h1>beginTransaction</h1><div class=gdoc-page__anchorwrap><h2 id=description>Description<a data-clipboard-text=https://php-kafka.github.io/producer/beginTransaction/#description class="gdoc-page__anchor gdoc-page__anchor--right clip" aria-label="Anchor Description" href=#description><svg class="icon link"><use xlink:href="#link"/></svg></a></h2></div><div class=highlight><pre class=chroma><code class=language-php data-lang=php><span class=k>public</span> <span class=k>function</span> <span class=nf>beginTransaction</span><span class=p>()</span><span class=o>:</span> <span class=nx>void</span> <span class=p>{}</span>
-</code></pre></div><p>Get a producer instance</p><div class=gdoc-page__anchorwrap><h2 id=example>Example<a data-clipboard-text=https://php-kafka.github.io/producer/beginTransaction/#example class="gdoc-page__anchor gdoc-page__anchor--right clip" aria-label="Anchor Example" href=#example><svg class="icon link"><use xlink:href="#link"/></svg></a></h2></div><div class=highlight><pre class=chroma><code class=language-php data-lang=php><span class=nv>$conf</span> <span class=o>=</span> <span class=nx>Kafka\Configuration</span><span class=p>();</span>
+</code></pre></div><p><code>Kafka\Producer::initTransactions()</code> must have been called successfully (once)<br>before this function is called. Any messages produced, offsets sent, etc,<br>after the successful return of this function will be part of the transaction<br>and committed or aborted automatically.<br>Finish the transaction by calling <code>Kafka\Producer::commitTransaction()</code><br>or abort the transaction by calling <code>Kafka\Producer::abortTransaction()</code></p><div class=highlight><pre class=chroma><code class=language-php data-lang=php><span class=nv>$conf</span> <span class=o>=</span> <span class=nx>Kafka\Configuration</span><span class=p>();</span>
 <span class=nv>$conf</span><span class=o>-&gt;</span><span class=na>set</span><span class=p>(</span><span class=s1>&#39;metadata.broker.list&#39;</span><span class=p>,</span> <span class=s1>&#39;kafka:9092&#39;</span><span class=p>);</span>
 <span class=nv>$producer</span> <span class=o>=</span> <span class=k>new</span> <span class=nx>Kafka\Producer</span><span class=p>(</span><span class=nv>$conf</span><span class=p>);</span>
 <span class=nv>$producer</span><span class=o>-&gt;</span><span class=na>initTransactions</span><span class=p>(</span><span class=mi>10000</span><span class=p>);</span>

producer/beginTransaction/index.html

@@ -5,7 +5,7 @@
 <label for=navtree-481fd653 class="flex justify-between"><span class=flex>Functions</span><svg class="icon keyborad_arrow_left"><use xlink:href="#keyborad_arrow_left"/></svg><svg class="icon keyborad_arrow_down hidden"><use xlink:href="#keyborad_arrow_down"/></svg></label><ul class=gdoc-nav__list><li><span class=flex><a href=/functions/kafka_err2name/ class=gdoc-nav__entry>kafka_err2name</a></span></li><li><span class=flex><a href=/functions/kafka_err2str/ class=gdoc-nav__entry>kafka_err2str</a></span></li><li><span class=flex><a href=/functions/kafka_get_err_descs/ class=gdoc-nav__entry>kafka_get_err_descs</a></span></li><li><span class=flex><a href=/functions/kafka_offset_tail/ class=gdoc-nav__entry>kafka_offset_tail</a></span></li><li><span class=flex><a href=/functions/kafka_thread_cnt/ class=gdoc-nav__entry>kafka_thread_cnt</a></span></li></ul></li><li><span class=flex><a href=/installation/ class=gdoc-nav__entry>Installation</a></span></li><li><input type=checkbox id=navtree-a7bd8b12 class=gdoc-nav__toggle checked>
 <label for=navtree-a7bd8b12 class="flex justify-between"><span class=flex>Producer</span><svg class="icon keyborad_arrow_left"><use xlink:href="#keyborad_arrow_left"/></svg><svg class="icon keyborad_arrow_down hidden"><use xlink:href="#keyborad_arrow_down"/></svg></label><ul class=gdoc-nav__list><li><span class=flex><a href=/producer/__construct/ class=gdoc-nav__entry>__construct</a></span></li><li><span class=flex><a href=/producer/abortTransaction/ class=gdoc-nav__entry>abortTransaction</a></span></li><li><span class=flex><a href=/producer/beginTransaction/ class=gdoc-nav__entry>beginTransaction</a></span></li><li><span class=flex><a href=/producer/commitTransaction/ class="gdoc-nav__entry is-active">commitTransaction</a></span></li><li><span class=flex><a href=/producer/flush/ class=gdoc-nav__entry>flush</a></span></li><li><span class=flex><a href=/producer/initTransactions/ class=gdoc-nav__entry>initTransactions</a></span></li><li><span class=flex><a href=/producer/purge/ class=gdoc-nav__entry>purge</a></span></li></ul></li><li><input type=checkbox id=navtree-c68f3d15 class=gdoc-nav__toggle>
 <label for=navtree-c68f3d15 class="flex justify-between"><span class=flex>What's new</span><svg class="icon keyborad_arrow_left"><use xlink:href="#keyborad_arrow_left"/></svg><svg class="icon keyborad_arrow_down hidden"><use xlink:href="#keyborad_arrow_down"/></svg></label><ul class=gdoc-nav__list><li><span class=flex><a href=/whats-new/release-1.0.0/ class=gdoc-nav__entry>Release v1.0.0</a></span></li></ul></li></ul></section><section class=gdoc-nav--more><h2>More</h2><ul class=gdoc-nav__list><li><span class=flex><svg class="icon github"><use xlink:href="#github"/></svg><a href=https://github.com/php-kafka/php-kafka.github.io class=gdoc-nav__entry>View Source</a></span></li></ul></section></nav></aside><div class=gdoc-page><div class="gdoc-page__header flex flex-wrap justify-between" itemscope itemtype=http://data-vocabulary.org/Breadcrumb><span></span><span><span class=editpage><svg class="icon code"><use xlink:href="#code"/></svg><a href=https://github.com/php-kafka/php-kafka.github.io/tree/main/content/producer/commitTransaction.md>Edit this page</a></span></span></div><article class=gdoc-markdown><h1>commitTransaction</h1><div class=gdoc-page__anchorwrap><h2 id=description>Description<a data-clipboard-text=https://php-kafka.github.io/producer/commitTransaction/#description class="gdoc-page__anchor gdoc-page__anchor--right clip" aria-label="Anchor Description" href=#description><svg class="icon link"><use xlink:href="#link"/></svg></a></h2></div><div class=highlight><pre class=chroma><code class=language-php data-lang=php><span class=k>public</span> <span class=k>function</span> <span class=nf>commitTransaction</span><span class=p>(</span><span class=nx>int</span> <span class=nv>$timeoutMs</span><span class=p>)</span><span class=o>:</span> <span class=nx>void</span> <span class=p>{}</span>
-</code></pre></div><p>Get a producer instance</p><div class=gdoc-page__anchorwrap><h2 id=example>Example<a data-clipboard-text=https://php-kafka.github.io/producer/commitTransaction/#example class="gdoc-page__anchor gdoc-page__anchor--right clip" aria-label="Anchor Example" href=#example><svg class="icon link"><use xlink:href="#link"/></svg></a></h2></div><div class=highlight><pre class=chroma><code class=language-php data-lang=php><span class=nv>$conf</span> <span class=o>=</span> <span class=nx>Kafka\Configuration</span><span class=p>();</span>
+</code></pre></div><p>Commit the current transaction (as started with <code>Kafka\Producer::beginTransaction()</code>).<br>Any outstanding messages will be flushed (delivered) before actually committing the transaction.<br>If any of the outstanding messages fail permanently the current transaction will enter the<br>abortable error state and this function will return an abortable error, in this case the<br>application must call <code>Kafka\Producer::abortTransaction()</code> before attempting a new<br>transaction with <code>Kafka\Producer::beginTransaction()</code>.</p><div class=gdoc-page__anchorwrap><h2 id=example>Example<a data-clipboard-text=https://php-kafka.github.io/producer/commitTransaction/#example class="gdoc-page__anchor gdoc-page__anchor--right clip" aria-label="Anchor Example" href=#example><svg class="icon link"><use xlink:href="#link"/></svg></a></h2></div><div class=highlight><pre class=chroma><code class=language-php data-lang=php><span class=nv>$conf</span> <span class=o>=</span> <span class=nx>Kafka\Configuration</span><span class=p>();</span>
 <span class=nv>$conf</span><span class=o>-&gt;</span><span class=na>set</span><span class=p>(</span><span class=s1>&#39;metadata.broker.list&#39;</span><span class=p>,</span> <span class=s1>&#39;kafka:9092&#39;</span><span class=p>);</span>
 <span class=nv>$producer</span> <span class=o>=</span> <span class=k>new</span> <span class=nx>Kafka\Producer</span><span class=p>(</span><span class=nv>$conf</span><span class=p>);</span>
 <span class=nv>$producer</span><span class=o>-&gt;</span><span class=na>initTransactions</span><span class=p>(</span><span class=mi>10000</span><span class=p>);</span>

producer/commitTransaction/index.html

@@ -5,7 +5,7 @@
 <label for=navtree-481fd653 class="flex justify-between"><span class=flex>Functions</span><svg class="icon keyborad_arrow_left"><use xlink:href="#keyborad_arrow_left"/></svg><svg class="icon keyborad_arrow_down hidden"><use xlink:href="#keyborad_arrow_down"/></svg></label><ul class=gdoc-nav__list><li><span class=flex><a href=/functions/kafka_err2name/ class=gdoc-nav__entry>kafka_err2name</a></span></li><li><span class=flex><a href=/functions/kafka_err2str/ class=gdoc-nav__entry>kafka_err2str</a></span></li><li><span class=flex><a href=/functions/kafka_get_err_descs/ class=gdoc-nav__entry>kafka_get_err_descs</a></span></li><li><span class=flex><a href=/functions/kafka_offset_tail/ class=gdoc-nav__entry>kafka_offset_tail</a></span></li><li><span class=flex><a href=/functions/kafka_thread_cnt/ class=gdoc-nav__entry>kafka_thread_cnt</a></span></li></ul></li><li><span class=flex><a href=/installation/ class=gdoc-nav__entry>Installation</a></span></li><li><input type=checkbox id=navtree-a7bd8b12 class=gdoc-nav__toggle checked>
 <label for=navtree-a7bd8b12 class="flex justify-between"><span class=flex>Producer</span><svg class="icon keyborad_arrow_left"><use xlink:href="#keyborad_arrow_left"/></svg><svg class="icon keyborad_arrow_down hidden"><use xlink:href="#keyborad_arrow_down"/></svg></label><ul class=gdoc-nav__list><li><span class=flex><a href=/producer/__construct/ class=gdoc-nav__entry>__construct</a></span></li><li><span class=flex><a href=/producer/abortTransaction/ class=gdoc-nav__entry>abortTransaction</a></span></li><li><span class=flex><a href=/producer/beginTransaction/ class=gdoc-nav__entry>beginTransaction</a></span></li><li><span class=flex><a href=/producer/commitTransaction/ class=gdoc-nav__entry>commitTransaction</a></span></li><li><span class=flex><a href=/producer/flush/ class="gdoc-nav__entry is-active">flush</a></span></li><li><span class=flex><a href=/producer/initTransactions/ class=gdoc-nav__entry>initTransactions</a></span></li><li><span class=flex><a href=/producer/purge/ class=gdoc-nav__entry>purge</a></span></li></ul></li><li><input type=checkbox id=navtree-c68f3d15 class=gdoc-nav__toggle>
 <label for=navtree-c68f3d15 class="flex justify-between"><span class=flex>What's new</span><svg class="icon keyborad_arrow_left"><use xlink:href="#keyborad_arrow_left"/></svg><svg class="icon keyborad_arrow_down hidden"><use xlink:href="#keyborad_arrow_down"/></svg></label><ul class=gdoc-nav__list><li><span class=flex><a href=/whats-new/release-1.0.0/ class=gdoc-nav__entry>Release v1.0.0</a></span></li></ul></li></ul></section><section class=gdoc-nav--more><h2>More</h2><ul class=gdoc-nav__list><li><span class=flex><svg class="icon github"><use xlink:href="#github"/></svg><a href=https://github.com/php-kafka/php-kafka.github.io class=gdoc-nav__entry>View Source</a></span></li></ul></section></nav></aside><div class=gdoc-page><div class="gdoc-page__header flex flex-wrap justify-between" itemscope itemtype=http://data-vocabulary.org/Breadcrumb><span></span><span><span class=editpage><svg class="icon code"><use xlink:href="#code"/></svg><a href=https://github.com/php-kafka/php-kafka.github.io/tree/main/content/producer/flush.md>Edit this page</a></span></span></div><article class=gdoc-markdown><h1>flush</h1><div class=gdoc-page__anchorwrap><h2 id=description>Description<a data-clipboard-text=https://php-kafka.github.io/producer/flush/#description class="gdoc-page__anchor gdoc-page__anchor--right clip" aria-label="Anchor Description" href=#description><svg class="icon link"><use xlink:href="#link"/></svg></a></h2></div><div class=highlight><pre class=chroma><code class=language-php data-lang=php><span class=k>public</span> <span class=k>function</span> <span class=nf>flush</span><span class=p>(</span><span class=nx>int</span> <span class=nv>$timeoutMs</span><span class=p>)</span><span class=o>:</span> <span class=nx>int</span> <span class=p>{}</span>
-</code></pre></div><p>Get a producer instance</p><div class=gdoc-page__anchorwrap><h2 id=example>Example<a data-clipboard-text=https://php-kafka.github.io/producer/flush/#example class="gdoc-page__anchor gdoc-page__anchor--right clip" aria-label="Anchor Example" href=#example><svg class="icon link"><use xlink:href="#link"/></svg></a></h2></div><div class=highlight><pre class=chroma><code class=language-php data-lang=php><span class=nv>$conf</span> <span class=o>=</span> <span class=nx>Kafka\Configuration</span><span class=p>();</span>
+</code></pre></div><p>Wait until all outstanding produce requests, et.al, are completed.<br>This should typically be done prior to destroying a producer instance to make sure<br>all queued and in-flight produce requests are completed before terminating.<br>This function will call poll() and thus trigger callbacks.</p><div class=gdoc-page__anchorwrap><h2 id=example>Example<a data-clipboard-text=https://php-kafka.github.io/producer/flush/#example class="gdoc-page__anchor gdoc-page__anchor--right clip" aria-label="Anchor Example" href=#example><svg class="icon link"><use xlink:href="#link"/></svg></a></h2></div><div class=highlight><pre class=chroma><code class=language-php data-lang=php><span class=nv>$conf</span> <span class=o>=</span> <span class=nx>Kafka\Configuration</span><span class=p>();</span>
 <span class=nv>$conf</span><span class=o>-&gt;</span><span class=na>set</span><span class=p>(</span><span class=s1>&#39;metadata.broker.list&#39;</span><span class=p>,</span> <span class=s1>&#39;kafka:9092&#39;</span><span class=p>);</span>
 <span class=nv>$producer</span> <span class=o>=</span> <span class=k>new</span> <span class=nx>Kafka\Producer</span><span class=p>(</span><span class=nv>$conf</span><span class=p>);</span>
 <span class=c1>// produce some messsages