net.kuujo.vertigo.io.port.impl

Class DefaultOutputPort

java.lang.Object

net.kuujo.vertigo.io.port.impl.DefaultOutputPort

All Implemented Interfaces:

AutoCloseable, OutputBatchSupport<OutputPort>, Closeable<OutputPort>, OutputGroupSupport<OutputPort>, Openable<OutputPort>, Output<OutputPort>, OutputPort, Port<OutputPort>, Observer<OutputPortContext>

public class DefaultOutputPort
extends Object
implements OutputPort, Observer<OutputPortContext>

Default output port implementation.

Author:

Jordan Halterman

Constructor Summary

Constructors

Constructor and Description
DefaultOutputPort(org.vertx.java.core.Vertx vertx, OutputPortContext context)

Method Summary

Methods

Modifier and Type	Method and Description
OutputPort	batch(org.vertx.java.core.Handler<OutputBatch> handler) Creates a new batch.
OutputPort	batch(Object args, org.vertx.java.core.Handler<OutputBatch> handler) Creates a new output batch.
OutputPort	batch(String id, Object args, org.vertx.java.core.Handler<OutputBatch> handler) Creates a new output batch.
void	close() Closes the stream.
void	close(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Closes the stream.
OutputPort	drainHandler(org.vertx.java.core.Handler<Void> handler) Sets a drain handler on the output.
int	getSendQueueMaxSize() Returns the send queue max size.
OutputPort	group(org.vertx.java.core.Handler<OutputGroup> handler) Creates a uniquely named output group.
OutputPort	group(String name, org.vertx.java.core.Handler<OutputGroup> handler) Creates a named output group.
OutputPort	group(String name, Object args, org.vertx.java.core.Handler<OutputGroup> handler) Creates a named output group.
String	name() Returns the port name.
OutputPort	open() Opens the stream.
OutputPort	open(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler) Opens the stream.
OutputPort	send(Boolean message) Sends a message on the output.
OutputPort	send(org.vertx.java.core.buffer.Buffer message) Sends a message on the output.
OutputPort	send(Byte message) Sends a message on the output.
OutputPort	send(byte[] message) Sends a message on the output.
OutputPort	send(Character message) Sends a message on the output.
OutputPort	send(Double message) Sends a message on the output.
OutputPort	send(Float message) Sends a message on the output.
OutputPort	send(Integer message) Sends a message on the output.
OutputPort	send(org.vertx.java.core.json.JsonArray message) Sends a message on the output.
OutputPort	send(org.vertx.java.core.json.JsonObject message) Sends a message on the output.
OutputPort	send(Long message) Sends a message on the output.
OutputPort	send(Object message) Sends a message on the output.
OutputPort	send(Short message) Sends a message on the output.
OutputPort	send(String message) Sends a message on the output.
boolean	sendQueueFull() Returns a boolean indicating whether the send queue is full.
OutputPort	setSendQueueMaxSize(int maxSize) Sets the send queue max size.
int	size() Returns the current connection send queue size.
void	update(OutputPortContext update) Notifies the observer of an update.
org.vertx.java.core.Vertx	vertx() Returns the output's Vertx instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultOutputPort

public DefaultOutputPort(org.vertx.java.core.Vertx vertx,
                 OutputPortContext context)

Method Detail

name

public String name()

Description copied from interface: Port

Returns the port name.

Specified by:

name in interface Port<OutputPort>

Returns:

The port name.

vertx

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

Description copied from interface: Output

Returns the output's Vertx instance.

Specified by:

vertx in interface Output<OutputPort>

Returns:

A vertx instance.

update

public void update(OutputPortContext update)

Description copied from interface: Observer

Notifies the observer of an update.

Specified by:

update in interface Observer<OutputPortContext>

Parameters:

update - The updated object.

setSendQueueMaxSize

public OutputPort setSendQueueMaxSize(int maxSize)

Description copied from interface: Output

Sets the send queue max size.

Specified by:

setSendQueueMaxSize in interface Output<OutputPort>

Parameters:

maxSize - The send queue max size.

Returns:

The send stream.

getSendQueueMaxSize

public int getSendQueueMaxSize()

Description copied from interface: Output

Returns the send queue max size.

Specified by:

getSendQueueMaxSize in interface Output<OutputPort>

Returns:

The send queue max size.

size

public int size()

Description copied from interface: Output

Returns the current connection send queue size.

Specified by:

size in interface Output<OutputPort>

Returns:

The current connection send queue size.

sendQueueFull

public boolean sendQueueFull()

Description copied from interface: Output

Returns a boolean indicating whether the send queue is full.

Specified by:

sendQueueFull in interface Output<OutputPort>

Returns:

Indicates whether the send queue is full.

drainHandler

public OutputPort drainHandler(org.vertx.java.core.Handler<Void> handler)

Description copied from interface: Output

Sets a drain handler on the output.

When the output's send queue becomes full, the output will be temporarily paused while its output queue is empty. Once the queue size decreases back to 50% of the maximum queue size the drain handler will be called so that normal operation can resume.

Specified by:

drainHandler in interface Output<OutputPort>

Parameters:

handler - A handler to be called when the stream is prepared to accept new messages.

Returns:

The send stream.

open

public OutputPort open()

Description copied from interface: Openable

Opens the stream.

Specified by:

open in interface Openable<OutputPort>

Returns:

The stream.

open

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

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 AutoCloseable

Specified by:

close in interface Closeable<OutputPort>

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

Parameters:

doneHandler - An asynchronous handler to be called once complete.

batch

public OutputPort batch(org.vertx.java.core.Handler<OutputBatch> handler)

Description copied from interface: OutputPort

Creates a new batch.

Specified by:

batch in interface OutputBatchSupport<OutputPort>

Specified by:

batch in interface OutputPort

Parameters:

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

Returns:

The output batch.

batch

public OutputPort batch(Object args,
               org.vertx.java.core.Handler<OutputBatch> handler)

Description copied from interface: OutputBatchSupport

Creates a new output batch.

Specified by:

batch in interface OutputBatchSupport<OutputPort>

Parameters:

args - Arguments to the batch's start handler.

handler - A handler to be called once the batch has been created.

Returns:

The called object.

batch

public OutputPort batch(String id,
               Object args,
               org.vertx.java.core.Handler<OutputBatch> handler)

Description copied from interface: OutputBatchSupport

Creates a new output batch.

Specified by:

batch in interface OutputBatchSupport<OutputPort>

Parameters:

id - The unique batch identifier.

args - Arguments to the batch's start handler.

handler - A handler to be called once the batch has been created.

Returns:

The called object.

group

public OutputPort group(org.vertx.java.core.Handler<OutputGroup> handler)

Description copied from interface: OutputGroupSupport

Creates a uniquely named output group.

Messages sent through groups will always be sent to the same connection(s). Groups can also be nested.

Specified by:

group in interface OutputGroupSupport<OutputPort>

Parameters:

handler - A handler to be called once the group has been setup.

Returns:

The called object.

group

public OutputPort group(String name,
               org.vertx.java.core.Handler<OutputGroup> handler)

Description copied from interface: OutputGroupSupport

Creates a named output group.

Messages sent through groups will always be sent to the same connection(s). Groups can also be nested.

Specified by:

group in interface OutputGroupSupport<OutputPort>

Parameters:

name - The output group name.

handler - A handler to be called once the group has been setup.

Returns:

The called object.

group

public OutputPort group(String name,
               Object args,
               org.vertx.java.core.Handler<OutputGroup> handler)

Description copied from interface: OutputGroupSupport

Creates a named output group.

Messages sent through groups will always be sent to the same connection(s). Groups can also be nested.

Specified by:

group in interface OutputGroupSupport<OutputPort>

Parameters:

name - The output group name.

args - Arguments to the group's start handler.

handler - A handler to be called once the group has been setup.

Returns:

The called object.

send

public OutputPort send(Object message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputPort>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputPort send(String message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputPort>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputPort send(Boolean message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputPort>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputPort send(Character message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputPort>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputPort send(Short message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputPort>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputPort send(Integer message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputPort>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputPort send(Long message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputPort>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputPort send(Double message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputPort>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputPort send(Float message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputPort>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputPort send(org.vertx.java.core.json.JsonObject message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputPort>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputPort send(org.vertx.java.core.json.JsonArray message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputPort>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputPort send(Byte message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputPort>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputPort send(byte[] message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputPort>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputPort send(org.vertx.java.core.buffer.Buffer message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputPort>

Parameters:

message - The message to send.

Returns:

The output.