[jboss-cvs] JBoss Messaging SVN: r4454 - trunk/src/main/org/jboss/messaging/util.

[jboss-cvs-commits at lists.jboss.org]

Author: timfox
Date: 2008-06-12 16:16:23 -0400 (Thu, 12 Jun 2008)
New Revision: 4454

Added:
   trunk/src/main/org/jboss/messaging/util/TokenBucketLimiter.java
Log:
Adding file


Added: trunk/src/main/org/jboss/messaging/util/TokenBucketLimiter.java
===================================================================
--- trunk/src/main/org/jboss/messaging/util/TokenBucketLimiter.java	                        (rev 0)
+++ trunk/src/main/org/jboss/messaging/util/TokenBucketLimiter.java	2008-06-12 20:16:23 UTC (rev 4454)
@@ -0,0 +1,43 @@
+/*
+  * JBoss, Home of Professional Open Source
+  * Copyright 2005, JBoss Inc., and individual contributors as indicated
+  * by the @authors tag. See the copyright.txt in the distribution for a
+  * full listing of individual contributors.
+  *
+  * This is free software; you can redistribute it and/or modify it
+  * under the terms of the GNU Lesser General Public License as
+  * published by the Free Software Foundation; either version 2.1 of
+  * the License, or (at your option) any later version.
+  *
+  * This software is distributed in the hope that it will be useful,
+  * but WITHOUT ANY WARRANTY; without even the implied warranty of
+  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  * Lesser General Public License for more details.
+  *
+  * You should have received a copy of the GNU Lesser General Public
+  * License along with this software; if not, write to the Free
+  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+  */
+package org.jboss.messaging.util;
+
+/**
+ * 
+ * A TokenBucketLimiterImpl
+ * 
+ * This class can throttle to a specfic rate, using an algorithm based on the Token Bucket metaphor
+ * http://en.wikipedia.org/wiki/Token_bucket
+ * 
+ * The rate is specified in Hertz
+ * 
+ * @author <a href="mailto:tim.fox at jboss.com">Tim Fox</a>
+ *
+ */
+public interface TokenBucketLimiter
+{
+   int getRate();
+   
+   boolean isSpin();
+      
+   void limit();
+}