org.primefaces.push

Interface EventBus

All Known Implementing Classes:

EventBusImpl

public interface EventBus

A distributed lightweight event bus which can encompass multiple PushEndpoint instances. The event bus implements publish / subscribe and point to point messaging. Messages sent over the event bus can be of any type. For publish / subscribe, messages can be published to a Java class annotated with the PushEndpoint.value() using one of the method annotated with OnMessage.

PushEndpoint are registered against a path, defined using the PushEndpoint.value(). There can be multiple PushEndpoint registered against each path, and a particular PushEndpoint can be registered against multiple paths. The event bus will route a sent message to all PushEndpoint which are registered against that path. When sending a message, a EventBus.Reply can be provided. If so, it will be called when the reply from the receiver has been completed. Instances of EventBus are thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EventBus.Reply

Method Summary

Modifier and Type	Method and Description
EventBus	publish(Object o) Fire an object to all connected RemoteEndpoint
EventBus	publish(String path, Object o) Fire an object to RemoteEndpoint that connected using the path value.
EventBus	publish(String path, Object o, EventBus.Reply r) Fire an object to RemoteEndpoint that connected using the path value.
<T> Future<T>	schedule(String path, T t, int time, TimeUnit unit) Schedule a period push operation.

Method Detail

publish

EventBus publish(Object o)

Fire an object to all connected RemoteEndpoint

Parameters:

o - an Object

Returns:

this

publish

EventBus publish(String path,
                 Object o)

Fire an object to RemoteEndpoint that connected using the path value.

Parameters:

path - A String starting with '/'

o - an Object

Returns:

this

publish

EventBus publish(String path,
                 Object o,
                 EventBus.Reply r)

Fire an object to RemoteEndpoint that connected using the path value.

Parameters:

path - A String starting with '/'

o - an Object

r - an EventBus.Reply

Returns:

this

schedule

<T> Future<T> schedule(String path,
                       T t,
                       int time,
                       TimeUnit unit)

Schedule a period push operation.

Type Parameters:

T - The type of the message

Parameters:

path - a channel of communication.

t - a message

time - the time

unit - the TimeUnit

Returns:

a Future that can used to cancel the periodic push