net.kuujo.vertigo.io.connection.impl

Class DefaultConnectionOutputBatch

java.lang.Object

net.kuujo.vertigo.io.connection.impl.DefaultConnectionOutputBatch

All Implemented Interfaces:

AutoCloseable, Closeable<OutputConnection>, Connection<OutputConnection>, ConnectionOutputBatch, OutputConnection, OutputGroupSupport<OutputConnection>, Openable<OutputConnection>, Output<OutputConnection>

public class DefaultConnectionOutputBatch
extends Object
implements ConnectionOutputBatch

Default connection output batch implementation.

Author:

Jordan Halterman

Constructor Summary

Constructors

Constructor and Description
DefaultConnectionOutputBatch(String id, Object args, DefaultOutputConnection connection)

Method Summary

Methods

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

DefaultConnectionOutputBatch

public DefaultConnectionOutputBatch(String id,
                            Object args,
                            DefaultOutputConnection connection)

Method Detail

id

public String id()

Description copied from interface: ConnectionOutputBatch

Returns the batch ID.

Specified by:

id in interface ConnectionOutputBatch

Returns:

The unique batch ID.

address

public String address()

Description copied from interface: Connection

Returns the connection address.

Specified by:

address in interface Connection<OutputConnection>

Returns:

The connection address.

size

public int size()

Description copied from interface: Connection

Returns the current connection size.

Specified by:

size in interface Connection<OutputConnection>

Specified by:

size in interface Output<OutputConnection>

Returns:

The current connection size.

open

public OutputConnection open()

Description copied from interface: Openable

Opens the stream.

Specified by:

open in interface Openable<OutputConnection>

Returns:

The stream.

open

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

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

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

Parameters:

doneHandler - An asynchronous handler to be called once complete.

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

Returns:

A vertx instance.

setSendQueueMaxSize

public OutputConnection setSendQueueMaxSize(int maxSize)

Description copied from interface: Output

Sets the send queue max size.

Specified by:

setSendQueueMaxSize in interface Output<OutputConnection>

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

Returns:

The send queue max 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<OutputConnection>

Returns:

Indicates whether the send queue is full.

drainHandler

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

Parameters:

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

Returns:

The send stream.

send

public OutputConnection send(Object message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputConnection>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputConnection send(String message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputConnection>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputConnection send(Short message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputConnection>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputConnection send(Integer message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputConnection>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputConnection send(Long message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputConnection>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputConnection send(Float message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputConnection>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputConnection send(Double message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputConnection>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputConnection send(Boolean message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputConnection>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputConnection send(Byte message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputConnection>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputConnection send(byte[] message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputConnection>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputConnection send(Character message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputConnection>

Parameters:

message - The message to send.

Returns:

The output.

send

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

Parameters:

message - The message to send.

Returns:

The output.

send

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

Parameters:

message - The message to send.

Returns:

The output.

send

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

Parameters:

message - The message to send.

Returns:

The output.

batch

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

Description copied from interface: OutputConnection

Creates an output batch on the connection.

Specified by:

batch in interface OutputConnection

Parameters:

id - The unique batch ID.

args - Arguments to the batch's start handler.

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

Returns:

The output connection.

group

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

Parameters:

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

Returns:

The called object.

group

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

Parameters:

name - The output group name.

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

Returns:

The called object.

group

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

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.

end

public void end()

Description copied from interface: ConnectionOutputBatch

Ends the batch.

Specified by:

end in interface ConnectionOutputBatch

end

public <T> void end(T args)

Description copied from interface: ConnectionOutputBatch

Ends the batch.

Specified by:

end in interface ConnectionOutputBatch

Parameters:

args - Arguments to the batch's end handler.