deploy: 609894c

Author: nick-zh

about/index.html

@@ -1,4 +1,10 @@
-<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Configuration on Documentation of php-simple-kafka-client</title><link>https://php-kafka.github.io/php-simple-kafka-client.github.io/configuration/</link><description>Recent content in Configuration on Documentation of php-simple-kafka-client</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><lastBuildDate>Sun, 27 Dec 2020 22:09:37 +0100</lastBuildDate><atom:link href="https://php-kafka.github.io/php-simple-kafka-client.github.io/configuration/index.xml" rel="self" type="application/rss+xml"/><item><title>dump</title><link>https://php-kafka.github.io/php-simple-kafka-client.github.io/configuration/dump/</link><pubDate>Sun, 27 Dec 2020 22:09:37 +0100</pubDate><guid>https://php-kafka.github.io/php-simple-kafka-client.github.io/configuration/dump/</guid><description>Description public function dump(): array {} Dumps the current configuration
+<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Configuration on Documentation of php-simple-kafka-client</title><link>https://php-kafka.github.io/php-simple-kafka-client.github.io/configuration/</link><description>Recent content in Configuration on Documentation of php-simple-kafka-client</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><lastBuildDate>Sun, 27 Dec 2020 22:09:37 +0100</lastBuildDate><atom:link href="https://php-kafka.github.io/php-simple-kafka-client.github.io/configuration/index.xml" rel="self" type="application/rss+xml"/><item><title>setOAuthBearerTokenRefreshCb</title><link>https://php-kafka.github.io/php-simple-kafka-client.github.io/configuration/setOAuthBearerTokenRefreshCb/</link><pubDate>Tue, 07 Sep 2021 10:09:37 +0100</pubDate><guid>https://php-kafka.github.io/php-simple-kafka-client.github.io/configuration/setOAuthBearerTokenRefreshCb/</guid><description>Description public function setOAuthBearerTokenRefreshCb(callable $callback): void {} The SASL/OAUTHBEARER token refresh callback is triggered automatically or via poll
+whenever OAUTHBEARER is the SASL mechanism and a token needs to be retrieved,
+typically based on the configuration defined in sasl.oauthbearer.config.
+The callback should invoke setOauthBearerToken
+or setOauthBearerTokenFailure to indicate success
+or failure, respectively.
+Example $conf = new SimpleKafkaClient\Configuration(); $conf-&amp;gt;set(&amp;#39;metadata.broker.list&amp;#39;, getenv(&amp;#39;TEST_KAFKA_BROKERS&amp;#39;)); $conf-&amp;gt;set(&amp;#39;security.protocol&amp;#39;, &amp;#39;SASL_PLAINTEXT&amp;#39;); $conf-&amp;gt;set(&amp;#39;sasl.mechanisms&amp;#39;, &amp;#39;OAUTHBEARER&amp;#39;); $conf-&amp;gt;set(&amp;#39;sasl.oauthbearer.config&amp;#39;, &amp;#39;principalClaimName=azp&amp;#39;); $conf-&amp;gt;setOAuthBearerTokenRefreshCb(function($kafka, $oAuthBearerConfig) { // get the refresh token with some custom code, then act accordingly if ($tokenRefreshWasSucessful) { $kafka-&amp;gt;setOAuthBearerToken($token, $lifetimeMs, $principalName, $extensions); } else { $kafka-&amp;gt;setOAuthBearerTokenFailure($errorReason); } });</description></item><item><title>dump</title><link>https://php-kafka.github.io/php-simple-kafka-client.github.io/configuration/dump/</link><pubDate>Sun, 27 Dec 2020 22:09:37 +0100</pubDate><guid>https://php-kafka.github.io/php-simple-kafka-client.github.io/configuration/dump/</guid><description>Description public function dump(): array {} Dumps the current configuration
 Example $conf = new SimpleKafkaClient\Configuration(); $conf-&amp;gt;set(&amp;#39;auto.offset.reset&amp;#39;, &amp;#39;earliest&amp;#39;); $conf-&amp;gt;dump();</description></item><item><title>set</title><link>https://php-kafka.github.io/php-simple-kafka-client.github.io/configuration/set/</link><pubDate>Sun, 27 Dec 2020 22:09:37 +0100</pubDate><guid>https://php-kafka.github.io/php-simple-kafka-client.github.io/configuration/set/</guid><description>Description public function set(string $name, string $value): void {} Set a configuration value
 Example $conf = new SimpleKafkaClient\Configuration(); $conf-&amp;gt;set(&amp;#39;auto.offset.reset&amp;#39;, &amp;#39;earliest&amp;#39;);</description></item><item><title>setDrMsgCb</title><link>https://php-kafka.github.io/php-simple-kafka-client.github.io/configuration/setDrMsgCb/</link><pubDate>Sun, 27 Dec 2020 22:09:37 +0100</pubDate><guid>https://php-kafka.github.io/php-simple-kafka-client.github.io/configuration/setDrMsgCb/</guid><description>Description public function setDrMsgCb(callable $callback): void {} Set a message delivery report callback
 This callback is called exactly once per message, indicating if

configuration/dump/index.html

@@ -1,4 +1,11 @@
-<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Consumer on Documentation of php-simple-kafka-client</title><link>https://php-kafka.github.io/php-simple-kafka-client.github.io/consumer/</link><description>Recent content in Consumer on Documentation of php-simple-kafka-client</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><lastBuildDate>Sun, 27 Dec 2020 22:09:37 +0100</lastBuildDate><atom:link href="https://php-kafka.github.io/php-simple-kafka-client.github.io/consumer/index.xml" rel="self" type="application/rss+xml"/><item><title>__construct</title><link>https://php-kafka.github.io/php-simple-kafka-client.github.io/consumer/__construct/</link><pubDate>Sun, 27 Dec 2020 22:09:37 +0100</pubDate><guid>https://php-kafka.github.io/php-simple-kafka-client.github.io/consumer/__construct/</guid><description>Description public function __construct(Configuration $configuration) {} Get a consumer instance
+<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Consumer on Documentation of php-simple-kafka-client</title><link>https://php-kafka.github.io/php-simple-kafka-client.github.io/consumer/</link><description>Recent content in Consumer on Documentation of php-simple-kafka-client</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><lastBuildDate>Sun, 27 Dec 2020 22:09:37 +0100</lastBuildDate><atom:link href="https://php-kafka.github.io/php-simple-kafka-client.github.io/consumer/index.xml" rel="self" type="application/rss+xml"/><item><title>setOauthBearerToken</title><link>https://php-kafka.github.io/php-simple-kafka-client.github.io/consumer/setOAuthBearerToken/</link><pubDate>Tue, 07 Sep 2021 10:09:37 +0100</pubDate><guid>https://php-kafka.github.io/php-simple-kafka-client.github.io/consumer/setOAuthBearerToken/</guid><description>Description public function setOAuthBearerToken(string $token, int $lifetimeMs, string $principalName, ?array $extensions = null): void {} The SASL/OAUTHBEARER token refresh callback or event handler should invoke
+this method upon success. The extension keys must not include the reserved
+key auth, and all extension keys and values must conform to the required
+format as per https://tools.ietf.org/html/rfc7628#section-3.1
+Example $conf = new SimpleKafkaClient\Configuration(); $conf-&amp;gt;set(&amp;#39;metadata.broker.list&amp;#39;, getenv(&amp;#39;TEST_KAFKA_BROKERS&amp;#39;)); $conf-&amp;gt;set(&amp;#39;security.protocol&amp;#39;, &amp;#39;SASL_PLAINTEXT&amp;#39;); $conf-&amp;gt;set(&amp;#39;sasl.mechanisms&amp;#39;, &amp;#39;OAUTHBEARER&amp;#39;); $conf-&amp;gt;set(&amp;#39;sasl.oauthbearer.config&amp;#39;, &amp;#39;principalClaimName=azp&amp;#39;); $conf-&amp;gt;setOAuthBearerTokenRefreshCb(function($kafka, $oAuthBearerConfig) { // get the refresh token with some custom code, then act accordingly if ($tokenRefreshWasSucessful) { $kafka-&amp;gt;setOAuthBearerToken($token, $lifetimeMs, $principalName, $extensions); } else { $kafka-&amp;gt;setOAuthBearerTokenFailure($errorReason); } });</description></item><item><title>setOauthBearerTokenFailure</title><link>https://php-kafka.github.io/php-simple-kafka-client.github.io/consumer/setOAuthBearerTokenFailure/</link><pubDate>Tue, 07 Sep 2021 10:09:37 +0100</pubDate><guid>https://php-kafka.github.io/php-simple-kafka-client.github.io/consumer/setOAuthBearerTokenFailure/</guid><description>Description public function setOauthBearerTokenFailure(string $errorString): void {} The SASL/OAUTHBEARER token refresh callback or event handler should invoke
+this method upon failure. $errorString should be a human readable error reason
+why acquiring a token failed.
+Example $conf = new SimpleKafkaClient\Configuration(); $conf-&amp;gt;set(&amp;#39;metadata.broker.list&amp;#39;, getenv(&amp;#39;TEST_KAFKA_BROKERS&amp;#39;)); $conf-&amp;gt;set(&amp;#39;security.protocol&amp;#39;, &amp;#39;SASL_PLAINTEXT&amp;#39;); $conf-&amp;gt;set(&amp;#39;sasl.mechanisms&amp;#39;, &amp;#39;OAUTHBEARER&amp;#39;); $conf-&amp;gt;set(&amp;#39;sasl.oauthbearer.config&amp;#39;, &amp;#39;principalClaimName=azp&amp;#39;); $conf-&amp;gt;setOAuthBearerTokenRefreshCb(function($kafka, $oAuthBearerConfig) { // get the refresh token with some custom code, then act accordingly if ($tokenRefreshWasSucessful) { $kafka-&amp;gt;setOAuthBearerToken($token, $lifetimeMs, $principalName, $extensions); } else { $kafka-&amp;gt;setOAuthBearerTokenFailure($errorReason); } });</description></item><item><title>__construct</title><link>https://php-kafka.github.io/php-simple-kafka-client.github.io/consumer/__construct/</link><pubDate>Sun, 27 Dec 2020 22:09:37 +0100</pubDate><guid>https://php-kafka.github.io/php-simple-kafka-client.github.io/consumer/__construct/</guid><description>Description public function __construct(Configuration $configuration) {} Get a consumer instance
 Example $conf = SimpleKafkaClient\Configuration(); $conf-&amp;gt;set(&amp;#39;metadata.broker.list&amp;#39;, &amp;#39;kafka:9092&amp;#39;); $consumer = new SimpleKafkaClient\Consumer($conf);</description></item><item><title>assign</title><link>https://php-kafka.github.io/php-simple-kafka-client.github.io/consumer/assign/</link><pubDate>Sun, 27 Dec 2020 22:09:37 +0100</pubDate><guid>https://php-kafka.github.io/php-simple-kafka-client.github.io/consumer/assign/</guid><description>Description public function assign(array $topics): void {} Atomic assignment of partitions to consume.
 The new partitions will replace the existing assignment.
 Example $conf = SimpleKafkaClient\Configuration(); $conf-&amp;gt;set(&amp;#39;metadata.broker.list&amp;#39;, &amp;#39;kafka:9092&amp;#39;); $consumer = new SimpleKafkaClient\Consumer($conf); $consumer-&amp;gt;assign( [ new SimpleKafkaClient\TopicPartition(&amp;#39;test-topic&amp;#39;, 1, 3000), new SimpleKafkaClient\TopicPartition(&amp;#39;test-topic&amp;#39;, 2, 3009) ] );</description></item><item><title>close</title><link>https://php-kafka.github.io/php-simple-kafka-client.github.io/consumer/close/</link><pubDate>Sun, 27 Dec 2020 22:09:37 +0100</pubDate><guid>https://php-kafka.github.io/php-simple-kafka-client.github.io/consumer/close/</guid><description>Description public function close(): void {} Close down the Consumer. This call will block until