ratis-server-api/src/main/java/org/apache/ratis/server/DataStreamMap.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.server;

import org.apache.ratis.protocol.ClientInvocationId;
import org.apache.ratis.statemachine.StateMachine.DataStream;

import java.util.concurrent.CompletableFuture;
import java.util.function.Function;

/** A {@link ClientInvocationId}-to-{@link DataStream} map. */
public interface DataStreamMap {
  /** Similar to {@link java.util.Map#computeIfAbsent(Object, Function)}. */
  CompletableFuture<DataStream> computeIfAbsent(ClientInvocationId invocationId,
      Function<ClientInvocationId, CompletableFuture<DataStream>> newDataStream);

  /** Similar to {@link java.util.Map#remove(java.lang.Object). */
  CompletableFuture<DataStream> remove(ClientInvocationId invocationId);
}