com.fluxtion.agrona.sbe.Flyweight Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of runtime Show documentation
The newest version!
/*
 * Copyright 2014-2024 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 com.fluxtion.agrona.sbe;

import com.fluxtion.agrona.DirectBuffer;

/**
 * An SBE (Simple Binary Encoding) flyweight object.
 */
public interface Flyweight
{
    /**
     * Buffer in which the flyweight is encoded.
     *
     * @return buffer in which the flyweight is encoded.
     */
    DirectBuffer buffer();

    /**
     * Offset within the {@link #buffer()} the flyweight is encoded.
     *
     * @return offset within the {@link #buffer()} the flyweight is encoded.
     */
    int offset();

    /**
     * The length of the encoded type in bytes.
     * 
     * The value is only guaranteed to valid for a {@link DecoderFlyweight} before decoding and after encoding for a
     * {@link EncoderFlyweight}.
     *
     * @return the length of the encoded type in bytes.
     */
    int encodedLength();

    /**
     * The SBE Schema identifier containing the message declaration.
     *
     * @return the SBE Schema identifier containing the message declaration.
     */
    int sbeSchemaId();

    /**
     * The version number of the SBE Schema containing the message.
     *
     * @return the version number of the SBE Schema containing the message.
     */
    int sbeSchemaVersion();
}