2011-09-26 14:51:15 +02:00
|
|
|
/*
|
2011-12-09 06:18:34 +01:00
|
|
|
* Copyright 2011 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
|
|
|
*
|
2011-12-09 06:18:34 +01: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
|
|
|
|
2011-12-09 04:38:59 +01:00
|
|
|
import io.netty.buffer.ChannelBuffer;
|
|
|
|
import io.netty.buffer.ChannelBuffers;
|
|
|
|
import io.netty.util.CharsetUtil;
|
2011-09-26 14:51:15 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Web Socket text frame with assumed UTF-8 encoding
|
|
|
|
*/
|
|
|
|
public class TextWebSocketFrame extends WebSocketFrame {
|
|
|
|
|
2011-12-15 12:25:40 +01:00
|
|
|
/**
|
|
|
|
* Creates a new empty text frame.
|
|
|
|
*/
|
|
|
|
public TextWebSocketFrame() {
|
2012-01-19 05:12:45 +01:00
|
|
|
setBinaryData(ChannelBuffers.EMPTY_BUFFER);
|
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
|
|
|
|
* String to put in the frame
|
|
|
|
*/
|
|
|
|
public TextWebSocketFrame(String text) {
|
|
|
|
if (text == null || text.isEmpty()) {
|
2012-01-19 05:12:45 +01:00
|
|
|
setBinaryData(ChannelBuffers.EMPTY_BUFFER);
|
2011-12-15 12:25:40 +01:00
|
|
|
} else {
|
2012-01-19 05:12:45 +01:00
|
|
|
setBinaryData(ChannelBuffers.copiedBuffer(text, 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
|
|
|
/**
|
|
|
|
* 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
|
|
|
|
* the content of the frame. Must be UTF-8 encoded
|
|
|
|
*/
|
|
|
|
public TextWebSocketFrame(ChannelBuffer binaryData) {
|
2012-01-19 05:12:45 +01:00
|
|
|
setBinaryData(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
|
|
|
|
* String to put in the frame
|
|
|
|
*/
|
|
|
|
public TextWebSocketFrame(boolean finalFragment, int rsv, String text) {
|
2012-01-19 05:12:45 +01:00
|
|
|
setFinalFragment(finalFragment);
|
|
|
|
setRsv(rsv);
|
2011-12-15 12:25:40 +01:00
|
|
|
if (text == null || text.isEmpty()) {
|
2012-01-19 05:12:45 +01:00
|
|
|
setBinaryData(ChannelBuffers.EMPTY_BUFFER);
|
2011-12-15 12:25:40 +01:00
|
|
|
} else {
|
2012-01-19 05:12:45 +01:00
|
|
|
setBinaryData(ChannelBuffers.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
|
|
|
/**
|
|
|
|
* 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 finalFragment
|
|
|
|
* flag indicating if this frame is the final fragment
|
|
|
|
* @param rsv
|
|
|
|
* reserved bits used for protocol extensions
|
|
|
|
* @param binaryData
|
|
|
|
* the content of the frame. Must be UTF-8 encoded
|
|
|
|
*/
|
|
|
|
public TextWebSocketFrame(boolean finalFragment, int rsv, ChannelBuffer binaryData) {
|
2012-01-19 05:12:45 +01:00
|
|
|
setFinalFragment(finalFragment);
|
|
|
|
setRsv(rsv);
|
|
|
|
setBinaryData(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
|
|
|
/**
|
|
|
|
* Returns the text data in this frame
|
|
|
|
*/
|
|
|
|
public String getText() {
|
2012-01-19 05:12:45 +01:00
|
|
|
if (getBinaryData() == null) {
|
2011-12-15 12:25:40 +01:00
|
|
|
return null;
|
|
|
|
}
|
2012-01-19 05:12:45 +01:00
|
|
|
return getBinaryData().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
|
|
|
/**
|
|
|
|
* Sets the string for this frame
|
2012-05-31 21:03:01 +02:00
|
|
|
*
|
2011-12-15 12:25:40 +01:00
|
|
|
* @param text
|
|
|
|
* text to store
|
|
|
|
*/
|
|
|
|
public void setText(String text) {
|
|
|
|
if (text == null) {
|
|
|
|
throw new NullPointerException("text");
|
|
|
|
}
|
2012-01-19 05:12:45 +01:00
|
|
|
setBinaryData(ChannelBuffers.copiedBuffer(text, 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
|
|
|
|
public String toString() {
|
|
|
|
return getClass().getSimpleName() + "(text: " + getText() + ')';
|
|
|
|
}
|
2011-09-26 14:51:15 +02:00
|
|
|
}
|