Skip to content

Commit 48d7eaa

Browse files
committed
Add Serializer, Partitioner, ConsumerRebalanceListener
1 parent ddb104c commit 48d7eaa

4 files changed

Lines changed: 43 additions & 0 deletions

File tree

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
ConsumerRebalanceListener
2+
=========================
3+
4+
.. autoclass:: kafka.ConsumerRebalanceListener
5+
:members:
6+
:undoc-members:
7+
8+
.. autoclass:: kafka.AsyncConsumerRebalanceListener
9+
:members:
10+
:undoc-members:

docs/apidoc/misc/Partitioner.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Partitioner
2+
===========
3+
4+
.. autoclass:: kafka.partitioner.Partitioner
5+
:members:
6+
:undoc-members:

docs/apidoc/misc/Serializer.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Serializer
2+
==========
3+
4+
.. autoclass:: kafka.Serializer
5+
:members:
6+
:undoc-members:
7+
8+
.. autoclass:: kafka.Deserializer
9+
:members:
10+
:undoc-members:
11+
12+
.. autoclass:: kafka.JsonSerializer
13+
:members:
14+
:undoc-members:
15+
16+
.. autoclass:: kafka.DefaultSerializer
17+
:members:
18+
:undoc-members:

docs/apidoc/modules.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,12 @@ working with the lower-level protocol layer).
8080
``(offset, metadata, leader_epoch)``.
8181
- :class:`~kafka.OffsetSpec` - enum for partition offset queries.
8282
- :class:`~kafka.IsolationLevel` - enum for transactional isolation.
83+
- :class:`~kafka.Serializer` - base class for serialization / deserialization
84+
of key and value bytes. Includes helper classes `~kafka.DefaultSerializer`
85+
and `~kafka.JsonSerializer`.
86+
- :class:`~kafka.ConsumerRebalanceListener` - base class for consumer
87+
class to receive join/rebalance group hooks. Also includes async
88+
interface `~kafka.AsyncConsumerRebalanceListener`.
8389

8490
.. toctree::
8591
:maxdepth: 1
@@ -90,3 +96,6 @@ working with the lower-level protocol layer).
9096
OffsetAndMetadata <misc/OffsetAndMetadata>
9197
OffsetSpec <misc/OffsetSpec>
9298
IsolationLevel <misc/IsolationLevel>
99+
Serializer <misc/Serializer>
100+
ConsumerRebalanceListener <misc/ConsumerRebalanceListener>
101+
Partitioner <misc/Partitioner>

0 commit comments

Comments
 (0)