kafka-common-network-KafkaChannel.adoc

KafkaChannel

KafkaChannel is created when ChannelBuilders are requested to build one (i.e. PlaintextChannelBuilder, SaslChannelBuilder, and SslChannelBuilder).

Creating KafkaChannel Instance

KafkaChannel takes the following to be created:

• Identifier

• TransportLayer

• (Supplier of) Authenticator

• maxReceiveSize

• MemoryPool

KafkaChannel initializes the internal properties.

KafkaChannel and Authenticator

Authenticator authenticator

authenticator is a Authenticator that is created when KafkaChannel is and requested to swapAuthenticatorsAndBeginReauthentication.

Used for principal, prepare, completeCloseOnAuthenticationFailure, ready, maybeBeginServerReauthentication, maybeBeginClientReauthentication, reauthenticationLatencyMs, serverAuthenticationSessionExpired, getAndClearResponsesReceivedDuringReauthentication, connectedClientSupportsReauthentication, and swapAuthenticatorsAndBeginReauthentication

Closed when KafkaChannel is requested to close.

prepare Method

void prepare()

prepare…​FIXME

Note	prepare is used when…​FIXME

ready Method

boolean ready()

ready is positive (true) when the TransportLayer is ready and the Authenticator is complete

Note	ready is used when…​FIXME

principal Method

KafkaPrincipal principal()

principal simply requests the Authenticator for the principal.

Note	principal is used when…​FIXME

maybeBeginClientReauthentication Method

boolean maybeBeginClientReauthentication(
  Supplier<Long> nowNanosSupplier)

maybeBeginClientReauthentication…​FIXME

Note	maybeBeginClientReauthentication is used when…​FIXME

Internal Properties

Name	Description
transportLayer	TransportLayer