net.kuujo.vertigo.io.connection.impl

Class ConnectionInputGroup

java.lang.Object

net.kuujo.vertigo.io.connection.impl.ConnectionInputGroup

All Implemented Interfaces:

Group<InputGroup>, InputGroup, Input<InputGroup>

public class ConnectionInputGroup
extends Object
implements InputGroup

Connection level input group.

This input group is created directly by a DefaultInputConnection when the connection receives a new group message.

Author:

Jordan Halterman

Constructor Summary

Constructors

Constructor and Description
ConnectionInputGroup(String id, String name, DefaultInputConnection connection)

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	groupHandler(String group, org.vertx.java.core.Handler<InputGroup> handler) Registers a group handler on the input.
String	id() Returns the unique group identifier.
InputGroup	messageHandler(org.vertx.java.core.Handler handler) Registers a message handler on the input.
String	name() Returns the group name.
InputGroup	pause() Pauses the input.
InputGroup	resume() Resumes receiving data on the input.
InputGroup	startHandler(org.vertx.java.core.Handler<Void> handler) Registers a start handler on the group.
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

ConnectionInputGroup

public ConnectionInputGroup(String id,
                    String name,
                    DefaultInputConnection connection)

Method Detail

id

public String id()

Description copied from interface: Group

Returns the unique group identifier.

Specified by:

id in interface Group<InputGroup>

Returns:

The unique group identifier.

name

public String name()

Description copied from interface: Group

Returns the group name.

Specified by:

name in interface Group<InputGroup>

Returns:

The group name.

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<InputGroup>

Returns:

The inputs Vert.x instance.

pause

public InputGroup 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<InputGroup>

Returns:

The input.

resume

public InputGroup 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<InputGroup>

Returns:

The input.

messageHandler

public InputGroup 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<InputGroup>

Parameters:

handler - A message handler.

Returns:

The input.

groupHandler

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

Description copied from interface: Input

Registers a group handler on the input.

The group handler will be called any time a group with the given name is received on the input on which the handler was registered. That means if the handler was registered on a port, the handler will only be called for a group that is received by the port. Alternatively, if the handler was registered on a group then the handler will only be called for a group that was received by the group on which the handler was registered. This means that group handlers are inherently hierarchical, and its important that users take care in how handlers are registered.

Specified by:

groupHandler in interface Input<InputGroup>

Parameters:

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

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

Returns:

The input instance.

startHandler

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

Description copied from interface: InputGroup

Registers a start handler on the group.

Specified by:

startHandler in interface InputGroup

Parameters:

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

Returns:

The input group.

endHandler

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

Description copied from interface: InputGroup

Registers an end handler on the group.

Specified by:

endHandler in interface InputGroup

Parameters:

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

Returns:

The input group.