org.agrona.checksum.Checksum Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of agrona Show documentation

High performance primitives and utility library.

The newest version!

/*
 * Copyright 2014-2025 Real Logic Limited.
 *
 * Licensed 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
 *
 * https://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.agrona.checksum;

/**
 * An interface representing API to compute a data checksum.
 * 
 * Note: Instances should be threadsafe and stateless.
 */
@FunctionalInterface
public interface Checksum
{
    /**
     * Computes a checksum based on the contents of a {@code java.nio.DirectByteBuffer}.
     *
     * @param address of the buffer.
     * @param offset  within the buffer to begin at.
     * @param length  of the data to read.
     * @return computed checksum value.
     */
    int compute(long address, int offset, int length);
}