com.sun.grizzly.DefaultSelectionKeyHandler Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.grizzly;
import com.sun.grizzly.util.Copyable;
import com.sun.grizzly.util.SelectionKeyAttachment;
import java.nio.channels.ClosedChannelException;
import java.nio.channels.SelectableChannel;
import java.nio.channels.SelectionKey;
import java.nio.channels.Selector;
import java.util.Iterator;
/**
* Default implementation of a SelectionKey Handler. By default, this
* class will attach a Long to a SelectionKey in order to calculate the
* time a SelectionKey can stay active. By default, a SelectionKey will be
* active for 30 seconds. If during that 30 seconds the client isn't pushing
* bytes (or closing the connection). the SelectionKey will be expired and
* its channel closed.
*
* @author Jeanfrancois Arcand
*/
public class DefaultSelectionKeyHandler extends BaseSelectionKeyHandler {
/**
* Next time the exprireKeys() will delete keys.
*/
protected long nextKeysExpiration = 0;
/*
* Number of seconds before idle keep-alive connections expire
*/
protected long timeout = 30 * 1000L;
public DefaultSelectionKeyHandler() {
}
public DefaultSelectionKeyHandler(SelectorHandler selectorHandler) {
super(selectorHandler);
}
/**
* {@inheritDoc}
*/
@Override
public void copyTo(Copyable copy) {
super.copyTo(copy);
DefaultSelectionKeyHandler copyHandler = (DefaultSelectionKeyHandler) copy;
copyHandler.timeout = timeout;
}
/**
* {@inheritDoc}
*/
@Override
public void process(SelectionKey key) {
/*
removeExpirationStamp(key);
super.process(key);
*/
super.process(key);
removeExpirationStamp(key);
}
/**
* {@inheritDoc}
*/
@Override
public void postProcess(SelectionKey key) {
super.postProcess(key);
addExpirationStamp(key);
}
/**
* {@inheritDoc}
*/
@Override
public void register(Iterator keyIterator, int selectionKeyOps) {
long currentTime = System.currentTimeMillis();
SelectionKey key;
while (keyIterator.hasNext()) {
key = keyIterator.next();
keyIterator.remove();
doRegisterKey(key, selectionKeyOps, currentTime);
}
}
/**
* {@inheritDoc}
*/
@Override
public void register(SelectionKey key, int selectionKeyOps) {
doRegisterKey(key, selectionKeyOps, System.currentTimeMillis());
}
/**
* Registers {@link SelectionKey} to handle certain operations
*/
protected void doRegisterKey(SelectionKey key, int selectionKeyOps,
long currentTime) {
if (key.isValid()) {
key.interestOps(key.interestOps() | selectionKeyOps);
addExpirationStamp(key);
}
}
/**
* {@inheritDoc}
*/
@Override
public void register(SelectableChannel channel, int ops)
throws ClosedChannelException {
if (!channel.isOpen()) {
return;
}
Selector selector = selectorHandler.getSelector();
long time = System.currentTimeMillis();
channel.register(selector, ops, time);
}
/**
* {@inheritDoc}
*/
@Override
@SuppressWarnings("empty-statement")
public void register(SelectionKey key, long currentTime){
;
}
/**
* @deprecated
*/
@Override
@SuppressWarnings("empty-statement")
public void expire(SelectionKey key, long currentTime) {
;
}
/**
* {@inheritDoc}
*/
@Override
public void expire(Iterator iterator) {
if (timeout <= 0) return;
long currentTime = System.currentTimeMillis();
if (currentTime < nextKeysExpiration) {
return;
}
nextKeysExpiration = currentTime + timeout;
SelectionKey key;
while (iterator.hasNext()) {
key = iterator.next();
if (!key.isValid()){
continue;
}
long expire = getExpirationStamp(key.attachment());
if (expire != SelectionKeyAttachment.UNLIMITED_TIMEOUT){
if (currentTime - expire >= timeout) {
cancel(key);
} else if (expire + timeout < nextKeysExpiration) {
nextKeysExpiration = expire + timeout;
}
}
}
}
public long getTimeout() {
return timeout;
}
/**
* Set expiration timeout for the {@link SelectionKey}.
*
* If during that defined timeout the client isn't pushing bytes
* (or closing the connection), the SelectionKey will be expired
* and its channel closed. The negative timeout value will let
* {@link SelectionKey} never expire.
*
* @param timeout in seconds
*/
public void setTimeout(long timeout) {
this.timeout = timeout;
}
/**
* Removes expiration timeout stamp from the {@link SelectionKey}
* depending on its attachment
*
* @param {@link SelectionKey}
*/
private void removeExpirationStamp(SelectionKey key) {
Object attachment = key.attachment();
if (attachment != null) {
if (attachment instanceof Long) {
key.attach(null);
} else if (attachment instanceof SelectionKeyAttachment) {
((SelectionKeyAttachment) attachment).setTimeout(
SelectionKeyAttachment.UNLIMITED_TIMEOUT);
}
}
}
/**
* Adds expiration timeout stamp to the {@link SelectionKey}
* depending on its attachment
*
* @param {@link SelectionKey}
*/
protected void addExpirationStamp(SelectionKey key, long currentTime) {
Object attachment = key.attachment();
if (attachment == null) {
key.attach(currentTime);
} else if (attachment instanceof SelectionKeyAttachment) {
((SelectionKeyAttachment) attachment).setTimeout(currentTime);
}
}
protected void addExpirationStamp(SelectionKey key) {
addExpirationStamp(key,System.currentTimeMillis());
}
/**
* Gets expiration timeout stamp from the {@link SelectionKey}
* depending on its attachment
*
* @param {@link SelectionKey}
*/
protected long getExpirationStamp(Object attachment) {
if (attachment instanceof Long) {
return (Long) attachment;
}
if (attachment instanceof SelectionKeyAttachment) {
return ((SelectionKeyAttachment) attachment).getTimeout();
}
return SelectionKeyAttachment.UNLIMITED_TIMEOUT;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy