net.sf.eBus.client

Interface IEReplyFeed

All Superinterfaces:

IEFeed

All Known Implementing Classes:

EMultiReplyFeed, EReplyFeed

public interface IEReplyFeed
extends IEFeed

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

Author:

Charles W. Rapp

Method Summary

Modifier and Type	Method and Description
void	advertise() Advertises this replier fed to the associated request subject.
void	cancelRequestCallback(CancelRequestCallback cb) Puts the cancel request callback in place.
boolean	isAdvertised() Returns true if this reply feed is both open and advertised; otherwise, returns false.
void	requestCallback(RequestCallback cb) Puts the new request callback in place.
void	unadvertise() Retracts this replier feed advertisement.
void	updateFeedState(EFeedState update) Updates the replier feed state to the given value.

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

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

Method Detail

isAdvertised

boolean isAdvertised()

Returns true if this reply feed is both open and advertised; otherwise, returns false.

Returns:

true if this reply feed is open and advertised

requestCallback

void requestCallback(RequestCallback cb)

Puts the new request callback in place. If cb is not null, requests will be passed to cb rather than EReplier.request(EReplyFeed.ERequest). A null cb means that requests are passed to the EReplier.request(EReplyFeed.ERequest) override.

Parameters:

cb - the request callback. May be null.

Throws:

IllegalStateException - if this feed is either closed or advertised.

cancelRequestCallback

void cancelRequestCallback(CancelRequestCallback cb)

Puts the cancel request callback in place. If cb is not null, requests will be passed to cb rather than EReplier.cancelRequest(EReplyFeed.ERequest). A null cb means that cancellations are passed to the EReplier.cancelRequest(EReplyFeed.ERequest) override.

Parameters:

cb - the cancel request callback. May be null.

Throws:

IllegalStateException - if this feed is either closed or advertised.

advertise

void advertise()

Advertises this replier fed to the associated request subject. If this feed is currently advertised to the subject, then does nothing.

Throws:

IllegalStateException - if this feed is closed or if the client did not override EReplier methods nor put the required callbacks in place.

See Also:

unadvertise(), updateFeedState(EFeedState), EFeed.close()

unadvertise

void unadvertise()

Retracts this replier feed advertisement. Does nothing if this feed is not currently advertised.

Throws:

IllegalStateException - if this reply feed is closed.

See Also:

advertise(), IEFeed.close()

updateFeedState

void updateFeedState(EFeedState update)

Updates the replier feed state to the given value. If update equals the currently stored reply feed state, nothing is done. Otherwise, the updated value is stored. If this feed is advertised to the server and the subscription feed is up, then this update is forwarded to subscribed requestors.

Parameters:

update - the new reply feed state.

Throws:

NullPointerException - if update is null.

IllegalStateException - if this feed was closed and is inactive or is not advertised.