| Package | Description |
|---|---|
| net.sf.eBus.client |
This package contains the top-level eBus API which
applications use to interact with eBus.
|
| net.sf.eBus.client.sysmessages |
This package defines the eBus system messages.
|
| net.sf.eBus.messages |
Messages are the heart of eBus.
|
| Modifier and Type | Class and Description |
|---|---|
class |
EMultiFeed<C extends EMessage,F extends net.sf.eBus.client.ESingleFeed>
Multiple key feeds act as a proxy between application objects
and multiple subordinate simple feeds (
EPublishFeed,
ESubscribeFeed, EReplyFeed, and
ERequestFeed), all for a single message class. |
protected static interface |
EMultiFeed.MultiFeedFactory<M extends EMultiFeed,C extends EMessage,F extends EFeed>
This interface is used by
EMultiFeed to
instantiate a new multi-key, sub-class feed. |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractEBusMessage
Base class for eBus
ConnectionMessage and
ServerMessage classes. |
class |
ConnectionMessage
This message reports when a
remote connection has either
logged on or logged off. |
class |
ServerMessage
This message reports the
remote Internet address and TCP port
of a connection newly accepted by EServer but not yet
logged in. |
| Modifier and Type | Method and Description |
|---|---|
protected static <R extends EObject,C extends EMessage,F extends net.sf.eBus.client.ESingleFeed,M extends EMultiFeed<C,F>> |
EMultiFeed.openList(R client,
Class<? extends C> mc,
List<String> subjects,
EFeed.FeedScope scope,
ECondition condition,
EMultiFeed.SubordinateFeedFactory<R,F> subFactory,
EMultiFeed.MultiFeedFactory<M,C,F> multiFactory)
Returns a new, opened multi-key feed for the given
parameters.
|
protected static <R extends EObject,C extends EMessage,F extends net.sf.eBus.client.ESingleFeed,M extends EMultiFeed<C,F>> |
EMultiFeed.openQuery(R client,
Class<? extends C> mc,
Pattern query,
EFeed.FeedScope scope,
ECondition condition,
EMultiFeed.SubordinateFeedFactory<R,F> subFactory,
EMultiFeed.MultiFeedFactory<M,C,F> multiFactory)
Returns a new, opened multi-key feed for the given message
class and subject regular expression query.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
ECondition.test(EMessage msg)
Returns
true if the message meets this condition
and so should be passed to the eBus client; false
if the message should not be passed on. |
| Modifier and Type | Method and Description |
|---|---|
static List<EMessageKey> |
EFeed.findKeys(Class<? extends EMessage> mc)
Returns a list containing message keys for the given
message class found in the message key dictionary.
|
static List<EMessageKey> |
EFeed.findKeys(Class<? extends EMessage> mc,
Pattern query)
Returns a list containing message keys for the given
message class and subject pattern found in the message key
dictionary.
|
static void |
EFeed.storeKeys(Class<? extends EMessage> mc,
ObjectOutputStream oos)
Write those message keys associated with the given message
class to the object output stream.
|
static void |
EFeed.storeKeys(Class<? extends EMessage> mc,
Pattern query,
ObjectOutputStream oos)
Write those message keys associated with the given message
class and a subject matching the regular expression to the
object output stream.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractKeyMessage
Base class for all system messages which contain a message
class name and message subject.
|
class |
AbstractLogonMessage
|
class |
AdMessage
Reports either a notification publisher or a request replier
advertisement to a remote eBus application and whether the
advertisement should be put into place or retracted.
|
class |
CancelRequest
This message is sent to cancel an in-progress request running
on a remote eBus application.
|
class |
FeedStatusMessage
Forwards a notification feed status to a remote eBus
application so it can be reported to the remote subscribers.
|
class |
KeyMessage
This system message is used to exchange
message key-to-identifier mappings.
|
class |
LogoffMessage
Message sent to logoff from a remote eBus application.
|
class |
LogonCompleteMessage
This message is sent by both
ERemoteApp peers to
signal that all initial advertisements are sent, completing
the logon process. |
class |
LogonMessage
This message is sent to logon to a remote eBus application.
|
class |
LogonReply
This message is sent in reply to a logon message.
|
class |
PauseReply
This message is sent is response to a
PauseRequest. |
class |
PauseRequest
This message is sent to request a connection pause with the
remote eBus application.
|
class |
RemoteAck
Acknowledges receipt of a request message from a remote eBus
application.
|
class |
ResumeReply
Response to a connection resume request.
|
class |
ResumeRequest
When an eBus application wants to resume a previous
connection, it sends this
ResumeRequest message
instead of LogonMessage which is used to establish a
new connection. |
class |
SubscribeMessage
This message is sent to a remote publisher to have a
notification feed either started or stopped.
|
| Modifier and Type | Class and Description |
|---|---|
static class |
EMessage.Builder<M extends EMessage,B extends EMessage.Builder<M,?>>
Base class for all
EMessage builders. |
class |
EMessageList<E extends EMessage>
This
message field type allows multiple
messages to be transported within another
eBus message. |
| Modifier and Type | Class and Description |
|---|---|
class |
ENotificationMessage
Required base class for all application publish/subscribe
notification messages.
|
class |
EReplyMessage
Required base class for all application request messages.
|
class |
ERequestMessage
Required base class for all application request messages.
|
class |
ESystemMessage
Required base class for all system messages.
|
| Modifier and Type | Method and Description |
|---|---|
EMessage |
EMessageHeader.message()
Returns the encapsulated eBus message.
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends EMessage> |
EMessageKey.messageClass()
Returns the message class.
|
Class<? extends EMessage> |
EMessageHeader.messageClass()
Returns the message class.
|
Class<? extends EMessage> |
EMessage.MessageType.messageClass()
Returns the associated message class.
|
| Constructor and Description |
|---|
EMessageHeader(int classId,
int fromFeedId,
int toFeedId,
EMessage msg)
Creates a message header with the given key, from and to
feed identifiers and eBus message.
|
EMessageHeader(int classId,
int fromFeedId,
int toFeedId,
SocketAddress address,
EMessage msg)
Creates a message header with the given key, from and to
feed identifiers and eBus message.
|
| Constructor and Description |
|---|
EMessageKey(Class<? extends EMessage> mc,
String subject)
Creates a new message key for the given message class and
subject.
|
Copyright © 2019. All rights reserved.