01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package org.jboss.messaging.channel.plugins.handler;
23:
24: import org.jboss.messaging.interfaces.Consumer;
25: import org.jboss.messaging.interfaces.MessageReference;
26:
27: /**
28: * A channel handler.
29: *
30: * @author <a href="mailto:adrian@jboss.org">Adrian Brock</a>
31: * @version $Revision: 57195 $
32: */
33: public interface ChannelHandler extends Consumer {
34: // Constants -----------------------------------------------------
35:
36: // Public --------------------------------------------------------
37:
38: /**
39: * Add a message to the channel handler.
40: *
41: * @param reference the message reference to add
42: */
43: void addMessage(MessageReference reference);
44:
45: /**
46: * Remove a message from the channel handler.
47: *
48: * @param consumer the consumer used to accept the message
49: * @return a message or null if there are no messages
50: */
51: MessageReference removeMessage(Consumer consumer);
52:
53: /**
54: * Wait for a message from the channel handler.
55: *
56: * @param consumer the consumer that will wait for a message
57: * @param wait the length of time
58: */
59: void waitMessage(Consumer consumer, long wait);
60:
61: /**
62: * Remove a consumer that is waiting for a message.
63: *
64: * @param consumer the consumer to remove.
65: */
66: void stopWaitMessage(Consumer consumer);
67:
68: // Inner Classes --------------------------------------------------
69: }
|