KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > dream > queue > PullQueueAttributeController


1 /**
2  * Dream
3  * Copyright (C) 2003-2004 INRIA Rhone-Alpes
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Contact: dream@objectweb.org
20  *
21  * Initial developer(s): Matthieu Leclercq
22  * Contributor(s): Vivien Quema
23  */
24
25 package org.objectweb.dream.queue;
26
27 import org.objectweb.fractal.api.control.AttributeController;
28
29 /**
30  * Attribute controller interface for Push/Pull queue. It defines the blocking
31  * pull policy, which control the beavior when the queue is empty.
32  * <ul>
33  * <li>If <code>true</code>, the pull method block until a new message is
34  * pushed or throw a {@link org.objectweb.dream.InterruptedPullException}.
35  * </li>
36  * <li>If <code>false</code> the pull method returns <code>null</code>.
37  * </li>
38  */
39 public interface PullQueueAttributeController extends AttributeController
40 {
41
42   /**
43    * Returns the blocking pull policy.
44    *
45    * @return the blocking pull policy.
46    */
47   boolean getBlockingPull();
48
49   /**
50    * Sets the blocking pull policy.
51    *
52    * @param blockingPull the blocking pull policy.
53    */
54   void setBlockingPull(boolean blockingPull);
55 }
Popular Tags