net.kuujo.vertigo.io.batch.impl

Class BaseOutputBatch

java.lang.Object

net.kuujo.vertigo.io.batch.impl.BaseOutputBatch

All Implemented Interfaces:

Batch<OutputBatch>, OutputBatch, Output<OutputBatch>, OutputGroupSupport<OutputBatch>

public class BaseOutputBatch
extends Object
implements OutputBatch

Top-level output batch.

This output batch implementation is the API that is exposed to users. However, internally it wraps other OutputBatch instances which handle grouping logic for individual output connections.

Author:

Jordan Halterman

Constructor Summary

Constructors

Constructor and Description
BaseOutputBatch(String id, org.vertx.java.core.Vertx vertx, Collection<OutputBatch> connections)

Method Summary

Methods

Modifier and Type	Method and Description
OutputBatch	drainHandler(org.vertx.java.core.Handler<Void> handler) Sets a drain handler on the output.
void	end() Ends the batch.
int	getSendQueueMaxSize() Returns the send queue max size.
OutputBatch	group(String name, org.vertx.java.core.Handler<OutputGroup> handler) Creates a named output group.
String	id() Returns the unique batch ID.
OutputBatch	send(Boolean message) Sends a message on the output.
OutputBatch	send(org.vertx.java.core.buffer.Buffer message) Sends a message on the output.
OutputBatch	send(Byte message) Sends a message on the output.
OutputBatch	send(byte[] message) Sends a message on the output.
OutputBatch	send(Character message) Sends a message on the output.
OutputBatch	send(Double message) Sends a message on the output.
OutputBatch	send(Float message) Sends a message on the output.
OutputBatch	send(Integer message) Sends a message on the output.
OutputBatch	send(org.vertx.java.core.json.JsonArray message) Sends a message on the output.
OutputBatch	send(org.vertx.java.core.json.JsonObject message) Sends a message on the output.
OutputBatch	send(Long message) Sends a message on the output.
OutputBatch	send(Object message) Sends a message on the output.
OutputBatch	send(Short message) Sends a message on the output.
OutputBatch	send(String message) Sends a message on the output.
boolean	sendQueueFull() Returns a boolean indicating whether the send queue is full.
OutputBatch	setSendQueueMaxSize(int maxSize) Sets the send queue max size.
int	size() Returns the current connection send queue size.
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

BaseOutputBatch

public BaseOutputBatch(String id,
               org.vertx.java.core.Vertx vertx,
               Collection<OutputBatch> connections)

Method Detail

id

public String id()

Description copied from interface: Batch

Returns the unique batch ID.

Specified by:

id in interface Batch<OutputBatch>

Returns:

The unique batch ID.

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

Returns:

A vertx instance.

setSendQueueMaxSize

public OutputBatch setSendQueueMaxSize(int maxSize)

Description copied from interface: Output

Sets the send queue max size.

Specified by:

setSendQueueMaxSize in interface Output<OutputBatch>

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

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

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

Returns:

Indicates whether the send queue is full.

drainHandler

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

Parameters:

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

Returns:

The send stream.

group

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

Parameters:

name - The output group name.

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

Returns:

The called object.

send

public OutputBatch send(Object message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputBatch>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputBatch send(String message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputBatch>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputBatch send(Boolean message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputBatch>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputBatch send(Character message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputBatch>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputBatch send(Short message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputBatch>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputBatch send(Integer message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputBatch>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputBatch send(Long message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputBatch>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputBatch send(Double message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputBatch>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputBatch send(Float message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputBatch>

Parameters:

message - The message to send.

Returns:

The output.

send

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

Parameters:

message - The message to send.

Returns:

The output.

send

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

Parameters:

message - The message to send.

Returns:

The output.

send

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

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputBatch send(Byte message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputBatch>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputBatch send(byte[] message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputBatch>

Parameters:

message - The message to send.

Returns:

The output.

end

public void end()

Description copied from interface: OutputBatch

Ends the batch.

Specified by:

end in interface OutputBatch