net.kuujo.vertigo.io.group.impl

Class BaseOutputGroup

java.lang.Object

net.kuujo.vertigo.io.group.impl.BaseOutputGroup

All Implemented Interfaces:

Group<OutputGroup>, OutputGroup, Output<OutputGroup>, OutputGroupSupport<OutputGroup>

public class BaseOutputGroup
extends Object
implements OutputGroup

Top-level output group.

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

Author:

Jordan Halterman

Constructor Summary

Constructors

Constructor and Description
BaseOutputGroup(String name, org.vertx.java.core.Vertx vertx, Collection<OutputGroup> connections)

Method Summary

Methods

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

BaseOutputGroup

public BaseOutputGroup(String name,
               org.vertx.java.core.Vertx vertx,
               Collection<OutputGroup> connections)

Method Detail

id

public String id()

Description copied from interface: Group

Returns the unique group identifier.

Specified by:

id in interface Group<OutputGroup>

Returns:

The unique group identifier.

name

public String name()

Description copied from interface: Group

Returns the group name.

Specified by:

name in interface Group<OutputGroup>

Returns:

The group 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<OutputGroup>

Returns:

A vertx instance.

setSendQueueMaxSize

public OutputGroup setSendQueueMaxSize(int maxSize)

Description copied from interface: Output

Sets the send queue max size.

Specified by:

setSendQueueMaxSize in interface Output<OutputGroup>

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

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

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

Returns:

Indicates whether the send queue is full.

drainHandler

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

Parameters:

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

Returns:

The send stream.

group

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

Parameters:

name - The output group name.

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

Returns:

The called object.

send

public OutputGroup send(Object message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputGroup>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputGroup send(String message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputGroup>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputGroup send(Boolean message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputGroup>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputGroup send(Character message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputGroup>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputGroup send(Short message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputGroup>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputGroup send(Integer message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputGroup>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputGroup send(Long message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputGroup>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputGroup send(Double message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputGroup>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputGroup send(Float message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputGroup>

Parameters:

message - The message to send.

Returns:

The output.

send

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

Parameters:

message - The message to send.

Returns:

The output.

send

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

Parameters:

message - The message to send.

Returns:

The output.

send

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

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputGroup send(Byte message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputGroup>

Parameters:

message - The message to send.

Returns:

The output.

send

public OutputGroup send(byte[] message)

Description copied from interface: Output

Sends a message on the output.

Specified by:

send in interface Output<OutputGroup>

Parameters:

message - The message to send.

Returns:

The output.

end

public OutputGroup end()

Description copied from interface: OutputGroup

Ends the output group.

Specified by:

end in interface OutputGroup

Returns:

The output group.