io.kroxylicious.test.codec.Frame Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kroxylicious-integration-test-support Show documentation

Support code to simplify writing integration tests for filters

There is a newer version: 0.9.0

Show newest version

/*
 * Copyright Kroxylicious Authors.
 *
 * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
 */
package io.kroxylicious.test.codec;

/**
 * A frame in the Kafka protocol, which may or may not be fully decoded.
 */
public interface Frame {

    /**
     * Estimate the expected encoded size of this {@code Frame}.

     * In particular, written data by {@link #encode(ByteBufAccessor)} should be the same as reported by this method.
     * @return the expected encoded size in bytes
     */
    int estimateEncodedSize();

    /**
     * Write the frame, including the size prefix, to the given buffer
     * @param out The output buffer
     */
    void encode(ByteBufAccessor out);

    /**
     * The correlation id.
     * @return The correlation id.
     */
    int correlationId();

}