net.kuujo.vertigo.io.group

Interface InputGroup

All Superinterfaces:

Group<InputGroup>, Input<InputGroup>, InputGroupSupport<InputGroup>

All Known Subinterfaces:

ConnectionInputGroup

All Known Implementing Classes:

DefaultConnectionInputGroup

public interface InputGroup
extends Group<InputGroup>, Input<InputGroup>, InputGroupSupport<InputGroup>

Input groups represent collections of input messages.

In order for an input group to receive messages, an output group of the same name must have sent messages from the other side of the connection. Each time an output group is created a corresponding input group will be created on the other side of the connection.

Input groups use a very particular order of operations. When a new group message is received on an input connection, the connection will create a corresponding input group. The group will not receive any messages until it has registered a message handler. Once a message handler has been registered, the input group will notify the corresponding output group that it's prepared to accept messages. This allows time for input groups to call asynchronous APIs during setup.

Input group messages will be received in strong order just as all other Vertigo messages. The input group uses the underlying connection to validate message ordering. This ordering helps guarantee that all child groups will be ended before the parent is ended. This allows inputs to reliably create and destroy state using start and end handlers.

Author:

Jordan Halterman

Method Summary

Methods

Modifier and Type	Method and Description
InputGroup	endHandler(org.vertx.java.core.Handler<Void> handler) Registers an end handler on the group.
InputGroup	startHandler(org.vertx.java.core.Handler<Void> handler) Registers a start handler on the group.

Methods inherited from interface net.kuujo.vertigo.io.group.Group

id, name

Methods inherited from interface net.kuujo.vertigo.io.Input

messageHandler, pause, resume, vertx

Methods inherited from interface net.kuujo.vertigo.io.InputGroupSupport

groupHandler

Method Detail

startHandler

InputGroup startHandler(org.vertx.java.core.Handler<Void> handler)

Registers a start handler on the group.

Parameters:

handler - A handler to be called when the group is started.

Returns:

The input group.

endHandler

InputGroup endHandler(org.vertx.java.core.Handler<Void> handler)

Registers an end handler on the group.

Parameters:

handler - A handler to be called when the group is ended.

Returns:

The input group.