Kafunk


Protocol

Namespace: Kafunk

The Kafka RPC protocol.

Nested types and modules

TypeDescription
AbortedTransaction
ApiKey
ApiVersion
ApiVersionsRequest
ApiVersionsResponse
AssignmentStrategyName
Attributes

Kafka message attributes.

Broker

A Kafka broker consists of a node id, host name and TCP port.

ClientHost
ClientId

A client id.

CompressionCodec

Byte flag indicating compression codec in use.

ConsumerGroup

The id of the consumer group (same as GroupId).

ConsumerGroupGenerationId
ConsumerGroupMemberAssignment

MemberAssignment for the consumer group protocol. Each member in the group will receive the assignment from the leader in the sync group response.

ConsumerGroupProtocolMetadata

ProtocolMetadata for the consumer group protocol.

ConsumerGroupProtocolMetadataVersion
ConsumerId
CoordinatorHost

A Kafka group coordinator host name.

CoordinatorId

A Kafka group coordinator id.

CoordinatorPort

A Kafka group coordinator TCP port.

CorrelationId

A correlation id of a Kafka request-response transaction.

CorruptCrc32Exception

Raised when the received message CRC32 is different from the computed CRC32.

Crc

Crc digest of a Kafka message.

DescribeGroupsRequest
DescribeGroupsResponse
ErrorCode

A Kafka error code.

ErrorMessage
FetchOffset

The offset to begin this fetch from.

FetchRequest
FetchResponse
FirstOffset

First offset in an AbortedTransaction

GenerationId

An id of a Kafka group protocol generation.

GroupAssignment
GroupCoordinatorRequest

The offsets for a given consumer group are maintained by a specific broker called the group coordinator. i.e., a consumer needs to issue its offset commit and fetch requests to this specific broker. It can discover the current coordinator by issuing a group coordinator request. Can be routed to any node in the bootstrap list.

GroupCoordinatorResponse
GroupId

A Kafka group id.

GroupMembers
GroupProtocol
GroupProtocols
HeartbeatRequest

Sent by a consumer to the group coordinator.

HeartbeatResponse

Heartbeat response from the group coordinator.

HighwaterMarkOffset

The offset at the end of the log for this partition. This can be used by the client to determine how many messages behind the end of the log they are.

Host

A Kafka host name.

IsolationLevel

This controls visibility of transactional records. If set to 0, makes all records visible. If set to 1, separates aborted transactions so they can be discarded.

Isr

Node ids of in-sync replicas.

JoinGroupRequest
JoinGroupResponse
Key

A Kafka message key (bytes).

LastStableOffset

The last offset such that the state of all transactional records prior to this offset have been decided (ABORTED or COMMITTED)

Leader

The id of the leader node.

LeaderId

The id of a group leader.

LeaveGroupRequest

An explicit request to leave a group. Preferred over session timeout.

LeaveGroupResponse
ListGroupsRequest
ListGroupsResponse
LogStartOffset

The earliest available offset for a partition.

MagicByte
MaxBytes

The maximum bytes to include in the message set for this partition. This helps bound the size of the response.

MaxNumberOfOffsets
MaxVersion
MaxWaitTime

The max wait time is the maximum amount of time in milliseconds to block waiting if insufficient data is available at the time the request is issued.

MemberAssignment

A byte[] representing member assignment of a particular Kafka group protocol.

MemberId
MemberMetadata

Metadata associated with a Kafka group member.

Members
Message

A Kafka message type used for producing and fetching.

MessageSet
MessageSetItem
MessageSetSize

The size, in bytes, of the message set that follows.

MessageSize

The size of a Kafka message.

MessageTooBigException

Raised when the message is bigger than the message set and therefore can't be received.

Meta
MetadataRequest

Request metadata on all or a specific set of topics. Can be routed to any node in the bootstrap list.

MetadataResponse

Contains a list of all brokers (node id, host, post) and assignment of topic/partitions to brokers. The assignment consists of a leader, a set of replicas and a set of in-sync replicas.

MinBytes

This is the minimum number of bytes of messages that must be available to give a response.

MinVersion
NodeId

An id of a Kafka node.

Offset

A Kafka topic offset.

OffsetCommitRequest
OffsetCommitResponse
OffsetFetchRequest
OffsetFetchResponse
OffsetRequest

A request to return offset information for a set of topics on a specific replica.

OffsetResponse
Partition
PartitionAssignment
PartitionErrorCode
PartitionMetadata
PartitionOffsets
Port

A Kafka host port number

ProduceRequest
ProduceRequestPartitionMessageSet
ProduceRequestTopicMessageSet
ProduceResponse

A reponse to a produce request.

ProduceResponsePartitionItem
ProduceResponseTopicItem
ProducerId

Producer id associated with an AbortedTransaction

Protocol
ProtocolMetadata
ProtocolName
ProtocolType
RebalanceTimeout
ReplicaId

The replica id indicates the node id of the replica initiating this request. Normal client consumers should always specify this as -1.

Replicas

Node ids of replicas.

Request

A Kafka request envelope.

RequestMessage

A Kafka request message.

RequiredAcks

This field indicates how many acknowledgements the servers should receive before responding to the request.

Response

A Kafka response envelope.

ResponseMessage

A Kafka response message.

RetentionTime
SessionTimeout
State
SyncGroupRequest

The sync group request is used by the group leader to assign state (e.g. partition assignments) to all members of the current generation. All members send SyncGroup immediately after joining the group, but only the leader provides the group's assignment.

SyncGroupResponse
ThrottleTime

Duration in milliseconds for which the request was throttled due to quota violation.

Time

Used to ask for all messages before a certain time (ms).

Timeout

This provides a maximum time in milliseconds the server can await the receipt of the number of acknowledgements in RequiredAcks.

Timestamp

The timestamp of a message.

TopicErrorCode
TopicMetadata

Metadata for a specific topic consisting of a set of partition-to-broker assignments.

TopicName

A name of a Kafka topic.

TransactionalId
Value

A Kafka message value (bytes).

ModuleDescription
CompressionCodec
ErrorCode
ProtocolType
RequiredAcks

Required acks options.

Time
Fork me on GitHub