com.fireflysource.net.websocket.common.frame.DataFrame Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of firefly-net Show documentation

There is a newer version: 5.0.2

package com.fireflysource.net.websocket.common.frame;

import com.fireflysource.net.websocket.common.model.OpCode;

/**
 * A Data Frame
 */
public class DataFrame extends WebSocketFrame {
    protected DataFrame(byte opcode) {
        super(opcode);
    }

    /**
     * Construct new DataFrame based on headers of provided frame.
     * 
     * Useful for when working in extensions and a new frame needs to be created.
     *
     * @param basedOn the frame this one is based on
     */
    public DataFrame(Frame basedOn) {
        this(basedOn, false);
    }

    /**
     * Construct new DataFrame based on headers of provided frame, overriding for continuations if needed.
     * 
     * Useful for when working in extensions and a new frame needs to be created.
     *
     * @param basedOn      the frame this one is based on
     * @param continuation true if this is a continuation frame
     */
    public DataFrame(Frame basedOn, boolean continuation) {
        super(basedOn.getOpCode());
        copyHeaders(basedOn);
        if (continuation) {
            setOpCode(OpCode.CONTINUATION);
        }
    }

    @Override
    public void assertValid() {
        /* no extra validation for data frames (yet) here */
    }

    @Override
    public boolean isControlFrame() {
        return false;
    }

    @Override
    public boolean isDataFrame() {
        return true;
    }

}