|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DoubleKeyedBufferRemove
This interface defines methods that must be implemented by a buffer to allow components to get or delete messages from it, according to two keys associated with each message. Such an interface is used by consumers of messages.
Note 1: all the messages that are stored in a buffer are not always available for removal (e.g. when the buffer implements an ordering policy). Note 2: buffer implementations MUST BE thread-safe .
Field Summary | |
---|---|
static String |
ITF_NAME
The commonly used name to refer to an interface with this signature. |
Method Summary | |
---|---|
Message |
get(Object key1,
Object key2)
Gets the message from the buffer that is associated with the specified keys. |
Message |
remove(Object key1,
Object key2)
Removes the message from the buffer that is associated with the specified keys. |
Message |
removeAll()
Removes all the available messages from the buffer. |
Message |
removeAll(Object key)
Removes all the available messages from the buffer that maps the specified key. |
Message |
tryGet(Object key1,
Object key2)
Gets the message from the buffer that is associated with the specified keys. |
Message |
tryRemove(Object key1,
Object key2)
Removes the message from the buffer that is associated with the specified keys. |
Field Detail |
---|
static final String ITF_NAME
Method Detail |
---|
Message get(Object key1, Object key2) throws InterruptedException
key1
- the first key that is associated with the message to get; never
null
.key2
- the second key that is associated with the message to get; can
be null
.
null
.
InterruptedException
- if it is interrupted while waiting for a
message to be added.BufferRemove.get()
Message tryGet(Object key1, Object key2) throws InterruptedException
key1
- the first key that is associated with the message to get; never
null
.key2
- the second key that is associated with the message to get; can
be null
.
null
otherwise.
InterruptedException
- if it is interrupted while waiting for the
mutex to be acquired.BufferRemove.tryGet()
Message remove(Object key1, Object key2) throws InterruptedException
key1
- the first key that is associated with the message to get; never
null
.key2
- the second key that is associated with the message to get; can
be null
.
null
.
InterruptedException
- if it is interrupted while waiting for a
message to be added.BufferRemove.remove()
Message tryRemove(Object key1, Object key2)
key1
- the first key that is associated with the message to get; never
null
.key2
- the second key that is associated with the message to get; can
be null
.
null
otherwise.BufferRemove.tryRemove()
Message removeAll(Object key)
null
. This method does not
block.
key
- the key which messages that are removed must match.
null
if no message was available.BufferRemove.removeAll()
Message removeAll()
null
. This method does not block.
null
if no message was available.BufferRemove.removeAll()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |