org.objectweb.dream
Interface Pull


public interface Pull

Common Pull interface for Dream components. This interface defines a method pull that allows a component to ask another component for a message.


Field Summary
static String IN_PULL_ITF_NAME
          The commonly used name to refer to this interface when it is used as an input.
static String OUT_PULL_ITF_NAME
          The commonly used name to refer to this interface when it is used as an output.
 
Method Summary
 Message pull()
          Asks for a message.
 

Field Detail

OUT_PULL_ITF_NAME

static final String OUT_PULL_ITF_NAME
The commonly used name to refer to this interface when it is used as an output.

See Also:
Constant Field Values

IN_PULL_ITF_NAME

static final String IN_PULL_ITF_NAME
The commonly used name to refer to this interface when it is used as an input.

See Also:
Constant Field Values
Method Detail

pull

Message pull()
             throws PullException
Asks for a message. If no message is available, the semantic of this method is left to the component implementing the interface. As an example, it can return null or block until a message is available.

Returns:
the pulled message, or null.
Throws:
PullException - if an exception occurs.


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