reactor.core

Interface Observable

All Known Implementing Classes:

Reactor

public interface Observable

Basic unit of event handling in Reactor.

Method Summary

Modifier and Type	Method and Description
<T> Consumer<java.lang.Iterable<Event<T>>>	batchNotify(java.lang.Object key) Notify the key with all any accepted iterable group of events by the returned Consumer.
<T> Consumer<java.lang.Iterable<Event<T>>>	batchNotify(java.lang.Object key, Consumer<java.lang.Void> consumer) Notify the key with all any accepted iterable group of events by the returned Consumer.
Observable	notify(java.lang.Object key) Notify this component that the consumers registered with a Selector that matches the key should be triggered with a null input argument.
<E extends Event<?>> Observable	notify(java.lang.Object key, E ev) Notify this component that an Event is ready to be processed.
<E extends Event<?>> Observable	notify(java.lang.Object key, E ev, Consumer<E> onComplete) Notify this component that an Event is ready to be processed and accept onComplete after dispatching.
<S extends Supplier<? extends Event<?>>> Observable	notify(java.lang.Object key, S supplier) Notify this component that the given Supplier can provide an event that's ready to be processed.
<E extends Event<?>> Registration<Consumer<E>>	on(Selector sel, Consumer<E> consumer) Register a Consumer to be triggered when a notification matches the given Selector.
<T> Consumer<Event<T>>	prepare(java.lang.Object key) Create an optimized path for publishing notifications to the given key.
<E extends Event<?>,V> Registration<Consumer<E>>	receive(Selector sel, Function<E,V> fn) Assign a Function to receive an Event and produce a reply of the given type.
boolean	respondsToKey(java.lang.Object key) Are there any Registrations with Selectors that match the given key.
<E extends Event<?>> Observable	send(java.lang.Object key, E ev) Notify this component of the given Event and register an internal Consumer that will take the output of a previously-registered Function and respond using the key set on the Event's replyTo property.
<E extends Event<?>> Observable	send(java.lang.Object key, E ev, Observable replyTo) Notify this component of the given Event and register an internal Consumer that will take the output of a previously-registered Function and respond to the key set on the Event's replyTo property and will call the notify method on the given Observable.
<S extends Supplier<? extends Event<?>>> Observable	send(java.lang.Object key, S supplier) Notify this component that the given Supplier will provide an Event and register an internal Consumer that will take the output of a previously-registered Function and respond using the key set on the Event's replyTo property.
<S extends Supplier<? extends Event<?>>> Observable	send(java.lang.Object key, S supplier, Observable replyTo) Notify this component that the given Supplier will provide an Event and register an internal Consumer that will take the output of a previously-registered Function and respond to the key set on the Event's replyTo property and will call the notify method on the given Observable.
<REQ extends Event<?>,RESP extends Event<?>> Observable	sendAndReceive(java.lang.Object key, REQ ev, Consumer<RESP> reply) Register the given Consumer on an anonymous Selector and set the given event's replyTo property to the corresponding anonymous key, then register the consumer to receive replies from the Function assigned to handle the given key.
<REQ extends Event<?>,RESP extends Event<?>,S extends Supplier<REQ>> Observable	sendAndReceive(java.lang.Object key, S supplier, Consumer<RESP> reply) Register the given Consumer on an anonymous Selector and set the event's replyTo property to the corresponding anonymous key, then register the consumer to receive replies from the Function assigned to handle the given key.

Method Detail

respondsToKey

boolean respondsToKey(java.lang.Object key)

Are there any Registrations with Selectors that match the given key.

Parameters:

key - The key to be matched by Selectors

Returns:

true if there are any matching Registrations, false otherwise

on

<E extends Event<?>> Registration<Consumer<E>> on(Selector sel,
                                                  Consumer<E> consumer)

Register a Consumer to be triggered when a notification matches the given Selector.

Type Parameters:

E - The type of the Event

Parameters:

sel - The Selector to be used for matching

consumer - The Consumer to be triggered

Returns:

A Registration object that allows the caller to interact with the given mapping

receive

<E extends Event<?>,V> Registration<Consumer<E>> receive(Selector sel,
                                                         Function<E,V> fn)

Assign a Function to receive an Event and produce a reply of the given type.

Type Parameters:

E - The type of the Event

V - The type of the response data

Parameters:

sel - The Selector to be used for matching

fn - The transformative Function to call to receive an Event

Returns:

A Registration object that allows the caller to interact with the given mapping

notify

<E extends Event<?>> Observable notify(java.lang.Object key,
                                       E ev,
                                       Consumer<E> onComplete)

Notify this component that an Event is ready to be processed and accept onComplete after dispatching.

Type Parameters:

E - The type of the Event

Parameters:

key - The key to be matched by Selectors

ev - The Event

onComplete - The callback Consumer

Returns:

this

notify

<E extends Event<?>> Observable notify(java.lang.Object key,
                                       E ev)

Notify this component that an Event is ready to be processed.

Type Parameters:

E - The type of the Event

Parameters:

key - The key to be matched by Selectors

ev - The Event

Returns:

this

notify

<S extends Supplier<? extends Event<?>>> Observable notify(java.lang.Object key,
                                                           S supplier)

Notify this component that the given Supplier can provide an event that's ready to be processed.

Type Parameters:

S - The type of the Supplier

Parameters:

key - The key to be matched by Selectors

supplier - The Supplier that will provide the actual Event

Returns:

this

send

<E extends Event<?>> Observable send(java.lang.Object key,
                                     E ev)

Notify this component of the given Event and register an internal Consumer that will take the output of a previously-registered Function and respond using the key set on the Event's replyTo property.

Type Parameters:

E - The type of the Event

Parameters:

key - The key to be matched by Selectors

ev - The Event

Returns:

this

send

<S extends Supplier<? extends Event<?>>> Observable send(java.lang.Object key,
                                                         S supplier)

Notify this component that the given Supplier will provide an Event and register an internal Consumer that will take the output of a previously-registered Function and respond using the key set on the Event's replyTo property.

Parameters:

key - The key to be matched by Selectors

supplier - The Supplier that will provide the actual Event instance

Returns:

this

send

<E extends Event<?>> Observable send(java.lang.Object key,
                                     E ev,
                                     Observable replyTo)

Notify this component of the given Event and register an internal Consumer that will take the output of a previously-registered Function and respond to the key set on the Event's replyTo property and will call the notify method on the given Observable.

Type Parameters:

E - The type of the Event

Parameters:

key - The key to be matched by Selectors

ev - The Event

replyTo - The Observable on which to invoke the notify method

Returns:

this

send

<S extends Supplier<? extends Event<?>>> Observable send(java.lang.Object key,
                                                         S supplier,
                                                         Observable replyTo)

Notify this component that the given Supplier will provide an Event and register an internal Consumer that will take the output of a previously-registered Function and respond to the key set on the Event's replyTo property and will call the notify method on the given Observable.

Type Parameters:

S - The type of the Supplier

Parameters:

key - The key to be matched by Selectors

supplier - The Supplier that will provide the actual Event instance

replyTo - The Observable on which to invoke the notify method

Returns:

this

sendAndReceive

<REQ extends Event<?>,RESP extends Event<?>> Observable sendAndReceive(java.lang.Object key,
                                                                       REQ ev,
                                                                       Consumer<RESP> reply)

Register the given Consumer on an anonymous Selector and set the given event's replyTo property to the corresponding anonymous key, then register the consumer to receive replies from the Function assigned to handle the given key.

Type Parameters:

REQ - The type of the request event.

RESP - The type of the response event.

Parameters:

key - The key to be matched by Selectors

ev - The event to notify.

reply - The consumer to register as a reply handler.

Returns:

this

sendAndReceive

<REQ extends Event<?>,RESP extends Event<?>,S extends Supplier<REQ>> Observable sendAndReceive(java.lang.Object key,
                                                                                               S supplier,
                                                                                               Consumer<RESP> reply)

Register the given Consumer on an anonymous Selector and set the event's replyTo property to the corresponding anonymous key, then register the consumer to receive replies from the Function assigned to handle the given key.

Type Parameters:

REQ - The type of the request event.

RESP - The type of the response event.

S - The type of the supplier.

Parameters:

key - The key to be matched by Selectors

supplier - The supplier to supply the event.

reply - The consumer to register as a reply handler.

Returns:

this

notify

Observable notify(java.lang.Object key)

Notify this component that the consumers registered with a Selector that matches the key should be triggered with a null input argument.

Parameters:

key - The key to be matched by Selectors

Returns:

this

prepare

<T> Consumer<Event<T>> prepare(java.lang.Object key)

Create an optimized path for publishing notifications to the given key.

Parameters:

key - The key to be matched by Selectors

Returns:

a Consumer to invoke with the Events to publish

batchNotify

<T> Consumer<java.lang.Iterable<Event<T>>> batchNotify(java.lang.Object key)

Notify the key with all any accepted iterable group of events by the returned Consumer. The implementation will take care of reducing the consumer selection to one per batch. The candidate consumers are selected with the key , possibly on each batch to refresh the result list.

Parameters:

key - The key to be matched by Selectors

Returns:

a Consumer to invoke with the Events to publish

batchNotify

<T> Consumer<java.lang.Iterable<Event<T>>> batchNotify(java.lang.Object key,
                                                       Consumer<java.lang.Void> consumer)

Notify the key with all any accepted iterable group of events by the returned Consumer. The implementation will take care of reducing the consumer selection to one per batch. The candidate consumers are selected with the key , possibly on each batch to refresh the result list.

Parameters:

key - The key to be matched by Selectors

consumer - The consumer to trigger after batch completion

Returns:

a Consumer to invoke with the Events to publish