io.netty.handler.codec.http.websocketx.WebSocketFrame Maven / Gradle / Ivy
/*
* Copyright 2012 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:
*
* 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.netty.handler.codec.http.websocketx;
import io.netty.buffer.ByteBuf;
import io.netty.buffer.DefaultByteBufHolder;
import io.netty.util.internal.StringUtil;
/**
* Base class for web socket frames
*/
public abstract class WebSocketFrame extends DefaultByteBufHolder {
/**
* Flag to indicate if this frame is the final fragment in a message. The first fragment (frame) may also be the
* final fragment.
*/
private final boolean finalFragment;
/**
* RSV1, RSV2, RSV3 used for extensions
*/
private final int rsv;
protected WebSocketFrame(ByteBuf binaryData) {
this(true, 0, binaryData);
}
protected WebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData) {
super(binaryData);
this.finalFragment = finalFragment;
this.rsv = rsv;
}
/**
* Flag to indicate if this frame is the final fragment in a message. The first fragment (frame) may also be the
* final fragment.
*/
public boolean isFinalFragment() {
return finalFragment;
}
/**
* Bits used for extensions to the standard.
*/
public int rsv() {
return rsv;
}
@Override
public abstract WebSocketFrame copy();
@Override
public abstract WebSocketFrame duplicate();
@Override
public String toString() {
return StringUtil.simpleClassName(this) + "(data: " + contentToString() + ')';
}
@Override
public WebSocketFrame retain() {
super.retain();
return this;
}
@Override
public WebSocketFrame retain(int increment) {
super.retain(increment);
return this;
}
}