org.objectweb.dream.protocol.channel
Interface ChannelFactory

All Known Implementing Classes:
MultiplexExportProtocolImpl, ProtocolImpl.SkeletonChannel

public interface ChannelFactory

A communication channel factory interface, that a ChannelProtocol can export. Each time a client binds to this exported interface, the instantiate(org.objectweb.dream.protocol.OutgoingPush) method is called to establish a new communication channel to this new client.


Field Summary
static String CHANEL_ITF_NAME
          The commonly used name of this interface.
static String EXPORTED_CHANNEL_ITF_NAME
          The commonly used name of this interface when it is used as a client collection interface of a protocol bound to the exported channel.
 
Method Summary
 IncomingPush instantiate(OutgoingPush toClientPush)
          Notify the protocol who exports this interface, that a client is opening a new communication channel.
 

Field Detail

CHANEL_ITF_NAME

static final String CHANEL_ITF_NAME
The commonly used name of this interface.

See Also:
Constant Field Values

EXPORTED_CHANNEL_ITF_NAME

static final String EXPORTED_CHANNEL_ITF_NAME
The commonly used name of this interface when it is used as a client collection interface of a protocol bound to the exported channel.

See Also:
Constant Field Values
Method Detail

instantiate

IncomingPush instantiate(OutgoingPush toClientPush)
                         throws BindException
Notify the protocol who exports this interface, that a client is opening a new communication channel. The toClientPush interface can be used to send messages to the client. This method returns the interface on which messages sent by the client will be passed.

Parameters:
toClientPush - the interface that can be used to send messages to the client through the newly created communication channel.
Returns:
the interface on which messages sent by the client will be passed.
Throws:
BindException - if the bind process fails.


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