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;
|
2012-06-11 10:02:00 +02:00
|
|
|
import io.netty.buffer.Unpooled;
|
2011-12-09 04:38:59 +01:00
|
|
|
import io.netty.util.CharsetUtil;
|
2011-09-26 14:51:15 +02:00
|
|
|
|
|
|
|
/**
|
2019-03-22 14:48:22 +01:00
|
|
|
* Web Socket text frame.
|
2011-09-26 14:51:15 +02:00
|
|
|
*/
|
|
|
|
public class TextWebSocketFrame extends WebSocketFrame {
|
|
|
|
|
2011-12-15 12:25:40 +01:00
|
|
|
/**
|
|
|
|
* Creates a new empty text frame.
|
|
|
|
*/
|
|
|
|
public TextWebSocketFrame() {
|
2013-01-11 07:46:56 +01:00
|
|
|
super(Unpooled.buffer(0));
|
2011-12-15 12:25:40 +01:00
|
|
|
}
|
2011-09-26 14:51:15 +02:00
|
|
|
|
2011-12-15 12:25:40 +01:00
|
|
|
/**
|
|
|
|
* Creates a new text frame with the specified text string. The final fragment flag is set to true.
|
2012-05-31 21:03:01 +02:00
|
|
|
*
|
2011-12-15 12:25:40 +01:00
|
|
|
* @param text
|
2019-03-22 14:48:22 +01:00
|
|
|
* String to put in the frame.
|
2011-12-15 12:25:40 +01:00
|
|
|
*/
|
|
|
|
public TextWebSocketFrame(String text) {
|
2013-01-11 07:46:56 +01:00
|
|
|
super(fromText(text));
|
2011-12-15 12:25:40 +01:00
|
|
|
}
|
2011-09-26 14:51:15 +02:00
|
|
|
|
2011-12-15 12:25:40 +01:00
|
|
|
/**
|
|
|
|
* Creates a new text frame with the specified binary data. The final fragment flag is set to true.
|
2012-05-31 21:03:01 +02:00
|
|
|
*
|
2011-12-15 12:25:40 +01:00
|
|
|
* @param binaryData
|
2015-12-17 14:57:36 +01:00
|
|
|
* the content of the frame.
|
2011-12-15 12:25:40 +01:00
|
|
|
*/
|
2012-06-10 04:08:43 +02:00
|
|
|
public TextWebSocketFrame(ByteBuf binaryData) {
|
2013-01-11 07:46:56 +01:00
|
|
|
super(binaryData);
|
2011-12-15 12:25:40 +01:00
|
|
|
}
|
2011-09-26 14:51:15 +02:00
|
|
|
|
2011-12-15 12:25:40 +01:00
|
|
|
/**
|
|
|
|
* Creates a new text frame with the specified text string. The final fragment flag is set to true.
|
2012-05-31 21:03:01 +02:00
|
|
|
*
|
2011-12-15 12:25:40 +01:00
|
|
|
* @param finalFragment
|
|
|
|
* flag indicating if this frame is the final fragment
|
|
|
|
* @param rsv
|
|
|
|
* reserved bits used for protocol extensions
|
|
|
|
* @param text
|
2019-03-22 14:48:22 +01:00
|
|
|
* String to put in the frame.
|
2011-12-15 12:25:40 +01:00
|
|
|
*/
|
|
|
|
public TextWebSocketFrame(boolean finalFragment, int rsv, String text) {
|
2013-01-11 07:46:56 +01:00
|
|
|
super(finalFragment, rsv, fromText(text));
|
|
|
|
}
|
|
|
|
|
|
|
|
private static ByteBuf fromText(String text) {
|
2011-12-15 12:25:40 +01:00
|
|
|
if (text == null || text.isEmpty()) {
|
2013-01-11 07:46:56 +01:00
|
|
|
return Unpooled.EMPTY_BUFFER;
|
2011-12-15 12:25:40 +01:00
|
|
|
} else {
|
2013-01-11 07:46:56 +01:00
|
|
|
return Unpooled.copiedBuffer(text, CharsetUtil.UTF_8);
|
2011-12-15 12:25:40 +01:00
|
|
|
}
|
|
|
|
}
|
2011-10-16 08:01:24 +02:00
|
|
|
|
2011-12-15 12:25:40 +01:00
|
|
|
/**
|
2019-03-22 14:48:22 +01:00
|
|
|
* Creates a new text frame with the specified binary data and the final fragment flag.
|
2012-05-31 21:03:01 +02:00
|
|
|
*
|
2011-12-15 12:25:40 +01:00
|
|
|
* @param finalFragment
|
|
|
|
* flag indicating if this frame is the final fragment
|
|
|
|
* @param rsv
|
|
|
|
* reserved bits used for protocol extensions
|
|
|
|
* @param binaryData
|
2015-12-17 14:57:36 +01:00
|
|
|
* the content of the frame.
|
2011-12-15 12:25:40 +01:00
|
|
|
*/
|
2012-06-10 04:08:43 +02:00
|
|
|
public TextWebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData) {
|
2013-01-11 07:46:56 +01:00
|
|
|
super(finalFragment, rsv, binaryData);
|
2011-12-15 12:25:40 +01:00
|
|
|
}
|
2011-10-16 08:01:24 +02:00
|
|
|
|
2011-12-15 12:25:40 +01:00
|
|
|
/**
|
2019-03-22 14:48:22 +01:00
|
|
|
* Returns the text data in this frame.
|
2011-12-15 12:25:40 +01:00
|
|
|
*/
|
2013-01-11 07:46:56 +01:00
|
|
|
public String text() {
|
2013-05-01 10:04:43 +02:00
|
|
|
return content().toString(CharsetUtil.UTF_8);
|
2011-12-15 12:25:40 +01:00
|
|
|
}
|
2011-09-26 14:51:15 +02:00
|
|
|
|
2011-12-15 12:25:40 +01:00
|
|
|
@Override
|
2013-01-11 07:46:56 +01:00
|
|
|
public TextWebSocketFrame copy() {
|
2016-04-14 10:31:48 +02:00
|
|
|
return (TextWebSocketFrame) super.copy();
|
2011-12-15 12:25:40 +01:00
|
|
|
}
|
2013-04-21 13:00:50 +02:00
|
|
|
|
2013-07-06 21:17:51 +02:00
|
|
|
@Override
|
|
|
|
public TextWebSocketFrame duplicate() {
|
2016-04-14 10:31:48 +02:00
|
|
|
return (TextWebSocketFrame) super.duplicate();
|
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
|
|
|
public TextWebSocketFrame retainedDuplicate() {
|
|
|
|
return (TextWebSocketFrame) super.retainedDuplicate();
|
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
|
|
|
public TextWebSocketFrame replace(ByteBuf content) {
|
|
|
|
return new TextWebSocketFrame(isFinalFragment(), rsv(), content);
|
2013-07-06 21:17:51 +02:00
|
|
|
}
|
|
|
|
|
2013-04-21 13:00:50 +02:00
|
|
|
@Override
|
|
|
|
public TextWebSocketFrame retain() {
|
|
|
|
super.retain();
|
|
|
|
return this;
|
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
|
|
|
public TextWebSocketFrame retain(int increment) {
|
|
|
|
super.retain(increment);
|
|
|
|
return this;
|
|
|
|
}
|
2014-01-28 12:00:28 +01:00
|
|
|
|
|
|
|
@Override
|
|
|
|
public TextWebSocketFrame touch() {
|
|
|
|
super.touch();
|
|
|
|
return this;
|
|
|
|
}
|
2014-01-29 03:44:59 +01:00
|
|
|
|
|
|
|
@Override
|
|
|
|
public TextWebSocketFrame touch(Object hint) {
|
|
|
|
super.touch(hint);
|
|
|
|
return this;
|
|
|
|
}
|
2011-09-26 14:51:15 +02:00
|
|
|
}
|