Errai 3.0.1-SNAPSHOT

org.jboss.errai.bus.server.io
Interface MessageDeliveryHandler

All Known Implementing Classes:
BufferDeliveryHandler, DirectDeliveryHandler

public interface MessageDeliveryHandler

The MessageDeliveryHandler defines the behavior of the message bus relative to the transport layer.

Author:
Mike Brock

Method Summary
 boolean deliver(MessageQueue queue, Message message)
          This method is responsible for delivering a message into the transport layer.
 void noop(MessageQueue queue)
          Sends a NOOP (No-Operation) to the remote connected
 

Method Detail

deliver

boolean deliver(MessageQueue queue,
                Message message)
                throws IOException
This method is responsible for delivering a message into the transport layer. The contract between the message bus and the transport layer is completely governed by the implementation of the method.

Parameters:
queue - the MessageQueue to deliver from.
message - the Message to deliver.
Returns:
true if the message was successfully accepted.
Throws:
IOException - an IOException may be thrown if there is a problem interacting with the underlying transport.

noop

void noop(MessageQueue queue)
          throws IOException
Sends a NOOP (No-Operation) to the remote connected

Parameters:
queue -
Throws:
IOException

Errai 3.0.1-SNAPSHOT

Copyright © 2013-2014 JBoss, a division of Red Hat. All Rights Reserved.