com.twitter.http2.HttpHeaderBlockFrame Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of netty-http2 Show documentation

HTTP/2 for Netty

There is a newer version: 0.17.11

/*
 * Copyright 2015 Twitter, Inc.
 *
 * Licensed 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 com.twitter.http2;

import io.netty.handler.codec.http.HttpHeaders;

public interface HttpHeaderBlockFrame extends HttpStreamFrame {

    /**
     * Returns {@code true} if this header block is invalid.
     * A RST_STREAM frame with code PROTOCOL_ERROR should be sent.
     */
    boolean isInvalid();

    /**
     * Marks this header block as invalid.
     */
    HttpHeaderBlockFrame setInvalid();

    /**
     * Returns {@code true} if this header block has been truncated due to length restrictions.
     */
    boolean isTruncated();

    /**
     * Mark this header block as truncated.
     */
    HttpHeaderBlockFrame setTruncated();

    /**
     * Returns the {@link HttpHeaders} of this frame.
     */
    HttpHeaders headers();
}