org.objectweb.dream.queue.keyed
Interface KeyedPull

All Known Implementing Classes:
KeyedOutgoingHandlerBlockingImpl, KeyedOutgoingHandlerNonBlockingImpl

public interface KeyedPull

Interface that allows pulling messages mapping a specified key.


Field Summary
static String IN_KEYED_PULL_ITF_NAME
          The commonly used name to refer to this interface when it is used as an input.
static String OUT_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 key)
          Asks for a message matching the given key.
 

Field Detail

OUT_KEYED_PULL_ITF_NAME

static final String OUT_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_KEYED_PULL_ITF_NAME

static final String IN_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 key)
             throws PullException
Asks for a message matching the given key. 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:
key - the 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.