Java Doc for SendLink.java in » Science » Cougaar12_4 » org » cougaar » mts » base » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Science » Cougaar12_4 » org.cougaar.mts.base

Source Cross Reference Class Diagram Java Document (Java Doc)

org.cougaar.mts.base .SendLink

All known Subclasses:   org.cougaar.mts.base .SendLinkImpl,  org.cougaar.mts.base .SendLinkDelegateImplBase,
SendLink
public interface SendLink (Code)
SendLink is the first station after the MessageTransportService implementation class. Its primary job is to validate the originator and add the message to the SendQueue, thereby ending the call sequence from the caller's point of view (sendMessage).

See Also:   org.cougaar.core.service.MessageTransportService
See Also:   SendQueue
See Also:   Router
See Also:   DestinationQueue
See Also:   DestinationLink
See Also:   MessageWriter
See Also:   MessageReader
See Also:   MessageDeliverer
See Also:   ReceiveLink
See Also:   Javadoc contribuions from George Mount.

Method Summary
boolean addressKnown(MessageAddress address)
     Returns true iff some LinkProtocol recognizes the given address.
Parameters:
  address - MessageAddress whose status is to be determined.
void flushMessages(ArrayList messages)
     Causes any queued or pending messages from the address associated with the SendLink to be removed from the queues, The list of flushed messages is returned in the supplied ArrayList.
MessageAddress getAddress()
     Returns the MessageAddress that this SendLink is associated with.
AgentState getAgentState()
     Returns an AgentState that can be used by aspects to store and retrieve MTS-client-based data.
String getIdentifier()
     Returns the internal name of the Node's MTS.
boolean okToSend(AttributedMessage message)
     Returns true if it is possible to send message.
void registerClient(MessageTransportClient client)
     Calls the MessageTransportRegistry's registerClient, which in turn calls the registerClient for all LinkProtocols.
void release()
     Releases hooks into the MTS and invalidates the SendLink.
void sendMessage(AttributedMessage message)
     Validates the originator and add the message to the SendQueue, thereby ending the call sequence from the caller's point of view.
void unregisterClient(MessageTransportClient client)
     Unregisters the client from all LinkProtocols.

Method Detail
addressKnown
boolean addressKnown(MessageAddress address)(Code)
Returns true iff some LinkProtocol recognizes the given address.
Parameters:
  address - MessageAddress whose status is to be determined. true iff one of the registered LinkProtocols knows address.

flushMessages
void flushMessages(ArrayList messages)(Code)
Causes any queued or pending messages from the address associated with the SendLink to be removed from the queues, The list of flushed messages is returned in the supplied ArrayList.
Parameters:
  messages - Dropped messages are added to this list.
See Also:   org.cougaar.core.service.MessageTransportService.flushMessages

getAddress
MessageAddress getAddress()(Code)
Returns the MessageAddress that this SendLink is associated with.

getAgentState
AgentState getAgentState()(Code)
Returns an AgentState that can be used by aspects to store and retrieve MTS-client-based data.

getIdentifier
String getIdentifier()(Code)
Returns the internal name of the Node's MTS. In the current implementation this is just the Node's name, but no assumption should be made that this wll always be true. All SendLinks in a given MTS will always return the same value here.

okToSend
boolean okToSend(AttributedMessage message)(Code)
Returns true if it is possible to send message. SendLinkImpl only checks that the target MessageAddress is properly formed and release() has not been called.
Parameters:
  message - The message to should be checked for validity.
See Also:   org.cougaar.core.service.MessageTransportService.sendMessage(Message)

registerClient
void registerClient(MessageTransportClient client)(Code)
Calls the MessageTransportRegistry's registerClient, which in turn calls the registerClient for all LinkProtocols. One and only one client should be registered with a SendLink. Once registered, a ReceiveLink is created so that the client can receive messages.
Parameters:
  client - The MTS client to register.
See Also:   org.cougaar.core.service.MessageTransportService.registerClient(MessageTransportClient)
See Also:   MessageTransportRegistryService.registerClient(MessageTransportClient)

release
void release()(Code)
Releases hooks into the MTS and invalidates the SendLink. Called when the MessageTransportService is released by the MessageTransportClient associated with this SendLink.

sendMessage
void sendMessage(AttributedMessage message)(Code)
Validates the originator and add the message to the SendQueue, thereby ending the call sequence from the caller's point of view. Invoked from the MessageTransportService impl class method of the same name, which will have already wrapped the original message in an AttributedMessage, using the original message target address's attributes.
Parameters:
  message - The AttributedMessage to be sent.
See Also:   SendQueue.sendMessage(AttributedMessage)
See Also:   org.cougaar.core.service.MessageTransportService.sendMessage(Message)

unregisterClient
void unregisterClient(MessageTransportClient client)(Code)
Unregisters the client from all LinkProtocols. The client should be the client that was previously passed in registerClient. The client will no longer be able to receive messages.
Parameters:
  client - The MTS client to unregister.
See Also:   org.cougaar.core.service.MessageTransportService.unregisterClient(MessageTransportClient)
See Also:   MessageTransportRegistryService.unregisterClient(MessageTransportClient)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.