01: /*
02: * <copyright>
03: *
04: * Copyright 1997-2004 BBNT Solutions, LLC
05: * under sponsorship of the Defense Advanced Research Projects
06: * Agency (DARPA).
07: *
08: * You can redistribute this software and/or modify it under the
09: * terms of the Cougaar Open Source License as published on the
10: * Cougaar Open Source Website (www.cougaar.org).
11: *
12: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
14: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
15: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
16: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
17: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
18: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23: *
24: * </copyright>
25: */
26:
27: package org.cougaar.mts.base;
28:
29: import org.cougaar.core.mts.MessageAttributes;
30: import org.cougaar.core.mts.MessageTransportClient;
31: import org.cougaar.mts.std.AttributedMessage;
32:
33: /**
34: * The final station in the message transport system before an
35: * incoming message is delivered to an Agent. One ReceiveLink is
36: * instantiated for each MessageTransportClient. <p> The previous
37: * station is MessageDeliverer.
38: *
39: * @see org.cougaar.core.service.MessageTransportService#registerClient(MessageTransportClient)
40: * @see SendLink
41: * @see SendQueue
42: * @see Router
43: * @see DestinationQueue
44: * @see DestinationLink
45: * @see MessageWriter
46: * @see MessageReader
47: * @see MessageDeliverer
48: *
49: * Javadoc contributions from George Mount.
50: */
51: public interface ReceiveLink {
52: /**
53: * Deliver the message to the final recipient (an Agent).
54: * The message is unwrapped by the implementation before
55: * calling MessageTransportClient receiveMessage.
56: *
57: * @param message The message to be delivered.
58: * @see MessageTransportClient#receiveMessage
59: */
60: MessageAttributes deliverMessage(AttributedMessage message);
61:
62: /**
63: * Returns the client associated with this ReceiveLink
64: */
65: MessageTransportClient getClient();
66:
67: }
|