kafka-clients-KafkaClient.adoc

KafkaClient

KafkaClient is the abstraction of Kafka clients.

Note	NetworkClient is the one and only known implementation of the KafkaClient Contract in Apache Kafka.

Table 1. KafkaClient Contract

Method	Description
authenticationException	AuthenticationException authenticationException(Node node) Used when…​FIXME
close	void close(String nodeId) Closing the Kafka client (releasing resources) Used when: RequestSendThread is requested to doWork and brokerReady KafkaServer is requested to controlledShutdown ReplicaFetcherBlockingSend is requested to send a client request and wait for a response
connectionDelay	long connectionDelay(Node node, long now) Used when…​FIXME
connectionFailed	boolean connectionFailed(Node node) Used when…​FIXME
disconnect	void disconnect(String nodeId) Used when: AdminClientRunnable is requested to timeoutCallsInFlight and handleResponses ConsumerNetworkClient is requested to handlePendingDisconnects
hasInFlightRequests	boolean hasInFlightRequests() boolean hasInFlightRequests(String nodeId); Used when…​FIXME
hasReadyNodes	boolean hasReadyNodes(long now) Used when…​FIXME
inFlightRequestCount	int inFlightRequestCount() int inFlightRequestCount(String nodeId) Used when…​FIXME
isReady	boolean isReady(Node node, long now) Used when: NetworkClient is requested to ready and leastLoadedNode NetworkClientUtils is requested to isReady and wait until a connection to a broker node is ready
leastLoadedNode	Node leastLoadedNode(long now) Used when: DefaultMetadataUpdater is requested to maybeUpdate ConsumerNetworkClient is requested to leastLoadedNode Sender is requested to awaitLeastLoadedNodeReady LeastLoadedNodeProvider and MetadataUpdateNodeIdProvider are requested to provide the least-loaded node
newClientRequest	ClientRequest newClientRequest( String nodeId, AbstractRequest.Builder<?> requestBuilder, long createdTimeMs, boolean expectResponse) ClientRequest newClientRequest( String nodeId, AbstractRequest.Builder<?> requestBuilder, long createdTimeMs, boolean expectResponse, int requestTimeoutMs, RequestCompletionHandler callback) Creates a new ClientRequest for a given AbstractRequest.Builder and RequestCompletionHandler Used when…​FIXME
poll	List<ClientResponse> poll( long timeout, long now) Used when: InterBrokerSendThread thread is started NetworkClientUtils utility is used to isReady, awaitReady and sendAndReceive AdminClientRunnable thread is started ConsumerNetworkClient is requested to poll and transmitSends Sender thread is started (and runOnce and maybeSendAndPollTransactionalRequest)
pollDelayMs	long pollDelayMs(Node node, long now) Used when…​FIXME
ready	boolean ready(Node node, long now) Initiates a connection to the given broker Node (i.e. a connection to a broker node is ready) Used when: NetworkClientUtils helper object is requested to wait until a connection to a broker node is ready AdminClientRunnable is requested to sendEligibleCalls ConsumerNetworkClient is requested to trySend and tryConnect Sender is requested to sendProducerData (when requested to run a single iteration of sending) InterBrokerSendThread is requested to sendRequests
send	void send(ClientRequest request, long now) Queues up the ClientRequest for sending Used when: InterBrokerSendThread is requested to sendRequests NetworkClientUtils is requested to sendAndReceive AdminClientRunnable is requested to sendEligibleCalls ConsumerNetworkClient is requested to trySend Sender is requested to maybeSendTransactionalRequest and sendProduceRequest
wakeup	void wakeup() Used when…​FIXME