net.kuujo.vertigo.io.connection.impl

Class DefaultConnectionInputBatch

java.lang.Object

net.kuujo.vertigo.io.connection.impl.DefaultConnectionInputBatch

All Implemented Interfaces:

Batch<InputBatch>, InputBatch, ConnectionInputBatch, Input<InputBatch>, InputGroupSupport<InputBatch>

public class DefaultConnectionInputBatch
extends Object
implements ConnectionInputBatch

Connection input batch.

Author:

Jordan Halterman

Constructor Summary

Constructors

Constructor and Description
DefaultConnectionInputBatch(String id, DefaultInputConnection connection)

Method Summary

Methods

Modifier and Type	Method and Description
InputBatch	endHandler(org.vertx.java.core.Handler<Void> handler) Registers an end handler on the batch.
InputBatch	groupHandler(String group, org.vertx.java.core.Handler<InputGroup> handler) Registers a group handler.
String	id() Returns the unique batch ID.
InputBatch	messageHandler(org.vertx.java.core.Handler handler) Registers a message handler on the input.
InputBatch	pause() Pauses the input.
InputBatch	resume() Resumes receiving data on the input.
InputBatch	startHandler(org.vertx.java.core.Handler<Void> handler) Registers a start handler on the batch.
org.vertx.java.core.Vertx	vertx() Returns the input's vertx instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultConnectionInputBatch

public DefaultConnectionInputBatch(String id,
                           DefaultInputConnection connection)

Method Detail

id

public String id()

Description copied from interface: Batch

Returns the unique batch ID.

Specified by:

id in interface Batch<InputBatch>

Returns:

The unique batch ID.

vertx

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

Description copied from interface: Input

Returns the input's vertx instance.

Specified by:

vertx in interface Input<InputBatch>

Returns:

The inputs Vert.x instance.

pause

public InputBatch pause()

Description copied from interface: Input

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.

Specified by:

pause in interface Input<InputBatch>

Returns:

The input.

resume

public InputBatch resume()

Description copied from interface: Input

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.

Specified by:

resume in interface Input<InputBatch>

Returns:

The input.

startHandler

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

Description copied from interface: InputBatch

Registers a start handler on the batch.

Specified by:

startHandler in interface InputBatch

Parameters:

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

Returns:

The input batch.

messageHandler

public InputBatch messageHandler(org.vertx.java.core.Handler handler)

Description copied from interface: Input

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.

Specified by:

messageHandler in interface Input<InputBatch>

Parameters:

handler - A message handler.

Returns:

The input.

groupHandler

public InputBatch groupHandler(String group,
                      org.vertx.java.core.Handler<InputGroup> handler)

Description copied from interface: InputGroupSupport

Registers a group handler.

Specified by:

groupHandler in interface InputGroupSupport<InputBatch>

Parameters:

group - The name of the group for which to register the handler.

handler - The handler to register. This handler will be called whenever a group of the given name is started.

Returns:

The called object.

endHandler

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

Description copied from interface: InputBatch

Registers an end handler on the batch.

Specified by:

endHandler in interface InputBatch

Parameters:

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

Returns:

The input batch.