net.sf.eBus.client

Class ERequestFeed.ERequest

java.lang.Object

net.sf.eBus.client.EFeed

net.sf.eBus.client.ERequestFeed.ERequest

All Implemented Interfaces:

IEFeed

Enclosing class:

ERequestFeed

public static final class ERequestFeed.ERequest
extends EFeed

This class represents an individual request, tracking the current request state and the remaining repliers. This class acts as a conduit from the EReplier to the ERequestor, routing replies back to the requestor.

A requestor can cancel an in-progress request by calling EFeed.close(). Once canceled, no new replies will be delivered to the requestor. However, in-flight replies already scheduled for delivery will be delivered.

Note: Applications are responsible for tracking active requests once instantiated. ERequestFeed does not track active requests for the application.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ESingleFeed.FeedType Enumerates the supported feed types.

Nested classes/interfaces inherited from class net.sf.eBus.client.EFeed

EFeed.AbstractClientTask, EFeed.FeedScope, EFeed.NotifyTask, EFeed.StatusTask<T extends IEFeed>

Field Summary

Fields

Modifier and Type	Field and Description
protected int	mActivationCount Tracks the number of contra-feeds matched to this feed.
protected static List<EFeed>	mAdvertisers Track the advertised feeds in order to generate advertise messages.
protected ESingleFeed.FeedType	mFeedType Specifies whether this is a publish, subscribe, request, or reply feed.
protected net.sf.eBus.client.ESubject	mSubject The feed interfaces with this eBus subject.

Fields inherited from class net.sf.eBus.client.EFeed

mEClient, mFeedId, mFeedState, mInPlace, mIsActive, mScope, NO_CONDITION, NOTIFY_METHOD

Method Summary

Modifier and Type	Method and Description
int	activationCount() Returns the feed activation count.
protected void	inactivate() If this request is still active, then automatically cancels this request with all extant repliers.
EMessageKey	key() Returns the feed message key.
String	messageSubject() Returns the feed message key subect.
int	repliersRemaining() Returns the number of repliers still replying to the request.
ERequestFeed.RequestState	requestState() Returns the request current state.
String	toString() Returns a containing the feed message key and data member values.

Methods inherited from class net.sf.eBus.client.EFeed

addAllKeys, addKey, checkScopes, clientId, close, defaultDispatcher, eClient, equals, feedId, feedState, findKeys, findKeys, findKeys, hashCode, inPlace, isActive, isFeedUp, isOverridden, loadKeys, location, register, register, register, scope, shutdown, shutdown, shutdownAll, startup, startup, startupAll, storeKeys, storeKeys, storeKeys

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

mAdvertisers

protected static final List<EFeed> mAdvertisers

Track the advertised feeds in order to generate advertise messages.

mFeedType

protected final ESingleFeed.FeedType mFeedType

Specifies whether this is a publish, subscribe, request, or reply feed.

mSubject

protected final net.sf.eBus.client.ESubject mSubject

The feed interfaces with this eBus subject. The subject type is based on feed type.

mActivationCount

protected int mActivationCount

Tracks the number of contra-feeds matched to this feed. If this is a publisher feed, then counts subscriber feeds. If a subscriber feed, then counts publisher feeds.

Method Detail

inactivate

protected void inactivate()

If this request is still active, then automatically cancels this request with all extant repliers. No further replies will be delivered to the requestor unless previously scheduled for delivery.

Specified by:

inactivate in class EFeed

toString

public String toString()

Returns a containing the feed message key and data member values.

Returns:

textual representation of this feed.

requestState

public ERequestFeed.RequestState requestState()

Returns the request current state.

Returns:

request current state.

repliersRemaining

public int repliersRemaining()

Returns the number of repliers still replying to the request. Will be zero if the request state is ERequestFeed.RequestState.NOT_PLACED or ERequestFeed.RequestState.DONE.

Returns:

number of in-progress repliers.

key

public final EMessageKey key()

Returns the feed message key. The message key type matches the feed type. If this is a EPublishFeed, then a notification message key is returned.

Returns:

message key.

messageSubject

public final String messageSubject()

Returns the feed message key subect.

Returns:

message key subject.

activationCount

public final int activationCount()

Returns the feed activation count.

Returns:

value ≥ zero.