io.netty.handler.codec.http.websocketx.WebSocketProtocolHandler Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2013 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.channel.ChannelFuture;
import io.netty.channel.ChannelFutureListener;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelOutboundHandler;
import io.netty.channel.ChannelPromise;
import io.netty.handler.codec.MessageToMessageDecoder;
import io.netty.util.ReferenceCountUtil;
import io.netty.util.concurrent.ScheduledFuture;
import java.net.SocketAddress;
import java.nio.channels.ClosedChannelException;
import java.util.List;
import java.util.concurrent.TimeUnit;
abstract class WebSocketProtocolHandler extends MessageToMessageDecoder
implements ChannelOutboundHandler {
private final boolean dropPongFrames;
private final WebSocketCloseStatus closeStatus;
private final long forceCloseTimeoutMillis;
private ChannelPromise closeSent;
/**
* Creates a new {@link WebSocketProtocolHandler} that will drop {@link PongWebSocketFrame}s.
*/
WebSocketProtocolHandler() {
this(true);
}
/**
* Creates a new {@link WebSocketProtocolHandler}, given a parameter that determines whether or not to drop {@link
* PongWebSocketFrame}s.
*
* @param dropPongFrames
* {@code true} if {@link PongWebSocketFrame}s should be dropped
*/
WebSocketProtocolHandler(boolean dropPongFrames) {
this(dropPongFrames, null, 0L);
}
WebSocketProtocolHandler(boolean dropPongFrames,
WebSocketCloseStatus closeStatus,
long forceCloseTimeoutMillis) {
this.dropPongFrames = dropPongFrames;
this.closeStatus = closeStatus;
this.forceCloseTimeoutMillis = forceCloseTimeoutMillis;
}
@Override
protected void decode(ChannelHandlerContext ctx, WebSocketFrame frame, List