All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface uhr.core.msg.Connection

public interface Connection
This class describes a single connection between parts in a cell and the cell's MessageRouter. It is used to connect and disconnect connections, as well as describe existing connections. It is immutable.

The implementation should have a no-arg constructor. This should not be used by clients.

Variable Index

o DIRECT
The connection type for a direct hookup from a sender to a receiver.
o INTEREST_IN
The connection type for an interest in messages from inside of the cell.
o INTEREST_OUT
The connection type for an interest in messages from outside of the cell.
o SERVICE_NEED
The connection type for a service need.
o SERVICE_SUPPLIER
The connection type for a service supplier.
o SIGNAL_IN
The connection type for a signal to inside of the cell.
o SIGNAL_OUT
The connection type for a signal to outside of the cell.

Method Index

o convertTypeToConstant(String)
Returns the connection constant given its String representation.
o createDirectConnection(String, String, String, MessageSender, MessageReceiver)
Creates a direct connection.
o createReceiverConnection(String, int, String, MessageReceiver)
Creates a receiver connection.
o createSenderConnection(String, int, String, MessageSender)
Creates a sender connection.
o getConnectionType()
Returns the connection type.
o getConnectionTypeString()
Returns the String for the connection type constant.
o getMessageName()
Returns the message name.
o getMessageReceiver()
Returns the receiver or null if a sender connection.
o getMessageSender()
Returns the sender or null if a receiver connection.
o getReceiverName()
Returns the receiver name or null if a sender connection.
o getSenderName()
Returns the sender name or null if a receiver connection.
o isDirectConnection()
Determines whether this is a direct connection.
o isReceiverConnection()
Determines whether this is a receiver connection.
o isSenderConnection()
Determines whether this is a sender connection.

Variables

o SIGNAL_OUT 
 public static final int SIGNAL_OUT
The connection type for a signal to outside of the cell.

o SIGNAL_IN 
 public static final int SIGNAL_IN
The connection type for a signal to inside of the cell.

o SERVICE_NEED 
 public static final int SERVICE_NEED
The connection type for a service need. The service needed is identified by the message name.

o INTEREST_OUT 
 public static final int INTEREST_OUT
The connection type for an interest in messages from outside of the cell.

o INTEREST_IN 
 public static final int INTEREST_IN
The connection type for an interest in messages from inside of the cell.

o SERVICE_SUPPLIER 
 public static final int SERVICE_SUPPLIER
The connection type for a service supplier. A supplier is a part who can supply the service identified by the message name.

o DIRECT 
 public static final int DIRECT
The connection type for a direct hookup from a sender to a receiver.

Methods

o createSenderConnection 
 public abstract Connection createSenderConnection(String messageName,
                                                   int connectionType,
                                                   String senderName,
                                                   MessageSender sender)
Creates a sender connection. Senders send message signals.

Parameters:
messageName - the name of the signal to connect.
connectionType - the type of connection, which must be SIGNAL_OUT, SIGNAL_IN or SERVICE_NEED.
senderName - the name of the sender part.
sender - the sender in the connection.
o createReceiverConnection 
 public abstract Connection createReceiverConnection(String messageName,
                                                     int connectionType,
                                                     String receiverName,
                                                     MessageReceiver receiver)
Creates a receiver connection. Receivers have interests in particular messages.

Parameters:
messageName - the name of the interest to connect.
connectionType - the type of connection, which must be INTEREST_OUT, INTEREST_IN or SERVICE_SUPPLIER.
receiverName - the name of the receiver part.
receiver - the receiver in the connection.
o createDirectConnection 
 public abstract Connection createDirectConnection(String messageName,
                                                   String senderName,
                                                   String receiverName,
                                                   MessageSender sender,
                                                   MessageReceiver receiver)
Creates a direct connection. Messages with this messageName will go directly as possible from the sender to receiver.

Parameters:
messageName - the name of the interest to connect.
senderName - the name of the sender part.
receiverName - the name of the receiver part.
sender - the sender in the connection.
receiver - the receiver in the connection.
o isSenderConnection 
 public abstract boolean isSenderConnection()
Determines whether this is a sender connection.

Returns:
true is this is a sender connection, false if not.
o isReceiverConnection 
 public abstract boolean isReceiverConnection()
Determines whether this is a receiver connection.

Returns:
true is this is a receiver connection, false if not.
o isDirectConnection 
 public abstract boolean isDirectConnection()
Determines whether this is a direct connection.

Returns:
true is this is a direct connection, false if not.
o getMessageName 
 public abstract String getMessageName()
Returns the message name.

Returns:
the the message name.
o getConnectionType 
 public abstract int getConnectionType()
Returns the connection type.

Returns:
the connection type.
o getConnectionTypeString 
 public abstract String getConnectionTypeString()
Returns the String for the connection type constant. For example if the type is Connection.DIRECT then "DIRECT" is returned.

Returns:
the String for the connection type constant.
o convertTypeToConstant 
 public abstract int convertTypeToConstant(String connectionType)
Returns the connection constant given its String representation. For example if given "DIRECT" then Connection.DIRECT is returned.

Returns:
the connection constant for the String.
o getSenderName 
 public abstract String getSenderName()
Returns the sender name or null if a receiver connection.

Returns:
the sender name or null if a receiver connection.
o getReceiverName 
 public abstract String getReceiverName()
Returns the receiver name or null if a sender connection.

Returns:
the receiver name or null if a sender connection.
o getMessageSender 
 public abstract MessageSender getMessageSender()
Returns the sender or null if a receiver connection.

Returns:
the sender or null if a receiver connection.
o getMessageReceiver 
 public abstract MessageReceiver getMessageReceiver()
Returns the receiver or null if a sender connection.

Returns:
the receiver or null if a sender connection. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index