2011-09-26 14:51:15 +02:00
|
|
|
/*
|
2019-06-18 10:05:58 +02:00
|
|
|
* Copyright 2019 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;
|
2012-04-09 06:33:45 +02:00
|
|
|
import io.netty.util.CharsetUtil;
|
2017-06-23 12:00:01 +02:00
|
|
|
import io.netty.util.internal.StringUtil;
|
2011-09-26 14:51:15 +02:00
|
|
|
|
|
|
|
/**
|
2019-03-22 14:48:22 +01:00
|
|
|
* Web Socket Frame for closing the connection.
|
2011-09-26 14:51:15 +02:00
|
|
|
*/
|
|
|
|
public class CloseWebSocketFrame extends WebSocketFrame {
|
|
|
|
|
2011-12-15 12:25:40 +01:00
|
|
|
/**
|
|
|
|
* Creates a new empty close frame.
|
|
|
|
*/
|
|
|
|
public CloseWebSocketFrame() {
|
2013-01-11 07:46:56 +01:00
|
|
|
super(Unpooled.buffer(0));
|
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-06-18 10:05:58 +02:00
|
|
|
* Creates a new empty close frame with closing status code and reason text
|
|
|
|
*
|
|
|
|
* @param status
|
|
|
|
* Status code as per <a href="http://tools.ietf.org/html/rfc6455#section-7.4">RFC 6455</a>. For
|
|
|
|
* example, <tt>1000</tt> indicates normal closure.
|
|
|
|
*/
|
|
|
|
public CloseWebSocketFrame(WebSocketCloseStatus status) {
|
|
|
|
this(status.code(), status.reasonText());
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates a new empty close frame with closing status code and reason text
|
|
|
|
*
|
|
|
|
* @param status
|
|
|
|
* Status code as per <a href="http://tools.ietf.org/html/rfc6455#section-7.4">RFC 6455</a>. For
|
|
|
|
* example, <tt>1000</tt> indicates normal closure.
|
|
|
|
* @param reasonText
|
|
|
|
* Reason text. Set to null if no text.
|
|
|
|
*/
|
|
|
|
public CloseWebSocketFrame(WebSocketCloseStatus status, String reasonText) {
|
|
|
|
this(status.code(), reasonText);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates a new empty close frame with closing status code and reason text
|
2012-05-31 21:03:01 +02:00
|
|
|
*
|
2012-04-09 06:33:45 +02:00
|
|
|
* @param statusCode
|
|
|
|
* Integer status code as per <a href="http://tools.ietf.org/html/rfc6455#section-7.4">RFC 6455</a>. For
|
|
|
|
* example, <tt>1000</tt> indicates normal closure.
|
|
|
|
* @param reasonText
|
|
|
|
* Reason text. Set to null if no text.
|
|
|
|
*/
|
|
|
|
public CloseWebSocketFrame(int statusCode, String reasonText) {
|
|
|
|
this(true, 0, statusCode, reasonText);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-06-18 10:05:58 +02:00
|
|
|
* Creates a new close frame with no losing status code and no reason text
|
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
|
2019-03-22 14:48:22 +01:00
|
|
|
* reserved bits used for protocol extensions.
|
2011-12-15 12:25:40 +01:00
|
|
|
*/
|
|
|
|
public CloseWebSocketFrame(boolean finalFragment, int rsv) {
|
2014-07-19 19:51:19 +02:00
|
|
|
this(finalFragment, rsv, Unpooled.buffer(0));
|
2012-04-09 06:33:45 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates a new close frame with closing status code and reason text
|
2012-05-31 21:03:01 +02:00
|
|
|
*
|
2012-04-09 06:33:45 +02:00
|
|
|
* @param finalFragment
|
|
|
|
* flag indicating if this frame is the final fragment
|
|
|
|
* @param rsv
|
|
|
|
* reserved bits used for protocol extensions
|
|
|
|
* @param statusCode
|
|
|
|
* Integer status code as per <a href="http://tools.ietf.org/html/rfc6455#section-7.4">RFC 6455</a>. For
|
|
|
|
* example, <tt>1000</tt> indicates normal closure.
|
|
|
|
* @param reasonText
|
|
|
|
* Reason text. Set to null if no text.
|
|
|
|
*/
|
|
|
|
public CloseWebSocketFrame(boolean finalFragment, int rsv, int statusCode, String reasonText) {
|
2013-01-11 07:46:56 +01:00
|
|
|
super(finalFragment, rsv, newBinaryData(statusCode, reasonText));
|
|
|
|
}
|
2012-04-09 06:33:45 +02:00
|
|
|
|
2013-01-11 07:46:56 +01:00
|
|
|
private static ByteBuf newBinaryData(int statusCode, String reasonText) {
|
2017-06-23 12:00:01 +02:00
|
|
|
if (reasonText == null) {
|
|
|
|
reasonText = StringUtil.EMPTY_STRING;
|
2012-04-09 06:33:45 +02:00
|
|
|
}
|
|
|
|
|
2017-06-23 12:00:01 +02:00
|
|
|
ByteBuf binaryData = Unpooled.buffer(2 + reasonText.length());
|
2012-04-09 06:33:45 +02:00
|
|
|
binaryData.writeShort(statusCode);
|
2017-06-23 12:00:01 +02:00
|
|
|
if (!reasonText.isEmpty()) {
|
|
|
|
binaryData.writeCharSequence(reasonText, CharsetUtil.UTF_8);
|
2012-04-09 06:33:45 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
binaryData.readerIndex(0);
|
2013-01-11 07:46:56 +01:00
|
|
|
return binaryData;
|
2012-04-09 06:33:45 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates a new close frame
|
2012-05-31 21:03:01 +02:00
|
|
|
*
|
2012-04-09 06:33:45 +02: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 2 byte integer followed by optional UTF-8 encoded string.
|
|
|
|
*/
|
2012-06-10 04:08:43 +02:00
|
|
|
public CloseWebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData) {
|
2013-01-11 07:46:56 +01:00
|
|
|
super(finalFragment, rsv, binaryData);
|
2012-04-09 06:33:45 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the closing status code as per <a href="http://tools.ietf.org/html/rfc6455#section-7.4">RFC 6455</a>. If
|
2019-06-18 10:05:58 +02:00
|
|
|
* a status code is set, -1 is returned.
|
2012-04-09 06:33:45 +02:00
|
|
|
*/
|
2013-01-11 07:46:56 +01:00
|
|
|
public int statusCode() {
|
2013-05-01 10:04:43 +02:00
|
|
|
ByteBuf binaryData = content();
|
2012-04-09 06:33:45 +02:00
|
|
|
if (binaryData == null || binaryData.capacity() == 0) {
|
|
|
|
return -1;
|
|
|
|
}
|
|
|
|
|
|
|
|
binaryData.readerIndex(0);
|
|
|
|
int statusCode = binaryData.readShort();
|
|
|
|
binaryData.readerIndex(0);
|
|
|
|
|
|
|
|
return statusCode;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the reason text as per <a href="http://tools.ietf.org/html/rfc6455#section-7.4">RFC 6455</a> If a reason
|
|
|
|
* text is not supplied, an empty string is returned.
|
|
|
|
*/
|
2013-01-11 07:46:56 +01:00
|
|
|
public String reasonText() {
|
2013-05-01 10:04:43 +02:00
|
|
|
ByteBuf binaryData = content();
|
2012-04-09 06:33:45 +02:00
|
|
|
if (binaryData == null || binaryData.capacity() <= 2) {
|
|
|
|
return "";
|
|
|
|
}
|
|
|
|
|
|
|
|
binaryData.readerIndex(2);
|
|
|
|
String reasonText = binaryData.toString(CharsetUtil.UTF_8);
|
|
|
|
binaryData.readerIndex(0);
|
|
|
|
|
|
|
|
return reasonText;
|
2011-12-15 12:25:40 +01:00
|
|
|
}
|
2011-11-04 19:28:15 +01:00
|
|
|
|
2011-12-15 12:25:40 +01:00
|
|
|
@Override
|
2013-01-11 07:46:56 +01:00
|
|
|
public CloseWebSocketFrame copy() {
|
2016-04-14 10:31:48 +02:00
|
|
|
return (CloseWebSocketFrame) 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 CloseWebSocketFrame duplicate() {
|
2016-04-14 10:31:48 +02:00
|
|
|
return (CloseWebSocketFrame) super.duplicate();
|
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
|
|
|
public CloseWebSocketFrame retainedDuplicate() {
|
|
|
|
return (CloseWebSocketFrame) super.retainedDuplicate();
|
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
|
|
|
public CloseWebSocketFrame replace(ByteBuf content) {
|
|
|
|
return new CloseWebSocketFrame(isFinalFragment(), rsv(), content);
|
2013-07-06 21:17:51 +02:00
|
|
|
}
|
|
|
|
|
2013-04-21 13:00:50 +02:00
|
|
|
@Override
|
|
|
|
public CloseWebSocketFrame retain() {
|
|
|
|
super.retain();
|
|
|
|
return this;
|
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
|
|
|
public CloseWebSocketFrame retain(int increment) {
|
|
|
|
super.retain(increment);
|
|
|
|
return this;
|
|
|
|
}
|
2014-01-28 12:00:28 +01:00
|
|
|
|
|
|
|
@Override
|
|
|
|
public CloseWebSocketFrame touch() {
|
|
|
|
super.touch();
|
|
|
|
return this;
|
|
|
|
}
|
2014-01-29 03:44:59 +01:00
|
|
|
|
|
|
|
@Override
|
|
|
|
public CloseWebSocketFrame touch(Object hint) {
|
|
|
|
super.touch(hint);
|
|
|
|
return this;
|
|
|
|
}
|
2011-09-26 14:51:15 +02:00
|
|
|
}
|