/*
 * ====================================================================
 * 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.http2;

import java.io.InterruptedIOException;

import org.apache.hc.core5.util.Timeout;

/**
 * {@link java.net.SocketTimeoutException} raised when an HTTP/2 stream exceeds its configured timeout.
 * <p>
 * This timeout is scoped to a single stream and is independent of the underlying connection socket timeout.
 * </p>
 *
 * @since 5.5
 */
public class H2StreamTimeoutException extends InterruptedIOException {

    private static final long serialVersionUID = 1L;

    private final int streamId;
    private final Timeout timeout;

    public H2StreamTimeoutException(final String message, final int streamId, final Timeout timeout) {
        super(message);
        this.streamId = streamId;
        this.timeout = timeout;
    }

    public int getStreamId() {
        return streamId;
    }

    public Timeout getTimeout() {
        return timeout;
    }

}
