net.sf.eBus.client

Interface IERequestFeed

All Superinterfaces:

IEFeed

All Known Implementing Classes:

EMultiRequestFeed, ERequestFeed

public interface IERequestFeed
extends IEFeed

Provides a common view of single- and multi-key request feeds, allowing such feeds to be referenced in a common way.

Author:

Charles W. Rapp

Method Summary

Modifier and Type	Method and Description
void	replyCallback(Class<? extends EReplyMessage> mc, ReplyCallback cb) Sets the callback for a specific reply message class.
void	replyCallback(ReplyCallback cb) Puts the reply message callback in place for all reply types.
void	statusCallback(FeedStatusCallback<ERequestFeed> cb) Puts the feed status callback in place.
void	subscribe() Activates this replier status subscription.
void	unsubscribe() De-activates this replier status subscription.

Methods inherited from interface net.sf.eBus.client.IEFeed

close, eClient, feedId, inPlace, isActive, isFeedUp, key, scope

Method Detail

statusCallback

void statusCallback(FeedStatusCallback<ERequestFeed> cb)

Puts the feed status callback in place.

Parameters:

cb - the feed status update callback. May be null.

replyCallback

void replyCallback(ReplyCallback cb)

Puts the reply message callback in place for all reply types. If cb is not null, replies will be passed to cb rather than ERequestor.reply(int, EReplyMessage, ERequestFeed.ERequest). A null cb results in replies posted to the ERequestor.reply(int, EReplyMessage, ERequestFeed.ERequest) override.

Note that this method call overrides all previous calls to replyCallback(Class, ReplyCallback). If the goal is to use a generic callback for all replies except one specific message, then use this method to put the generic callback in place first and then use replyCallback(EMessageKey, ReplyCallback).

Parameters:

cb - reply message callback. May be null.

Throws:

IllegalStateException - if this feed is either closed or subscribed.

See Also:

replyCallback(Class, ReplyCallback)

replyCallback

void replyCallback(Class<? extends EReplyMessage> mc,
                   ReplyCallback cb)

Sets the callback for a specific reply message class. If cb is not null, replies will be passed to cb rather than ERequestor.reply(int, EReplyMessage, ERequestFeed.ERequest). A cb results in replies posted to the ERequestor.reply(int, EReplyMessage, ERequestFeed.ERequest) override.

If the goal is to set a single callback method for all reply message types, then use replyCallback(ReplyCallback). Note that method overrides all previous set reply callbacks.

Parameters:

mc - the reply message class.

cb - callback for the reply message.

Throws:

NullPointerException - if mc is null.

IllegalArgumentException - if mc is not a reply for this request.

IllegalStateException - if this feed is either closed or subscribed.

subscribe

void subscribe()

Activates this replier status subscription.

unsubscribe

void unsubscribe()

De-activates this replier status subscription. Does nothing if not currently subscribed.