Class KafkaConnection

constructor

• new KafkaConnection(options: ConnectionOptions): KafkaConnection

  Parameters

  • options: ConnectionOptions

  Returns KafkaConnection

Readonlyhost

Readonlyport

broker

• get broker(): string

  Broker address as "host:port".

  Returns string

connected

• get connected(): boolean

  Whether the connection is established and not closed.

  Returns boolean

authenticate

• authenticate(): Promise<void>

  Perform SASL authentication if configured.

  Must be called after connect() and before sending any other requests. Uses SaslHandshake (v1) to negotiate the mechanism, then SaslAuthenticate to exchange authentication tokens.

  Returns Promise<void>

  Throws

  If authentication fails.

close

• close(): Promise<void>

  Close the connection and reject all pending requests.

  Returns Promise<void>

connect

• connect(): Promise<void>

  Establish the connection to the broker.

  Returns Promise<void>

  Throws

  If already connected or previously closed.

  Throws

  If the connection times out.

send

• send(
      apiKey: ApiKey,
      apiVersion: number,
      encodeBody: (writer: BinaryWriter) => void,
  ): Promise<BinaryReader>

  Send a request and wait for the correlated response.

  Automatically assigns a correlation ID, encodes the request header, frames the message, and returns a BinaryReader positioned after the response header (ready for API-specific body decoding).

  Parameters

  • apiKey: ApiKey

    API key for the request.

  • apiVersion: number

    API version for the request.

  • encodeBody: (writer: BinaryWriter) => void

    Callback to encode the request body.

  Returns Promise<BinaryReader>

  Reader positioned at the start of the response body.

  Throws

  If not connected.

  Throws

  If the request times out.