Http3CancelPushFrame.java — netty Source File

Source Code

/*
 * Copyright 2020 The Netty Project
 *
 * The Netty Project 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:
 *
 *   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 io.netty.handler.codec.http3;

/**
 * See <a href="https://tools.ietf.org/html/draft-ietf-quic-http-32#section-7.2.3">CANCEL_PUSH</a>.
 */
public interface Http3CancelPushFrame extends Http3ControlStreamFrame {

    @Override
    default long type() {
        return Http3CodecUtils.HTTP3_CANCEL_PUSH_FRAME_TYPE;
    }

    /**
     * Returns the push id that identifies the server push that is being cancelled.
     *
     * @return the id.
     */
    long id();
}