org.apache.twill.discovery

Interface ServiceDiscovered

All Superinterfaces:

Iterable<Discoverable>

public interface ServiceDiscovered
extends Iterable<Discoverable>

Represents the result of service discovery. It extends from Iterable that gives set of latest Discoverable every time when Iterable.iterator() is invoked.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ServiceDiscovered.ChangeListener Represents a callback for watching changes in the discovery list.

Method Summary

Modifier and Type	Method and Description
boolean	contains(Discoverable discoverable) Checks if the given discoverable contains in the current discovery list.
String	getName() Returns the name of the service being discovered.
Cancellable	watchChanges(ServiceDiscovered.ChangeListener listener, Executor executor) Registers a ServiceDiscovered.ChangeListener to watch for changes in the discovery list.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getName

String getName()

Returns the name of the service being discovered.

Returns:

Name of the service.

watchChanges

Cancellable watchChanges(ServiceDiscovered.ChangeListener listener,
                         Executor executor)

Registers a ServiceDiscovered.ChangeListener to watch for changes in the discovery list. The ServiceDiscovered.ChangeListener.onChange(ServiceDiscovered) method will be triggered when start watching, and on every subsequent changes in the discovery list.

Parameters:

listener - A ServiceDiscovered.ChangeListener to watch for changes.

executor - A Executor for issuing call to the given listener.

Returns:

A Cancellable to cancel the watch.

contains

boolean contains(Discoverable discoverable)

Checks if the given discoverable contains in the current discovery list.

Parameters:

discoverable - The Discoverable to check for.

Returns:

true if it exists, false otherwise.