com.firenio.baseio.codec.http11.WebSocketFrame Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of baseio-codec Show documentation
The codec of baseio
There is a newer version: 3.2.9.beta11
/*
 * Copyright 2015 The Baseio Project
 *  
 * 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.firenio.baseio.codec.http11;

import com.firenio.baseio.component.Frame;
import com.firenio.baseio.component.Channel;

public class WebSocketFrame extends Frame {

    private boolean eof;
    private byte    type;

    public WebSocketFrame() {
        this(WebSocketCodec.TYPE_TEXT);
    }

    public WebSocketFrame(byte type) {
        this.type = type;
    }

    @Override
    public String getFrameName() {
        throw new UnsupportedOperationException("use getFrameName(ch) instead");
    }

    public String getFrameName(Channel ch) {
        return (String) ch.getAttribute(WebSocketCodec.CH_KEY_FRAME_NAME);
    }

    public int getType() {
        return type;
    }

    @Override
    public int headerLength() {
        return WebSocketCodec.MAX_HEADER_LENGTH;
    }

    @Override
    public boolean isBinary() {
        return type == WebSocketCodec.TYPE_BINARY;
    }

    public boolean isCloseFrame() {
        return type == WebSocketCodec.TYPE_CLOSE;
    }

    public boolean isContinuationFrame() {
        return type == WebSocketCodec.TYPE_CONTINUE;
    }

    @Override
    public boolean isContinue() {
        // ????????? is that mean ??????
        return isContinuationFrame();
    }

    public boolean isEof() {
        return eof;
    }

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

    @Override
    public boolean isText() {
        return type == WebSocketCodec.TYPE_TEXT;
    }

    @Override
    public WebSocketFrame reset() {
        this.eof = false;
        this.type = 0;
        super.reset();
        return this;
    }

    public void setEof(boolean eof) {
        this.eof = eof;
    }

    @Override
    public Frame setPing() {
        this.type = WebSocketCodec.TYPE_PING;
        return super.setPing();
    }

    @Override
    public Frame setPong() {
        this.type = WebSocketCodec.TYPE_PONG;
        return super.setPong();
    }

    @Override
    public WebSocketFrame setSilent() {
        throw new UnsupportedOperationException();
    }

    public void setType(byte type) {
        this.type = type;
    }

    @Override
    public String toString() {
        if (isText()) {
            return getStringContent();
        }
        return null;
    }

}