summaryrefslogtreecommitdiff
path: root/kafka/common.py
diff options
context:
space:
mode:
Diffstat (limited to 'kafka/common.py')
-rw-r--r--kafka/common.py49
1 files changed, 26 insertions, 23 deletions
diff --git a/kafka/common.py b/kafka/common.py
index f40c9fa..8207bec 100644
--- a/kafka/common.py
+++ b/kafka/common.py
@@ -6,43 +6,46 @@ from collections import namedtuple
# Structs #
###############
-# Request payloads
-ProduceRequest = namedtuple("ProduceRequest",
- ["topic", "partition", "messages"])
-
-FetchRequest = namedtuple("FetchRequest",
- ["topic", "partition", "offset", "max_bytes"])
-
-OffsetRequest = namedtuple("OffsetRequest",
- ["topic", "partition", "time", "max_offsets"])
-
-OffsetCommitRequest = namedtuple("OffsetCommitRequest",
- ["topic", "partition", "offset", "metadata"])
-
+# https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol#AGuideToTheKafkaProtocol-MetadataAPI
MetadataRequest = namedtuple("MetadataRequest",
["topics"])
-OffsetFetchRequest = namedtuple("OffsetFetchRequest", ["topic", "partition"])
-
MetadataResponse = namedtuple("MetadataResponse",
["brokers", "topics"])
-# Response payloads
+# https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol#AGuideToTheKafkaProtocol-ProduceAPI
+ProduceRequest = namedtuple("ProduceRequest",
+ ["topic", "partition", "messages"])
+
ProduceResponse = namedtuple("ProduceResponse",
- ["topic", "partition", "error", "offset"])
+ ["topic", "partition", "error", "offset"])
+
+# https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol#AGuideToTheKafkaProtocol-FetchAPI
+FetchRequest = namedtuple("FetchRequest",
+ ["topic", "partition", "offset", "max_bytes"])
-FetchResponse = namedtuple("FetchResponse", ["topic", "partition", "error",
- "highwaterMark", "messages"])
+FetchResponse = namedtuple("FetchResponse",
+ ["topic", "partition", "error", "highwaterMark", "messages"])
+
+# https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol#AGuideToTheKafkaProtocol-OffsetAPI
+OffsetRequest = namedtuple("OffsetRequest",
+ ["topic", "partition", "time", "max_offsets"])
OffsetResponse = namedtuple("OffsetResponse",
- ["topic", "partition", "error", "offsets"])
+ ["topic", "partition", "error", "offsets"])
+
+# https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol#AGuideToTheKafkaProtocol-OffsetCommit/FetchAPI
+OffsetCommitRequest = namedtuple("OffsetCommitRequest",
+ ["topic", "partition", "offset", "metadata"])
OffsetCommitResponse = namedtuple("OffsetCommitResponse",
- ["topic", "partition", "error"])
+ ["topic", "partition", "error"])
+
+OffsetFetchRequest = namedtuple("OffsetFetchRequest",
+ ["topic", "partition"])
OffsetFetchResponse = namedtuple("OffsetFetchResponse",
- ["topic", "partition", "offset",
- "metadata", "error"])
+ ["topic", "partition", "offset", "metadata", "error"])