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.interfaces;
23:
24: /**
25: * A message set.
26: *
27: * @author <a href="mailto:adrian@jboss.org">Adrian Brock</a>
28: * @version $Revision: 57195 $
29: */
30: public interface MessageSet {
31: // Constants -----------------------------------------------------
32:
33: // Public --------------------------------------------------------
34:
35: /**
36: * Add a message to the message set.
37: *
38: * @param reference the message reference to add
39: */
40: void add(MessageReference reference);
41:
42: /**
43: * Remove a message from the message set.
44: *
45: * @param consumer the consumer used to accept the message
46: * @return a message or null if there are no messages
47: */
48: MessageReference remove(Consumer consumer);
49:
50: /**
51: * Lock the message set
52: */
53: void lock();
54:
55: /**
56: * Unlock the message set
57: */
58: void unlock();
59:
60: /**
61: * Set the consumer for out of band notifications
62: *
63: * @param consumer the consumer
64: */
65: void setConsumer(Consumer consumer);
66:
67: // Inner Classes --------------------------------------------------
68: }
|