Coverage Report

Coverage Report - com.sun.grizzly.Pipeline

Classes in this File

 /*
  * 
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  * 
  * Copyright 2007-2008 Sun Microsystems, Inc. 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.html
  * or glassfish/bootstrap/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 glassfish/bootstrap/legal/LICENSE.txt.
  * Sun designates this particular file as subject to the "Classpath" exception
  * as provided by Sun in the GPL Version 2 section of the License file that
  * accompanied this code.  If applicable, add the following below the License
  * Header, with the fields enclosed by brackets [] replaced by your own
  * identifying information: "Portions Copyrighted [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;
 
 /**
  * An interface used as a wrapper around any kind of thread pool.
  *
  * @param E 
  * @author Jean-Francois Arcand
  */
 public interface Pipeline<E> {
     
     
     /**
      * Add an <code>E</code> to be processed by this {@link Pipeline}
      * @param task 
      * @throws com.sun.grizzly.PipelineFullException 
      */
     public void execute(E task) throws PipelineFullException;
 
 
     /**
      * Return a <code>E</code> object available in the pipeline.
      * @return
      */
     public E waitForIoTask() ;
     
    
    /**
      * Return the number of waiting threads.
      * @return number of waiting threads
     */
     public int getWaitingThread();
     
     
     /** 
      * Return the number of threads used by this pipeline.
      * @return max number of threads
      */
     public int getMaxThreads();
     
     
     /**
      * Return the number of active threads.
      * @return number of active threads
      */
     public int getCurrentThreadCount() ;
       
       
     /**
      * Return the curent number of threads that are currently processing 
      * a task.
      * @return number of currently processing threads
      */
     public int getCurrentThreadsBusy();
     
    
     /**
      * Init the {@link Pipeline} by initializing the required
      * {@link WorkerThread}. Default value is 10
      */
     public void initPipeline();
 
 
     /**
      * Return the name of this {@link Pipeline}
      * @return name of this {@link Pipeline}
      */
     public String getName();
 
 
     /**
      * Start the {@link Pipeline}
      */
     public void startPipeline();
     
 
     /**
      * Stop the {@link Pipeline} 
      */
     public void stopPipeline();
 
     
     /**
      * Set the {@link Thread} priority used when creating new threads.
      * @param priority 
      */
     public void setPriority(int priority);
     
     
     /**
      * Set the maximum thread this pipeline can handle.
      * @param maxThread 
      */
     public void setMaxThreads(int maxThread);
     
     
     /**
      * Set the minimum thread this pipeline can handle.
      * @param minThread 
      */    
     public void setMinThreads(int minThread);
     
     
     /**
      * Set the name of this {@link Pipeline}
      * @param name 
      */
     public void setName(String name);
    
     
     /**
      * Set the maximum pending connection this {@link Pipeline}
      * can handle.
      * @param maxQueueSizeInBytesCount 
      * @depre
      */
     public void setMaxQueueSize(int maxQueue);
     
    
     /**
      * Set the number the {@link Pipeline} will use when increasing the 
      * thread pool
      * @param processorThreadsIncrement 
      */
     public void setThreadsIncrement(int threadIncrements);
     
     
     /**
      * Returns the number of tasks in this {@link Pipeline}.
      *
      * @return Number of tasks in this {@link Pipeline}.
      */
     public int size();
 }

1		/*
2		*
3		* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4		*
5		* Copyright 2007-2008 Sun Microsystems, Inc. All rights reserved.
6		*
7		* The contents of this file are subject to the terms of either the GNU
8		* General Public License Version 2 only ("GPL") or the Common Development
9		* and Distribution License("CDDL") (collectively, the "License"). You
10		* may not use this file except in compliance with the License. You can obtain
11		* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
12		* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
13		* language governing permissions and limitations under the License.
14		*
15		* When distributing the software, include this License Header Notice in each
16		* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
17		* Sun designates this particular file as subject to the "Classpath" exception
18		* as provided by Sun in the GPL Version 2 section of the License file that
19		* accompanied this code. If applicable, add the following below the License
20		* Header, with the fields enclosed by brackets [] replaced by your own
21		* identifying information: "Portions Copyrighted [year]
22		* [name of copyright owner]"
23		*
24		* Contributor(s):
25		*
26		* If you wish your version of this file to be governed by only the CDDL or
27		* only the GPL Version 2, indicate your decision by adding "[Contributor]
28		* elects to include this software in this distribution under the [CDDL or GPL
29		* Version 2] license." If you don't indicate a single choice of license, a
30		* recipient has the option to distribute your version of this file under
31		* either the CDDL, the GPL Version 2 or to extend the choice of license to
32		* its licensees as provided above. However, if you add GPL Version 2 code
33		* and therefore, elected the GPL Version 2 license, then the option applies
34		* only if the new code is made subject to such option by the copyright
35		* holder.
36		*
37		*/
38		package com.sun.grizzly;
39
40		/**
41		* An interface used as a wrapper around any kind of thread pool.
42		*
43		* @param E
44		* @author Jean-Francois Arcand
45		*/
46		public interface Pipeline<E> {
47
48
49		/**
50		* Add an <code>E</code> to be processed by this {@link Pipeline}
51		* @param task
52		* @throws com.sun.grizzly.PipelineFullException
53		*/
54		public void execute(E task) throws PipelineFullException;
55
56
57		/**
58		* Return a <code>E</code> object available in the pipeline.
59		* @return
60		*/
61		public E waitForIoTask() ;
62
63
64		/**
65		* Return the number of waiting threads.
66		* @return number of waiting threads
67		*/
68		public int getWaitingThread();
69
70
71		/**
72		* Return the number of threads used by this pipeline.
73		* @return max number of threads
74		*/
75		public int getMaxThreads();
76
77
78		/**
79		* Return the number of active threads.
80		* @return number of active threads
81		*/
82		public int getCurrentThreadCount() ;
83
84
85		/**
86		* Return the curent number of threads that are currently processing
87		* a task.
88		* @return number of currently processing threads
89		*/
90		public int getCurrentThreadsBusy();
91
92
93		/**
94		* Init the {@link Pipeline} by initializing the required
95		* {@link WorkerThread}. Default value is 10
96		*/
97		public void initPipeline();
98
99
100		/**
101		* Return the name of this {@link Pipeline}
102		* @return name of this {@link Pipeline}
103		*/
104		public String getName();
105
106
107		/**
108		* Start the {@link Pipeline}
109		*/
110		public void startPipeline();
111
112
113		/**
114		* Stop the {@link Pipeline}
115		*/
116		public void stopPipeline();
117
118
119		/**
120		* Set the {@link Thread} priority used when creating new threads.
121		* @param priority
122		*/
123		public void setPriority(int priority);
124
125
126		/**
127		* Set the maximum thread this pipeline can handle.
128		* @param maxThread
129		*/
130		public void setMaxThreads(int maxThread);
131
132
133		/**
134		* Set the minimum thread this pipeline can handle.
135		* @param minThread
136		*/
137		public void setMinThreads(int minThread);
138
139
140		/**
141		* Set the name of this {@link Pipeline}
142		* @param name
143		*/
144		public void setName(String name);
145
146
147		/**
148		* Set the maximum pending connection this {@link Pipeline}
149		* can handle.
150		* @param maxQueueSizeInBytesCount
151		* @depre
152		*/
153		public void setMaxQueueSize(int maxQueue);
154
155
156		/**
157		* Set the number the {@link Pipeline} will use when increasing the
158		* thread pool
159		* @param processorThreadsIncrement
160		*/
161		public void setThreadsIncrement(int threadIncrements);
162
163
164		/**
165		* Returns the number of tasks in this {@link Pipeline}.
166		*
167		* @return Number of tasks in this {@link Pipeline}.
168		*/
169		public int size();
170		}