org.objectweb.dream.protocol.bus
Interface BusProtocol

All Superinterfaces:
Protocol
All Known Subinterfaces:
LogicalClockBusProtocol
All Known Implementing Classes:
BusProtocolImpl, ProtocolImpl

public interface BusProtocol
extends Protocol

Specialized Protocol interface for protocol components providing BusOutgoingPush interface as result of a binding.

See Also:
Protocol

Field Summary
static String LOCAL_ADDRESS_HINT_KEY
          Hints key that can be used to specify the address of this protocol instance (ie. the index in the array of lower export identifier of the given BusExportIdentifier that other protocol instances must use to access to this one)
 
Fields inherited from interface org.objectweb.dream.protocol.Protocol
ITF_NAME, LOWER_PROTOCOL_ITF_NAME
 
Method Summary
 BusOutgoingPush bind(ExportIdentifier exportId, IncomingPush toClientPush, Map<String,Object> hints)
          Binds to a previously exported ChannelFactory interface designated by the given export identifier.
 
Methods inherited from interface org.objectweb.dream.protocol.Protocol
createExportIdentifier
 

Field Detail

LOCAL_ADDRESS_HINT_KEY

static final String LOCAL_ADDRESS_HINT_KEY
Hints key that can be used to specify the address of this protocol instance (ie. the index in the array of lower export identifier of the given BusExportIdentifier that other protocol instances must use to access to this one)

See Also:
Constant Field Values
Method Detail

bind

BusOutgoingPush bind(ExportIdentifier exportId,
                     IncomingPush toClientPush,
                     Map<String,Object> hints)
                     throws InvalidExportIdentifierException,
                            BindException
Binds to a previously exported ChannelFactory interface designated by the given export identifier. This methods instantiate a new communication channel and returns an interface on which messages can be sent to the server. In addition the toClientPush interface is the interface on which the client want to receive messages from the server.

Parameters:
exportId - the identifier of the exported interface.
toClientPush - the interface on which the client want to receive messages from the server.
hints - additional parameters, can be null.
Returns:
a BusOutgoingPush interface on which message can be send to the exported interface.
Throws:
InvalidExportIdentifierException - if the given export identifier is incorrect.
BindException - if the binding process fails.


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