128 lines
4.0 KiB
Java
128 lines
4.0 KiB
Java
/*
|
|
* 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.Unpooled;
|
|
import io.netty.util.CharsetUtil;
|
|
|
|
/**
|
|
* Web Socket continuation frame containing continuation text or binary data. This is used for
|
|
* fragmented messages where the contents of a messages is contained more than 1 frame.
|
|
*/
|
|
public class ContinuationWebSocketFrame extends WebSocketFrame {
|
|
|
|
private String aggregatedText;
|
|
|
|
/**
|
|
* Creates a new empty continuation frame.
|
|
*/
|
|
public ContinuationWebSocketFrame() {
|
|
super(Unpooled.buffer(0));
|
|
}
|
|
|
|
/**
|
|
* Creates a new continuation frame with the specified binary data. The final fragment flag is
|
|
* set to true.
|
|
*
|
|
* @param binaryData the content of the frame.
|
|
*/
|
|
public ContinuationWebSocketFrame(ByteBuf binaryData) {
|
|
super(binaryData);
|
|
}
|
|
|
|
/**
|
|
* Creates a new continuation frame with the specified binary data
|
|
*
|
|
* @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.
|
|
*/
|
|
public ContinuationWebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData) {
|
|
super(finalFragment, rsv, binaryData);
|
|
}
|
|
|
|
/**
|
|
* Creates a new continuation frame with the specified binary data
|
|
*
|
|
* @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.
|
|
* @param aggregatedText
|
|
* Aggregated text set by decoder on the final continuation frame of a fragmented
|
|
* text message
|
|
*/
|
|
public ContinuationWebSocketFrame(
|
|
boolean finalFragment, int rsv, ByteBuf binaryData, String aggregatedText) {
|
|
super(finalFragment, rsv, binaryData);
|
|
this.aggregatedText = aggregatedText;
|
|
}
|
|
|
|
/**
|
|
* Creates a new continuation frame with the specified text data
|
|
*
|
|
* @param finalFragment
|
|
* flag indicating if this frame is the final fragment
|
|
* @param rsv
|
|
* reserved bits used for protocol extensions
|
|
* @param text
|
|
* text content of the frame.
|
|
*/
|
|
public ContinuationWebSocketFrame(boolean finalFragment, int rsv, String text) {
|
|
this(finalFragment, rsv, fromText(text), null);
|
|
}
|
|
|
|
/**
|
|
* Returns the text data in this frame
|
|
*/
|
|
public String text() {
|
|
return data().toString(CharsetUtil.UTF_8);
|
|
}
|
|
|
|
/**
|
|
* Sets the string for this frame
|
|
*
|
|
* @param text
|
|
* text to store
|
|
*/
|
|
private static ByteBuf fromText(String text) {
|
|
if (text == null || text.isEmpty()) {
|
|
return Unpooled.EMPTY_BUFFER;
|
|
} else {
|
|
return Unpooled.copiedBuffer(text, CharsetUtil.UTF_8);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Aggregated text returned by decoder on the final continuation frame of a fragmented text message
|
|
*/
|
|
public String aggregatedText() {
|
|
return aggregatedText;
|
|
}
|
|
|
|
@Override
|
|
public ContinuationWebSocketFrame copy() {
|
|
return new ContinuationWebSocketFrame(isFinalFragment(), rsv(), data().copy(), aggregatedText());
|
|
}
|
|
|
|
}
|