org.apache.kafka.common.network.Selectable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kafka-clients Show documentation
Kafka client whose producer requires explicit encoders.
The newest version!
/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.kafka.common.network;

import java.io.IOException;
import java.net.InetSocketAddress;
import java.util.List;

/**
 * An interface for asynchronous, multi-channel network I/O
 */
public interface Selectable {

    /**
     * Begin establishing a socket connection to the given address identified by the given address
     * @param id The id for this connection
     * @param address The address to connect to
     * @param sendBufferSize The send buffer for the socket
     * @param receiveBufferSize The receive buffer for the socket
     * @throws IOException If we cannot begin connecting
     */
    public void connect(int id, InetSocketAddress address, int sendBufferSize, int receiveBufferSize) throws IOException;

    /**
     * Begin disconnecting the connection identified by the given id
     */
    public void disconnect(int id);

    /**
     * Wakeup this selector if it is blocked on I/O
     */
    public void wakeup();

    /**
     * Close this selector
     */
    public void close();

    /**
     * Initiate any sends provided, and make progress on any other I/O operations in-flight (connections,
     * disconnections, existing sends, and receives)
     * @param timeout The amount of time to block if there is nothing to do
     * @param sends The new sends to initiate
     * @throws IOException
     */
    public void poll(long timeout, List sends) throws IOException;

    /**
     * The list of sends that completed on the last {@link #poll(long, List) poll()} call.
     */
    public List completedSends();

    /**
     * The list of receives that completed on the last {@link #poll(long, List) poll()} call.
     */
    public List completedReceives();

    /**
     * The list of connections that finished disconnecting on the last {@link #poll(long, List) poll()}
     * call.
     */
    public List disconnected();

    /**
     * The list of connections that completed their connection on the last {@link #poll(long, List) poll()}
     * call.
     */
    public List connected();

}