/*
 * ====================================================================
 * 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.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */
package org.apache.hc.core5.websocket;

import java.nio.ByteBuffer;

public interface WebSocketExtension {

    String getName();

    default boolean usesRsv1() {
        return false;
    }

    default boolean usesRsv2() {
        return false;
    }

    default boolean usesRsv3() {
        return false;
    }

    default ByteBuffer decode(
            final WebSocketFrameType type,
            final boolean fin,
            final ByteBuffer payload) throws WebSocketException {
        return payload;
    }

    /**
     * Decode a frame payload, aborting as soon as the produced output exceeds
     * {@code maxOutputSize}. A non-positive limit means no limit. Implementations
     * that may expand input (e.g. permessage-deflate) MUST honour the limit during
     * the expansion step, not only after it, to prevent decompression-bomb attacks.
     *
     * @since 5.7
     */
    default ByteBuffer decode(
            final WebSocketFrameType type,
            final boolean fin,
            final ByteBuffer payload,
            final long maxOutputSize) throws WebSocketException {
        return decode(type, fin, payload);
    }

    default ByteBuffer encode(
            final WebSocketFrameType type,
            final boolean fin,
            final ByteBuffer payload) throws WebSocketException {
        return payload;
    }

    default WebSocketExtensionData getResponseData() {
        return new WebSocketExtensionData(getName(), null);
    }

    /**
     * Releases any native resources held by this extension (e.g. a {@code Deflater} or
     * {@code Inflater}). Called once when the owning session terminates.
     *
     * @since 5.7
     */
    default void close() {
    }
}
