org.apache.tomcat.util.threads.Reaper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grizzly-framework-http Show documentation
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-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.
 *
 *
 * This file incorporates work covered by the following copyright and
 * permission notice:
 *
 * Copyright 2004 The Apache Software Foundation
 *
 * Licensed 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 org.apache.tomcat.util.threads;

import org.apache.tomcat.util.*;

/**
 * The reaper is a background thread with which ticks every minute
 * and calls registered objects to allow reaping of old session
 * data.
 * 
 * @author James Duncan Davidson [[email protected]]
 * @author Costin Manolache
 */
public class Reaper extends Thread {

    private static com.sun.org.apache.commons.logging.Log log=
        com.sun.org.apache.commons.logging.LogFactory.getLog(Reaper.class );

    private boolean daemon=false;

    public Reaper() {
	if( daemon )
            this.setDaemon(true);
	this.setName("TomcatReaper");
    }

    public Reaper(String name) {
        if( daemon )
            this.setDaemon(true);
	this.setName(name);
    }

    private long interval = 1000 * 60; //ms
    
    // XXX TODO Allow per/callback interval, find next, etc
    // Right now the "interval" is used for all callbacks
    // and it represent a sleep between runs.
    
    ThreadPoolRunnable cbacks[]=new ThreadPoolRunnable[30]; // XXX max
    Object tdata[][]=new Object[30][]; // XXX max
    int count=0;

    /** Adding and removing callbacks is synchronized
     */
    Object lock=new Object();
    private boolean running=true;

    // XXX Should be called 'interval' not defaultInterval

    public void setDefaultInterval( long t ) {
	interval=t;
    }

    public long getDefaultIntervale() {
        return interval;
    }

    public int addCallback( ThreadPoolRunnable c, int interval ) {
	synchronized( lock ) {
	    cbacks[count]=c;
	    count++;
	    return count-1;
	}
    }

    public void removeCallback( int idx ) {
	synchronized( lock ) {
	    count--;
	    cbacks[idx]=cbacks[count];
	    cbacks[count]=null;
	}
    }

    public void startReaper() {
	running=true;
	this.start();
    }

    public synchronized void stopReaper() {
	running=false;
        if (log.isDebugEnabled())
	    log.debug("Stop reaper ");
	this.interrupt(); // notify() doesn't stop sleep
    }
    
    public void run() {
	while (running) {
	    if( !running) break;
	    try {
		this.sleep(interval);
	    } catch (InterruptedException ie) {
		// sometimes will happen
	    }

	    if( !running) break;
	    for( int i=0; i< count; i++ ) {
		ThreadPoolRunnable callB=cbacks[i];
		// it may be null if a callback is removed.
		//  I think the code is correct
		if( callB!= null ) {
		    callB.runIt( tdata[i] );
		}
		if( !running) break;
	    }
	}
    }
}