ratis-client/src/main/java/org/apache/ratis/client/DataStreamClientFactory.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.ratis.client;

import org.apache.ratis.conf.Parameters;
import org.apache.ratis.conf.RaftProperties;
import org.apache.ratis.datastream.DataStreamFactory;
import org.apache.ratis.datastream.DataStreamType;
import org.apache.ratis.protocol.RaftPeer;

/**
 * A factory to create streaming client.
 */
public interface DataStreamClientFactory extends DataStreamFactory {
  static DataStreamClientFactory newInstance(DataStreamType type, Parameters parameters) {
    final DataStreamFactory dataStreamFactory = type.newClientFactory(parameters);
    if (dataStreamFactory instanceof DataStreamClientFactory) {
      return (DataStreamClientFactory) dataStreamFactory;
    }
    throw new ClassCastException("Cannot cast " + dataStreamFactory.getClass()
        + " to " + DataStreamClientFactory.class + "; stream type is " + type);
  }

  DataStreamClientRpc newDataStreamClientRpc(RaftPeer server, RaftProperties properties);
}