2011-09-26 14:51:15 +02:00
|
|
|
/*
|
2012-06-04 22:31:44 +02:00
|
|
|
* Copyright 2012 The Netty Project
|
2011-09-26 14:51:15 +02:00
|
|
|
*
|
2011-12-09 06:18:34 +01:00
|
|
|
* 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:
|
2011-09-26 14:51:15 +02:00
|
|
|
*
|
2012-06-04 22:31:44 +02:00
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
2011-09-26 14:51:15 +02:00
|
|
|
*
|
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
2011-12-09 06:18:34 +01:00
|
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
2011-09-26 14:51:15 +02:00
|
|
|
* License for the specific language governing permissions and limitations
|
|
|
|
* under the License.
|
|
|
|
*/
|
2011-12-09 04:38:59 +01:00
|
|
|
package io.netty.handler.codec.http.websocketx;
|
2011-09-26 14:51:15 +02:00
|
|
|
|
2012-06-10 04:08:43 +02:00
|
|
|
import io.netty.buffer.ByteBuf;
|
2013-01-11 07:46:56 +01:00
|
|
|
import io.netty.buffer.DefaultByteBufHolder;
|
2013-11-04 11:42:33 +01:00
|
|
|
import io.netty.util.internal.StringUtil;
|
2011-09-26 14:51:15 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Base class for web socket frames
|
|
|
|
*/
|
2013-01-11 07:46:56 +01:00
|
|
|
public abstract class WebSocketFrame extends DefaultByteBufHolder {
|
2011-09-26 14:51:15 +02:00
|
|
|
|
2011-12-15 12:25:40 +01:00
|
|
|
/**
|
|
|
|
* Flag to indicate if this frame is the final fragment in a message. The first fragment (frame) may also be the
|
|
|
|
* final fragment.
|
|
|
|
*/
|
2013-01-11 07:46:56 +01:00
|
|
|
private final boolean finalFragment;
|
2011-09-26 14:51:15 +02:00
|
|
|
|
2011-12-15 12:25:40 +01:00
|
|
|
/**
|
|
|
|
* RSV1, RSV2, RSV3 used for extensions
|
|
|
|
*/
|
2013-01-11 07:46:56 +01:00
|
|
|
private final int rsv;
|
2011-09-26 14:51:15 +02:00
|
|
|
|
2013-01-11 07:46:56 +01:00
|
|
|
protected WebSocketFrame(ByteBuf binaryData) {
|
|
|
|
this(true, 0, binaryData);
|
2011-12-15 12:25:40 +01:00
|
|
|
}
|
2011-09-26 14:51:15 +02:00
|
|
|
|
2013-01-11 07:46:56 +01:00
|
|
|
protected WebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData) {
|
|
|
|
super(binaryData);
|
|
|
|
this.finalFragment = finalFragment;
|
|
|
|
this.rsv = rsv;
|
2011-12-15 12:25:40 +01:00
|
|
|
}
|
2011-10-16 08:01:24 +02:00
|
|
|
|
2011-12-15 12:25:40 +01:00
|
|
|
/**
|
|
|
|
* 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;
|
|
|
|
}
|
2011-10-16 08:01:24 +02:00
|
|
|
|
2011-12-15 12:25:40 +01:00
|
|
|
/**
|
|
|
|
* Bits used for extensions to the standard.
|
|
|
|
*/
|
2013-01-11 07:46:56 +01:00
|
|
|
public int rsv() {
|
2011-12-15 12:25:40 +01:00
|
|
|
return rsv;
|
|
|
|
}
|
2011-11-04 19:28:15 +01:00
|
|
|
|
2013-01-11 07:46:56 +01:00
|
|
|
@Override
|
|
|
|
public abstract WebSocketFrame copy();
|
|
|
|
|
2013-07-06 21:17:51 +02:00
|
|
|
@Override
|
|
|
|
public abstract WebSocketFrame duplicate();
|
|
|
|
|
2013-01-11 07:46:56 +01:00
|
|
|
@Override
|
|
|
|
public String toString() {
|
2013-11-04 11:42:33 +01:00
|
|
|
return StringUtil.simpleClassName(this) + "(data: " + content().toString() + ')';
|
2011-12-15 12:25:40 +01:00
|
|
|
}
|
2011-10-16 08:01:24 +02:00
|
|
|
|
2013-04-21 13:00:50 +02:00
|
|
|
@Override
|
|
|
|
public WebSocketFrame retain() {
|
|
|
|
super.retain();
|
|
|
|
return this;
|
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
|
|
|
public WebSocketFrame retain(int increment) {
|
|
|
|
super.retain(increment);
|
|
|
|
return this;
|
|
|
|
}
|
2011-09-26 14:51:15 +02:00
|
|
|
}
|