PlatformCacheExtension.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.ignite.internal.processors.platform.cache;

import org.apache.ignite.IgniteCheckedException;
import org.apache.ignite.internal.binary.BinaryRawReaderEx;
import org.apache.ignite.internal.processors.platform.memory.PlatformMemory;

/**
 * Platform cache extension. Decouples other modules from cache.
 */
public interface PlatformCacheExtension {
    /**
     * Get extension ID. Must be unique among all extensions.
     *
     * @return Extension ID.
     */
    public int id();

    /**
     * Invokes in-out operation with long return type.
     *
     * @param target Target cache.
     * @param type Operation type.
     * @param reader Reader.
     * @param mem Memory.
     * @return Result.
     * @throws IgniteCheckedException If failed.
     */
    long processInOutStreamLong(PlatformCache target, int type, BinaryRawReaderEx reader, PlatformMemory mem)
        throws IgniteCheckedException;
}