save work

Author: nick-zh

content/about/_index.md

@@ -3,5 +3,11 @@ title: "About"
 date: 2020-12-27T22:09:37+01:00
 draft: false
 ---
+
+[![Supported librdkafka versions: >= 1.4.0](https://img.shields.io/badge/librdkafka-%3E%3D%201.4.0-blue.svg)](https://github.com/edenhill/librdkafka/releases)
+[![Supported Kafka versions: >= 0.9](https://img.shields.io/badge/kafka-%3E%3D%200.9-blue.svg)](https://github.com/edenhill/librdkafka/blob/master/INTRODUCTION.md#broker-version-compatibility)
+![Supported PHP versions: 7.x .. 8.x](https://img.shields.io/badge/php-7.x%20..%208.x-blue.svg)
+[![License: BSD-3](https://img.shields.io/badge/License-BSD--3-green.svg)](https://github.com/php-kafka/php-kafka/blob/main/LICENSE)
+
 This extension provides ways to interact with Apache Kafka.  
 It uses [librdkafka](https://github.com/edenhill/librdkafka) for binding and was inspired by [php-rdkafka](https://github.com/arnaud-lb/php-rdkafka).  

content/consumer/__construct.md

@@ -0,0 +1,16 @@
+---
+title: "__construct"
+date: 2020-12-27T22:09:37+01:00
+draft: false
+---
+## Description
+```php
+public function __construct(Configuration $configuration) {}
+```
+Get a consumer instance
+## Example
+```php
+$conf = Kafka\Configuration();
+$conf->set('metadata.broker.list', 'kafka:9092');
+$consumer = new Kafka\Consumer($conf);
+```

content/consumer/assign.md

@@ -0,0 +1,23 @@
+---
+title: "assign"
+date: 2020-12-27T22:09:37+01:00
+draft: false
+---
+## Description
+```php
+public function assign(array $topics): void {}
+```
+Atomic assignment of partitions to consume.  
+The new `partitions` will replace the existing assignment.
+## Example
+```php
+$conf = Kafka\Configuration();
+$conf->set('metadata.broker.list', 'kafka:9092');
+$consumer = new Kafka\Consumer($conf);
+$consumer->assign(
+    [
+        new Kafka\TopicPartition('test-topic', 1, 3000),
+        new Kafka\TopicPartition('test-topic', 2, 3009)
+    ]
+);
+```

content/consumer/close.md

@@ -0,0 +1,19 @@
+---
+title: "close"
+date: 2020-12-27T22:09:37+01:00
+draft: false
+---
+## Description
+```php
+public function close(): void {}
+```
+Close down the Consumer. This call will block until  
+the consumer has revoked its assignment, calling the rebalance callback  
+if it is configured, committed offsets to broker, and left the consumer group. The maximum blocking time is roughly limited to session.timeout.ms.
+## Example
+```php
+$conf = Kafka\Configuration();
+$conf->set('metadata.broker.list', 'kafka:9092');
+$consumer = new Kafka\Consumer($conf);
+$consumer->close();
+```

content/consumer/commit.md

@@ -0,0 +1,33 @@
+---
+title: "commit"
+date: 2020-12-27T22:09:37+01:00
+draft: false
+---
+## Description
+```php
+/**
+ * @throws Kafka\Exception
+ */
+public function commit($messageOrOffsets): void {}
+```
+Commit offsets synchronously, block until offsets are  
+committed or the commit fails and an exception is thrown.
+## Parameter details
+- If `null` is passed, latest offsets for the current assignment will be committed
+- Ìf a `Kafka\Message` is passed, commit offset for a single topic+partition based on the message
+- If an array of `Kafka\TopicPartition` is passed, commit offsets for the provided list of partitions
+
+## Example
+```php
+$conf = Kafka\Configuration();
+$conf->set('metadata.broker.list', 'kafka:9092');
+$consumer = new Kafka\Consumer($conf);
+$message = $consumer->consume(20000);
+
+if (RD_KAFKA_RESP_ERR_NO_ERROR !== $message->err) {
+    echo 'An error occured:' . rd_kafka_err2str($message->err) . PHP_EOL;
+    return;
+}
+
+$consumer->commit($message);
+```

content/consumer/commitAsync.md

@@ -0,0 +1,29 @@
+---
+title: "commitAsync"
+date: 2020-12-27T22:09:37+01:00
+draft: false
+---
+## Description
+```php
+public function commitAsync($messageOrOffsets): void {}
+```
+Commit offsets asynchronously
+## Parameter details
+- If `null` is passed, latest offsets for the current assignment will be committed
+- Ìf a `Kafka\Message` is passed, commit offset for a single topic+partition based on the message
+- If an array of `Kafka\TopicPartition` is passed, commit offsets for the provided list of partitions
+
+## Example
+```php
+$conf = Kafka\Configuration();
+$conf->set('metadata.broker.list', 'kafka:9092');
+$consumer = new Kafka\Consumer($conf);
+$message = $consumer->consume(20000);
+
+if (RD_KAFKA_RESP_ERR_NO_ERROR !== $message->err) {
+    echo 'An error occured:' . rd_kafka_err2str($message->err) . PHP_EOL;
+    return;
+}
+
+$consumer->commitAsync($message);
+```

content/consumer/consume.md

@@ -3,4 +3,21 @@ title: "consume"
 date: 2020-12-27T22:09:37+01:00
 draft: false
 ---
-asdfasf sf as fsd
+## Description
+```php
+public function consume(int $timeoutMs): Message {}
+```
+Consume message(s) (will also get error events and triggers callbacks)  
+Registered callbacks will be automaically called `rebalanceCallback`, `logCallback`, etc.  
+On error `$message->err` will not be `RD_KAFKA_ERR_NO_ERROR` but contain the acutal error code.
+## Example
+```php
+$conf = Kafka\Configuration();
+$conf->set('metadata.broker.list', 'kafka:9092');
+$consumer = new Kafka\Consumer($conf);
+$message = $consumer->consume(20000);
+```
+{{< hint info >}}
+An application should call consume() at regular intervals, even if no messages  
+are expected, to serve any queued callbacks waiting to be called.
+{{< /hint >}}

content/consumer/getAssignment.md

@@ -0,0 +1,14 @@
+---
+title: "getAssignment"
+date: 2020-12-27T22:09:37+01:00
+draft: false
+---
+## Description
+```php
+
+```
+asdf
+## Example
+```php
+
+```

content/consumer/getCommittedOffsets.md

@@ -0,0 +1,14 @@
+---
+title: "getCommittedOffsets"
+date: 2020-12-27T22:09:37+01:00
+draft: false
+---
+## Description
+```php
+
+```
+asdf
+## Example
+```php
+
+```

content/consumer/getMetadata.md

@@ -0,0 +1,14 @@
+---
+title: "getMetadata"
+date: 2020-12-27T22:09:37+01:00
+draft: false
+---
+## Description
+```php
+
+```
+asdf
+## Example
+```php
+
+```

content/consumer/getOffsetPositions.md

@@ -0,0 +1,14 @@
+---
+title: "getOffsetPositions"
+date: 2020-12-27T22:09:37+01:00
+draft: false
+---
+## Description
+```php
+
+```
+asdf
+## Example
+```php
+
+```

content/consumer/getSubscription.md

@@ -0,0 +1,14 @@
+---
+title: "getSubscription"
+date: 2020-12-27T22:09:37+01:00
+draft: false
+---
+## Description
+```php
+
+```
+asdf
+## Example
+```php
+
+```

content/consumer/getTopicHandle.md

@@ -0,0 +1,14 @@
+---
+title: "getTopicHandle"
+date: 2020-12-27T22:09:37+01:00
+draft: false
+---
+## Description
+```php
+
+```
+asdf
+## Example
+```php
+
+```

content/consumer/offsetForTimes.md

@@ -0,0 +1,14 @@
+---
+title: "offsetsForTimes"
+date: 2020-12-27T22:09:37+01:00
+draft: false
+---
+## Description
+```php
+
+```
+asdf
+## Example
+```php
+
+```

content/consumer/queryWatermarkOffsets.md

@@ -0,0 +1,14 @@
+---
+title: "queryWatermarkOffsets"
+date: 2020-12-27T22:09:37+01:00
+draft: false
+---
+## Description
+```php
+
+```
+asdf
+## Example
+```php
+
+```

content/consumer/subscribe.md

@@ -0,0 +1,14 @@
+---
+title: "subscribe"
+date: 2020-12-27T22:09:37+01:00
+draft: false
+---
+## Description
+```php
+
+```
+asdf
+## Example
+```php
+
+```

content/consumer/unsubscribe.md

@@ -0,0 +1,14 @@
+---
+title: "unsubscribe"
+date: 2020-12-27T22:09:37+01:00
+draft: false
+---
+## Description
+```php
+
+```
+asdf
+## Example
+```php
+
+```