ChannelHandler

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.messaging.channel.plugins.handler
Interface ChannelHandler

All Superinterfaces:: Consumer (src)

All Known Implementing Classes:: AbstractChannelHandler (src)

public interface ChannelHandler
extends Consumer (src)

A channel handler.

Method Summary
`void`	`addMessage(MessageReference (src) reference)` Add a message to the channel handler.
`MessageReference (src)`	`removeMessage(Consumer (src) consumer)` Remove a message from the channel handler.
`void`	`stopWaitMessage(Consumer (src) consumer)` Remove a consumer that is waiting for a message.
`void`	`waitMessage(Consumer (src) consumer, long wait)` Wait for a message from the channel handler.

Methods inherited from interface org.jboss.messaging.interfaces.Consumer (src)

accepts, onMessage

Method Detail

addMessage

public void addMessage(MessageReference (src)  reference)

Add a message to the channel handler.

Parameters:: reference - the message reference to add

removeMessage

public MessageReference (src)  removeMessage(Consumer (src)  consumer)

Remove a message from the channel handler.

Parameters:: consumer - the consumer used to accept the message
Returns:: a message or null if there are no messages

waitMessage

public void waitMessage(Consumer (src)  consumer,
                        long wait)

Wait for a message from the channel handler.

Parameters:: consumer - the consumer that will wait for a message; wait - the length of time

stopWaitMessage

public void stopWaitMessage(Consumer (src)  consumer)

Remove a consumer that is waiting for a message.

Parameters:: consumer - the consumer to remove.