org.objectweb.dream.queue.keyed
Interface DoubleKeyedPull

All Known Implementing Classes:
DoubleKeyedOutgoingHandlerBlockingImpl, DoubleKeyedOutgoingHandlerNonBlockingImpl

public interface DoubleKeyedPull

Interface that allows pulling messages mapping two specified keys.


Field Summary
static String IN_DOUBLE_KEYED_PULL_ITF_NAME
          The commonly used name to refer to this interface when it is used as an input.
static String OUT_DOUBLE_KEYED_PULL_ITF_NAME
          The commonly used name to refer to this interface when it is used as an output.
 
Method Summary
 Message pull(Object key1, Object key2)
          Asks for a message matching the given keys.
 

Field Detail

OUT_DOUBLE_KEYED_PULL_ITF_NAME

static final String OUT_DOUBLE_KEYED_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_DOUBLE_KEYED_PULL_ITF_NAME

static final String IN_DOUBLE_KEYED_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(Object key1,
             Object key2)
             throws PullException
Asks for a message matching the given keys. 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.

Parameters:
key1 - the first key that is associated with the message to pull.
key2 - the second key that is associated with the message to pull.
Returns:
the pulled message, or null.
Throws:
PullException - if an exception occurs.


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