net.sf.eBus.client

Interface IEFeed

All Known Subinterfaces:

IEPublishFeed, IEReplyFeed, IERequestFeed, IESubscribeFeed

All Known Implementing Classes:

EFeed, EMultiFeed, EMultiPublishFeed, EMultiReplyFeed, EMultiRequestFeed, EMultiSubscribeFeed, ENotifyFeed, EPublishFeed, EReplyFeed, EReplyFeed.ERequest, ERequestFeed, ERequestFeed.ERequest, ESubscribeFeed

public interface IEFeed

Common base interface for single- and multi-key feeds. Allows feeds to be referenced in a common manner.

Author:

Charles W. Rapp

Method Summary

Modifier and Type	Method and Description
void	close() Permanently closes the feed.
EClient	eClient() Returns the eBus client referenced by this feed.
int	feedId() Returns the unique feed identifier.
boolean	inPlace() Returns true if this feed is "in place" (advertised or subscribed) and false otherwise.
boolean	isActive() Returns true if this feed is still active and false if inactive.
boolean	isFeedUp() Returns true if the feed is up and false otherwise.
EMessageKey	key() Returns the message key associated with this feed.
EFeed.FeedScope	scope() Returns the feed scope.

Method Detail

feedId

int feedId()

Returns the unique feed identifier. The uniqueness is limited to within the client and for the feed lifespan only. When a feed is closed, the feed identifier may be reused.

Returns:

the feed identifier.

scope

EFeed.FeedScope scope()

Returns the feed scope.

Returns:

feed scope.

eClient

EClient eClient()

Returns the eBus client referenced by this feed.

Returns:

eBus client.

isActive

boolean isActive()

Returns true if this feed is still active and false if inactive. Clients may only use active feeds. Once a feed is closed, it is marked inactive and may not be used by the client again.

Returns:

true if this feed is active.

inPlace

boolean inPlace()

Returns true if this feed is "in place" (advertised or subscribed) and false otherwise. When this feed is closed, the feed is automatically un-advertised/un-subscribed.

Returns:

true if the feed is in place.

isFeedUp

boolean isFeedUp()

Returns true if the feed is up and false otherwise.

Returns:

true if the feed is up.

key

EMessageKey key()

Returns the message key associated with this feed.

Returns:

feed message key.

close

void close()

Permanently closes the feed. After closing, this feed may no longer be used.