org.objectweb.dream.protocol.messagePassing
Interface MessagePassingProtocol

All Superinterfaces:
Protocol
All Known Subinterfaces:
ReliableMessagePassingProtocol, UDPProtocol
All Known Implementing Classes:
BufferedMessagePassingProtocolImpl, FragmentationProtocolImpl, MessagePassingOverChannelImpl, ReliableMessagePassingProtocolImpl, SerializatorMessagePassingProtocolImpl, UDPProtocolImpl

public interface MessagePassingProtocol
extends Protocol

A interface for message passing protocol. The export(org.objectweb.dream.protocol.IncomingPush, java.util.Map) operation creates an access point through which messages can be sent or received. Since this protocol interface provides a connection less protocol abstraction, no bind operation is available.


Field Summary
static String FROM_CHUNK_NAME
          If this key is specified in the export hints map, an ExportIdentifierChunk will be added with the given name in every received messages.
 
Fields inherited from interface org.objectweb.dream.protocol.Protocol
ITF_NAME, LOWER_PROTOCOL_ITF_NAME
 
Method Summary
 MessagePassingOutgoingPush export(IncomingPush incomingPushItf, Map<String,Object> hints)
          Creates an access point and returns an interface that can be used to send messages through it.
 
Methods inherited from interface org.objectweb.dream.protocol.Protocol
createExportIdentifier
 

Field Detail

FROM_CHUNK_NAME

static final String FROM_CHUNK_NAME
If this key is specified in the export hints map, an ExportIdentifierChunk will be added with the given name in every received messages. This chunk will contains the ExportIdentifier of the remote access point that send the message.
Depending implementation, some incoming messages may not contain the from chunk if the ExportIdentifier of the remote access point cannot be determined.

See Also:
Constant Field Values
Method Detail

export

MessagePassingOutgoingPush export(IncomingPush incomingPushItf,
                                  Map<String,Object> hints)
                                  throws ExportException
Creates an access point and returns an interface that can be used to send messages through it. Messages received on this access point will be passed to the given IncomingPush interface.

Parameters:
incomingPushItf - the interface on which message received on the created access point will be passed, may be null.
hints - additional parameters, can be null.
Returns:
an interface which can be used to send messages through the created access point
Throws:
ExportException - if the export process fails.


Copyright © 2003, 2005 - INRIA Rhone-Alpes - All Rights Reserved.