io.undertow.server.protocol.framed.SendFrameHeader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of undertow-core Show documentation
There is a newer version: 2.3.18.Final
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2014 Red Hat, Inc., and individual contributors
 * as indicated by the @author tags.
 *
 * 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 io.undertow.server.protocol.framed;

import java.nio.ByteBuffer;

import io.undertow.connector.PooledByteBuffer;

/**
 * @author Stuart Douglas
 */
public class SendFrameHeader {

    private final int reminingInBuffer;
    private final PooledByteBuffer byteBuffer;
    private final boolean anotherFrameRequired;
    private final ByteBuffer trailer;

    public SendFrameHeader(int reminingInBuffer, PooledByteBuffer byteBuffer, boolean anotherFrameRequired) {
        this(reminingInBuffer, byteBuffer, anotherFrameRequired, null);
    }

    public SendFrameHeader(int reminingInBuffer, PooledByteBuffer byteBuffer, boolean anotherFrameRequired, ByteBuffer trailer) {
        this.byteBuffer = byteBuffer;
        this.reminingInBuffer = reminingInBuffer;
        this.anotherFrameRequired = anotherFrameRequired;
        this.trailer = trailer;
    }

    public SendFrameHeader(int reminingInBuffer, PooledByteBuffer byteBuffer) {
        this.byteBuffer = byteBuffer;
        this.reminingInBuffer = reminingInBuffer;
        this.anotherFrameRequired = false;
        this.trailer = null;
    }

    public SendFrameHeader(PooledByteBuffer byteBuffer) {
        this.byteBuffer = byteBuffer;
        this.reminingInBuffer = 0;
        this.anotherFrameRequired = false;
        this.trailer = null;
    }

    /**
     *
     * @return The header byte buffer
     */
    public PooledByteBuffer getByteBuffer() {
        return byteBuffer;
    }

    public ByteBuffer getTrailer() {
        return trailer;
    }

    /**
     *
     * @return
     */
    public int getRemainingInBuffer() {
        return reminingInBuffer;
    }

    /**
     * Returns true if another frame is required after this one. Note that returning false
     * does not mean that this is the last frame. This is used for protocols that require a trailing packet
     * after all data has been written.
     */
    public boolean isAnotherFrameRequired() {
        return anotherFrameRequired;
    }
}