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.core.service;
28:
29: import org.cougaar.core.component.Service;
30: import org.cougaar.core.mts.AgentState;
31: import org.cougaar.core.mts.Message;
32: import org.cougaar.core.mts.MessageAddress;
33: import org.cougaar.core.mts.MessageTransportClient;
34:
35: /**
36: * This service is the node-level message transport that agents
37: * use to send and receive messages.
38: *
39: * @see org.cougaar.core.agent.service.MessageSwitchService for
40: * intra-agent message handling.
41: */
42: public interface MessageTransportService extends Service {
43:
44: /**
45: * Ask MessageTransport to deliver a message (asynchronously).
46: * message.getTarget() names the destination. The client must be
47: * registered, otherwise the message will not be sent.
48: */
49: void sendMessage(Message m);
50:
51: /**
52: * Register a client with MessageTransport. A client is any
53: * object which can receive Messages directed to it as the Target
54: * of a message.
55: */
56: void registerClient(MessageTransportClient client);
57:
58: /**
59: * Unregister a client with MessageTransport. No further
60: * sendMessage calls will be accepted, and any queued messages
61: * which aren't successfully delivered will be dropped.
62: */
63: void unregisterClient(MessageTransportClient client);
64:
65: /**
66: * Block until all queued messages have been sent (or dropped).
67: * @return The list of dropped messages (could be null).
68: */
69: java.util.ArrayList flushMessages();
70:
71: /**
72: * @return the name of the entity that this MessageTransport
73: * represents. Will usually be the name of a node.
74: */
75: String getIdentifier();
76:
77: /** @return true IFF the MessageAddress is known to the nameserver */
78: boolean addressKnown(MessageAddress a);
79:
80: AgentState getAgentState();
81: }
|