Module: Kafka::Protocol

Overview

Defined Under Namespace

Classes: AddOffsetsToTxnRequest , AddOffsetsToTxnResponse , AddPartitionsToTxnRequest , AddPartitionsToTxnResponse , AlterConfigsRequest , AlterConfigsResponse , ApiVersionsRequest , ApiVersionsResponse , ConsumerGroupProtocol , CreatePartitionsRequest , CreatePartitionsResponse , CreateTopicsRequest , CreateTopicsResponse , Decoder , DeleteTopicsRequest , DeleteTopicsResponse , DescribeConfigsRequest , DescribeConfigsResponse , DescribeGroupsRequest , DescribeGroupsResponse , Encoder , EndTxnRequest , EndTxnResposne , FetchRequest , FetchResponse , FindCoordinatorRequest , FindCoordinatorResponse , HeartbeatRequest , HeartbeatResponse , InitProducerIDRequest , InitProducerIDResponse , JoinGroupRequest , JoinGroupResponse , LeaveGroupRequest , LeaveGroupResponse , ListGroupsRequest , ListGroupsResponse , ListOffsetRequest , ListOffsetResponse , MemberAssignment , Message , MessageSet , MetadataRequest , MetadataResponse , OffsetCommitRequest , OffsetCommitResponse , OffsetFetchRequest , OffsetFetchResponse , ProduceRequest , ProduceResponse , Record , RecordBatch , RequestMessage , SaslHandshakeRequest , SaslHandshakeResponse , SyncGroupRequest , SyncGroupResponse , TxnOffsetCommitRequest , TxnOffsetCommitResponse

Constant Summary collapse

REPLICA_ID =

The replica id of non-brokers is always -1.

-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

APIS =

A mapping from numeric API keys to symbolic API names.

{
 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
}

ERRORS =

A mapping from numeric error codes to exception classes.

{
 -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 
}

RESOURCE_TYPE_UNKNOWN =

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

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_TYPE_GROUP =

Coordinator types. Since Kafka 0.11.0, there are types of coordinators: Group and Transaction

0

COORDINATOR_TYPE_TRANSACTION =

1

Class Method Summary collapse

• .api_name(api_key) ⇒ Symbol

  Returns the symbolic name for an API key.

• .handle_error(error_code, error_message = nil) ⇒ nil

  Handles an error code by either doing nothing (if there was no error) or by raising an appropriate exception.

170
171
172

# File 'lib/kafka/protocol.rb', line 170
def self.api_name(api_key)
 APIS .fetch(api_key, :unknown)
end

156
157
158
159
160
161
162
163
164

# File 'lib/kafka/protocol.rb', line 156
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