src/java/org/apache/cassandra/streaming/StreamConnectionFactory.java

/*
 * 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.cassandra.streaming;

import java.io.IOException;

import io.netty.channel.Channel;
import org.apache.cassandra.net.OutboundConnectionSettings;

public interface StreamConnectionFactory
{
    Channel createConnection(OutboundConnectionSettings template, int messagingVersion) throws IOException;

    /** Provide way to disable getPreferredIP() for tools without access to the system keyspace
     * <p> 
     * CASSANDRA-17663 moves calls to SystemKeyspace.getPreferredIP() outside of any threads
     * that are regularly interrupted.  However the streaming subsystem is also used
     * by the bulk loader tool, which does not have direct access to the local tables
     * and uses the client metadata/queries to retrieve it.
     *
     * @return true if SystemKeyspace.getPreferredIP() should be used when connecting
     */
    default boolean supportsPreferredIp()
    {
        return true;
    }
}