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.interfaces;
23:
24: import org.jboss.messaging.interfaces.MessageReference;
25:
26: /**
27: * A channel.
28: *
29: * @author <a href="mailto:adrian@jboss.org">Adrian Brock</a>
30: * @version $Revision: 57195 $
31: */
32: public interface Channel {
33: // Constants -----------------------------------------------------
34:
35: // Public --------------------------------------------------------
36:
37: /**
38: * Send a message to the channel.
39: *
40: * @param reference the message reference to send
41: */
42: void send(MessageReference reference);
43:
44: /**
45: * Receive a message from the channel.
46: *
47: * @param wait the length of time to wait for a message if there are none
48: * immediately available, use -1 for no wait.
49: * @return a message or null if there are no messages
50: */
51: MessageReference receive(long wait);
52:
53: /**
54: * Close the channel
55: */
56: void close();
57:
58: // Inner Classes --------------------------------------------------
59: }
|