net.kuujo.vertigo.io.port.impl

Class DefaultInputPort

java.lang.Object

net.kuujo.vertigo.io.port.impl.DefaultInputPort

All Implemented Interfaces:

Closeable<InputPort>, Input<InputPort>, Openable<InputPort>, InputPort, Port<InputPort>, Observer<InputPortContext>

public class DefaultInputPort
extends Object
implements InputPort, Observer<InputPortContext>

Default input port implementation.

Author:

Jordan Halterman

Constructor Summary

Constructors

Constructor and Description
DefaultInputPort(org.vertx.java.core.Vertx vertx, InputPortContext context)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the stream.
void	close(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Closes the stream.
InputPort	groupHandler(String group, org.vertx.java.core.Handler<InputGroup> handler) Registers a group handler on the input.
InputPort	messageHandler(org.vertx.java.core.Handler handler) Registers a message handler on the input.
String	name() Returns the port name.
InputPort	open() Opens the stream.
InputPort	open(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Opens the stream.
InputPort	pause() Pauses the input.
InputPort	resume() Resumes receiving data on the input.
void	update(InputPortContext update)
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

DefaultInputPort

public DefaultInputPort(org.vertx.java.core.Vertx vertx,
                InputPortContext context)

Method Detail

name

public String name()

Description copied from interface: Port

Returns the port name.

Specified by:

name in interface Port<InputPort>

Returns:

The port 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<InputPort>

Returns:

The inputs Vert.x instance.

update

public void update(InputPortContext update)

Specified by:

update in interface Observer<InputPortContext>

pause

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

Returns:

The input.

resume

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

Returns:

The input.

messageHandler

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

Parameters:

handler - A message handler.

Returns:

The input.

groupHandler

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

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.

open

public InputPort open()

Description copied from interface: Openable

Opens the stream.

Specified by:

open in interface Openable<InputPort>

Returns:

The stream.

open

public InputPort open(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler)

Description copied from interface: Openable

Opens the stream.

Specified by:

open in interface Openable<InputPort>

Parameters:

doneHandler - An asynchronous handler to be called once complete.

Returns:

The stream.

close

public void close()

Description copied from interface: Closeable

Closes the stream.

Specified by:

close in interface Closeable<InputPort>

close

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

Description copied from interface: Closeable

Closes the stream.

Specified by:

close in interface Closeable<InputPort>

Parameters:

doneHandler - An asynchronous handler to be called once complete.