net.kuujo.vertigo.component

Interface ComponentCoordinator

All Known Implementing Classes:

DefaultComponentCoordinator

public interface ComponentCoordinator

The component coordinator handles coordination of component startup and shutdown between multiple components within a network. This is necessary to ensure that messages are not lost by components sending or receiving messages prior to completion of startup.

Author:

Jordan Halterman

Method Summary

Methods

Modifier and Type	Method and Description
String	address() Returns the instance address.
ComponentCoordinator	pause() Notifies the network that the component is not ready for operation.
ComponentCoordinator	pause(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Notifies the network that the component is not ready for operation.
ComponentCoordinator	pauseHandler(org.vertx.java.core.Handler<Void> handler) Sets a pause handler on the coordinator.
ComponentCoordinator	resume() Notifies the network that the component is ready to resume.
ComponentCoordinator	resume(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Notifies the network that the component is ready to resume.
ComponentCoordinator	resumeHandler(org.vertx.java.core.Handler<Void> handler) Sets a resume handler on the coordinator.
ComponentCoordinator	start(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<InstanceContext>> doneHandler) Starts the coordinator.
void	stop(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Stops the coordinator.

Method Detail

address

String address()

Returns the instance address.

Returns:

The component instance address.

start

ComponentCoordinator start(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<InstanceContext>> doneHandler)

Starts the coordinator.

When the coordinator is started the instance context is retrieved from the fault-tolerant cluster. Prior to setup, the component only knows its own address, thus starting the coordinator is essential to component setup.

Parameters:

doneHandler - An asynchronous handler to be called once complete. The handler will be called with the current instance context.

Returns:

The coordinator.

resume

ComponentCoordinator resume()

Notifies the network that the component is ready to resume.

Returns:

The component coordinator.

resume

ComponentCoordinator resume(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler)

Notifies the network that the component is ready to resume.

Parameters:

doneHandler - An asynchronous handler to be called once the network has been notified.

Returns:

The component coordinator.

pause

ComponentCoordinator pause()

Notifies the network that the component is not ready for operation.

Returns:

The component coordinator.

pause

ComponentCoordinator pause(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler)

Notifies the network that the component is not ready for operation.

Parameters:

doneHandler - An asynchronous handler to be called once the network has been notified.

Returns:

The component coordinator.

resumeHandler

ComponentCoordinator resumeHandler(org.vertx.java.core.Handler<Void> handler)

Sets a resume handler on the coordinator.

This handler will be called when all components in the network are setup and ready to begin processing messages. The network coordinator will make this determination by evaluating component status keys in the cluster.

Parameters:

handler - A handler to be called when the component should resume operation.

Returns:

The component coordinator.

pauseHandler

ComponentCoordinator pauseHandler(org.vertx.java.core.Handler<Void> handler)

Sets a pause handler on the coordinator.

This handler will be called when some component somewhere in the network has been paused. When a component is paused, the network manager will notify all component instances that the network is paused until resume.

Parameters:

handler - A handler to be called when the component should pause operation.

Returns:

The component coordinator.

stop

void stop(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler)

Stops the coordinator.

Parameters:

doneHandler - An asynchronous handler to be called once complete.