Errai 3.0.1-SNAPSHOT

org.jboss.errai.bus.client.api.builder
Interface MessageBuildSendableDispatcher

All Superinterfaces:
MessageBuildSendable, Sendable
All Known Subinterfaces:
MessageBuildSendableWithReply, MessageReplySendable

public interface MessageBuildSendableDispatcher
extends MessageBuildSendable

Author:
Mike Brock .

Method Summary
 AsyncTask sendDelayedWith(RequestDispatcher viaThis, TimeUnit unit, int interval)
          Sends the message after a specified delay with the specified RequestDispatcher.
 void sendGlobalWith(RequestDispatcher viaThis)
          Sends the message globally with the specified RequestDispatcher.
 void sendNowWith(RequestDispatcher viaThis)
          Sends the message with the specified RequestDispatcher.
 AsyncTask sendRepeatingWith(RequestDispatcher viaThis, TimeUnit unit, int interval)
          Sends the message periodically with the specified RequestDispatcher.
 
Methods inherited from interface org.jboss.errai.bus.client.api.builder.MessageBuildSendable
sendGlobalWith, sendNowWith, sendNowWith
 
Methods inherited from interface org.jboss.errai.bus.client.api.builder.Sendable
getMessage
 

Method Detail

sendNowWith

void sendNowWith(RequestDispatcher viaThis)
Sends the message with the specified RequestDispatcher.

Parameters:
viaThis - the dispatcher to send the message with, usually obtained in client code via Errai IOC dependency injection.

sendGlobalWith

void sendGlobalWith(RequestDispatcher viaThis)
Sends the message globally with the specified RequestDispatcher.

Parameters:
viaThis - the dispatcher to send the message with, usually obtained in client code via Errai IOC dependency injection.

sendRepeatingWith

AsyncTask sendRepeatingWith(RequestDispatcher viaThis,
                            TimeUnit unit,
                            int interval)
Sends the message periodically with the specified RequestDispatcher.

Parameters:
viaThis - the dispatcher to send the message with, usually obtained in client code via Errai IOC dependency injection.
unit - The time unit that interval should be interpreted as.
interval - The amount of time to wait between message retransmissions (units specified by the unit parameter).
Returns:
A handle on the repeating task which can be used to cancel it.

sendDelayedWith

AsyncTask sendDelayedWith(RequestDispatcher viaThis,
                          TimeUnit unit,
                          int interval)
Sends the message after a specified delay with the specified RequestDispatcher.

Parameters:
viaThis - the dispatcher to send the message with, usually obtained in client code via Errai IOC dependency injection.
unit - The time unit that interval should be interpreted as.
interval - The amount of time to wait before sending the message (units specified by the unit parameter).
Returns:
A handle on the repeating task which can be used to cancel it.

Errai 3.0.1-SNAPSHOT

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