/*
 * 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.tomcat.websocket;

import java.io.IOException;

/**
 * Exception thrown when the WebSocket buffer size is insufficient.
 */
public class ReadBufferOverflowException extends IOException {

    private static final long serialVersionUID = 1L;

    /** The minimum buffer size required. */
    private final int minBufferSize;

    /**
     * Constructs a {@code ReadBufferOverflowException} with the specified
     * minimum buffer size.
     *
     * @param minBufferSize The minimum buffer size required
     */
    public ReadBufferOverflowException(int minBufferSize) {
        this.minBufferSize = minBufferSize;
    }

    /**
     * Returns the minimum buffer size required to handle the data.
     *
     * @return The minimum buffer size
     */
    public int getMinBufferSize() {
        return minBufferSize;
    }
}
