/*
 * 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 accord.api;

import accord.local.CommandStore;
import accord.local.SafeCommandStore;
import accord.primitives.PartialTxn;
import accord.primitives.Seekable;
import accord.primitives.Timestamp;
import accord.primitives.TxnId;
import accord.utils.async.AsyncChain;

/**
 * A collection of data to write to one or more stores
 *
 * TODO (desired, efficiency): support splitting so as to minimise duplication of data across shards
 */
public interface Write
{
    AsyncChain<Void> apply(SafeCommandStore safeStore, Seekable key, TxnId txnId, Timestamp executeAt, PartialTxn txn);

    /**
     * Apply the write directly to the underlying data store.
     * This method will only be invoked if {@link ProtocolModifiers.Toggles#fastWritesMayBypassSafeStore()}
     */
    default AsyncChain<Void> applyDirect(CommandStore unsafeStore, Seekable key, TxnId txnId, Timestamp executeAt, PartialTxn txn) { throw new UnsupportedOperationException(); }

    interface InMemoryWrite extends Write
    {
        default AsyncChain<Void> applySync(CommandStore unsafeStore, Seekable key, TxnId txnId, Timestamp executeAt, PartialTxn txn) { throw new UnsupportedOperationException(); }
    }
}
