net.kuujo.vertigo.io

Interface Input<T extends Input<T>>

Type Parameters:

T - The input type.

All Known Subinterfaces:

ConnectionInputBatch, ConnectionInputGroup, InputBatch, InputConnection, InputGroup, InputPort

All Known Implementing Classes:

DefaultConnectionInputBatch, DefaultConnectionInputGroup, DefaultInputConnection, DefaultInputPort

public interface Input<T extends Input<T>>

Basic input interface.

Author:

Jordan Halterman

Method Summary

Methods

Modifier and Type	Method and Description
T	messageHandler(org.vertx.java.core.Handler handler) Registers a message handler on the input.
T	pause() Pauses the input.
T	resume() Resumes receiving data on the input.
org.vertx.java.core.Vertx	vertx() Returns the input's vertx instance.

Method Detail

vertx

org.vertx.java.core.Vertx vertx()

Returns the input's vertx instance.

Returns:

The inputs Vert.x instance.

pause

T pause()

Pauses the input.

When the input is paused, messages received by the input will be buffered, so it is important that inputs not be paused for too long if messages continue to flow.

Returns:

The input.

resume

T resume()

Resumes receiving data on the input.

When the input is resumed, any messages that were buffered during the pause will be processed first. Once the input's buffer is empty it will resume normal operation.

Returns:

The input.

messageHandler

T messageHandler(org.vertx.java.core.Handler handler)

Registers a message handler on the input.

The message handler can accept any message type that is supported by the Vert.x event bus. Vertigo messages cannot be replied to and do not need to be acked. The input handles communicating and coordinating with outputs internally.

Parameters:

handler - A message handler.

Returns:

The input.