-
Notifications
You must be signed in to change notification settings - Fork 339
/
Copy pathprotocol.rb
225 lines (215 loc) · 8.35 KB
/
protocol.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
# frozen_string_literal: true
module Kafka
# The protocol layer of the library.
#
# The Kafka protocol (https://kafka.apache.org/protocol) defines a set of API
# requests, each with a well-known numeric API key, as well as a set of error
# codes with specific meanings.
#
# This module, and the classes contained in it, implement the client side of
# the protocol.
module Protocol
# The replica id of non-brokers is always -1.
REPLICA_ID = -1
PRODUCE_API = 0
FETCH_API = 1
LIST_OFFSET_API = 2
TOPIC_METADATA_API = 3
OFFSET_COMMIT_API = 8
OFFSET_FETCH_API = 9
FIND_COORDINATOR_API = 10
JOIN_GROUP_API = 11
HEARTBEAT_API = 12
LEAVE_GROUP_API = 13
SYNC_GROUP_API = 14
DESCRIBE_GROUPS_API = 15
LIST_GROUPS_API = 16
SASL_HANDSHAKE_API = 17
API_VERSIONS_API = 18
CREATE_TOPICS_API = 19
DELETE_TOPICS_API = 20
INIT_PRODUCER_ID_API = 22
ADD_PARTITIONS_TO_TXN_API = 24
ADD_OFFSETS_TO_TXN_API = 25
END_TXN_API = 26
TXN_OFFSET_COMMIT_API = 28
DESCRIBE_CONFIGS_API = 32
ALTER_CONFIGS_API = 33
CREATE_PARTITIONS_API = 37
# A mapping from numeric API keys to symbolic API names.
APIS = {
PRODUCE_API => :produce,
FETCH_API => :fetch,
LIST_OFFSET_API => :list_offset,
TOPIC_METADATA_API => :topic_metadata,
OFFSET_COMMIT_API => :offset_commit,
OFFSET_FETCH_API => :offset_fetch,
FIND_COORDINATOR_API => :find_coordinator,
JOIN_GROUP_API => :join_group,
HEARTBEAT_API => :heartbeat,
LEAVE_GROUP_API => :leave_group,
SYNC_GROUP_API => :sync_group,
SASL_HANDSHAKE_API => :sasl_handshake,
API_VERSIONS_API => :api_versions,
CREATE_TOPICS_API => :create_topics,
DELETE_TOPICS_API => :delete_topics,
INIT_PRODUCER_ID_API => :init_producer_id_api,
ADD_PARTITIONS_TO_TXN_API => :add_partitions_to_txn_api,
ADD_OFFSETS_TO_TXN_API => :add_offsets_to_txn_api,
END_TXN_API => :end_txn_api,
TXN_OFFSET_COMMIT_API => :txn_offset_commit_api,
DESCRIBE_CONFIGS_API => :describe_configs_api,
CREATE_PARTITIONS_API => :create_partitions
}
# A mapping from numeric error codes to exception classes.
ERRORS = {
-1 => UnknownError,
1 => OffsetOutOfRange,
2 => CorruptMessage,
3 => UnknownTopicOrPartition,
4 => InvalidMessageSize,
5 => LeaderNotAvailable,
6 => NotLeaderForPartition,
7 => RequestTimedOut,
8 => BrokerNotAvailable,
9 => ReplicaNotAvailable,
10 => MessageSizeTooLarge,
11 => StaleControllerEpoch,
12 => OffsetMetadataTooLarge,
13 => NetworkException,
14 => CoordinatorLoadInProgress,
15 => CoordinatorNotAvailable,
16 => NotCoordinatorForGroup,
17 => InvalidTopic,
18 => RecordListTooLarge,
19 => NotEnoughReplicas,
20 => NotEnoughReplicasAfterAppend,
21 => InvalidRequiredAcks,
22 => IllegalGeneration,
23 => InconsistentGroupProtocol,
24 => InvalidGroupId,
25 => UnknownMemberId,
26 => InvalidSessionTimeout,
27 => RebalanceInProgress,
28 => InvalidCommitOffsetSize,
29 => TopicAuthorizationFailed,
30 => GroupAuthorizationFailed,
31 => ClusterAuthorizationFailed,
32 => InvalidTimestamp,
33 => UnsupportedSaslMechanism,
34 => InvalidSaslState,
35 => UnsupportedVersion,
36 => TopicAlreadyExists,
37 => InvalidPartitions,
38 => InvalidReplicationFactor,
39 => InvalidReplicaAssignment,
40 => InvalidConfig,
41 => NotController,
42 => InvalidRequest,
43 => UnsupportedForMessageFormat,
44 => PolicyViolation,
45 => OutOfOrderSequenceNumberError,
46 => DuplicateSequenceNumberError,
47 => InvalidProducerEpochError,
48 => InvalidTxnStateError,
49 => InvalidProducerIDMappingError,
50 => InvalidTransactionTimeoutError,
51 => ConcurrentTransactionError,
52 => TransactionCoordinatorFencedError
}
# A mapping from int to corresponding resource type in symbol.
# https://github.com/apache/kafka/blob/trunk/clients/src/main/java/org/apache/kafka/common/resource/ResourceType.java
RESOURCE_TYPE_UNKNOWN = 0
RESOURCE_TYPE_ANY = 1
RESOURCE_TYPE_TOPIC = 2
RESOURCE_TYPE_GROUP = 3
RESOURCE_TYPE_CLUSTER = 4
RESOURCE_TYPE_TRANSACTIONAL_ID = 5
RESOURCE_TYPE_DELEGATION_TOKEN = 6
RESOURCE_TYPES = {
RESOURCE_TYPE_UNKNOWN => :unknown,
RESOURCE_TYPE_ANY => :any,
RESOURCE_TYPE_TOPIC => :topic,
RESOURCE_TYPE_GROUP => :group,
RESOURCE_TYPE_CLUSTER => :cluster,
RESOURCE_TYPE_TRANSACTIONAL_ID => :transactional_id,
RESOURCE_TYPE_DELEGATION_TOKEN => :delegation_token,
}
# Coordinator types. Since Kafka 0.11.0, there are types of coordinators:
# Group and Transaction
COORDINATOR_TYPE_GROUP = 0
COORDINATOR_TYPE_TRANSACTION = 1
# Handles an error code by either doing nothing (if there was no error) or
# by raising an appropriate exception.
#
# @param error_code Integer
# @raise [ProtocolError]
# @return [nil]
def self.handle_error(error_code, error_message = nil)
if error_code == 0
# No errors, yay!
elsif error = ERRORS[error_code]
raise error, error_message
else
raise UnknownError, "Unknown error with code #{error_code} #{error_message}"
end
end
# Returns the symbolic name for an API key.
#
# @param api_key Integer
# @return [Symbol]
def self.api_name(api_key)
APIS.fetch(api_key, :unknown)
end
end
end
require "kafka/protocol/metadata_request"
require "kafka/protocol/metadata_response"
require "kafka/protocol/produce_request"
require "kafka/protocol/produce_response"
require "kafka/protocol/fetch_request"
require "kafka/protocol/fetch_response"
require "kafka/protocol/list_offset_request"
require "kafka/protocol/list_offset_response"
require "kafka/protocol/add_offsets_to_txn_request"
require "kafka/protocol/add_offsets_to_txn_response"
require "kafka/protocol/txn_offset_commit_request"
require "kafka/protocol/txn_offset_commit_response"
require "kafka/protocol/find_coordinator_request"
require "kafka/protocol/find_coordinator_response"
require "kafka/protocol/join_group_request"
require "kafka/protocol/join_group_response"
require "kafka/protocol/sync_group_request"
require "kafka/protocol/sync_group_response"
require "kafka/protocol/leave_group_request"
require "kafka/protocol/leave_group_response"
require "kafka/protocol/heartbeat_request"
require "kafka/protocol/heartbeat_response"
require "kafka/protocol/offset_fetch_request"
require "kafka/protocol/offset_fetch_response"
require "kafka/protocol/offset_commit_request"
require "kafka/protocol/offset_commit_response"
require "kafka/protocol/api_versions_request"
require "kafka/protocol/api_versions_response"
require "kafka/protocol/sasl_handshake_request"
require "kafka/protocol/sasl_handshake_response"
require "kafka/protocol/create_topics_request"
require "kafka/protocol/create_topics_response"
require "kafka/protocol/delete_topics_request"
require "kafka/protocol/delete_topics_response"
require "kafka/protocol/describe_configs_request"
require "kafka/protocol/describe_configs_response"
require "kafka/protocol/alter_configs_request"
require "kafka/protocol/alter_configs_response"
require "kafka/protocol/create_partitions_request"
require "kafka/protocol/create_partitions_response"
require "kafka/protocol/list_groups_request"
require "kafka/protocol/list_groups_response"
require "kafka/protocol/describe_groups_request"
require "kafka/protocol/describe_groups_response"
require "kafka/protocol/init_producer_id_request"
require "kafka/protocol/init_producer_id_response"
require "kafka/protocol/add_partitions_to_txn_request"
require "kafka/protocol/add_partitions_to_txn_response"
require "kafka/protocol/end_txn_request"
require "kafka/protocol/end_txn_response"