DefaultOutputConnection (Vertigo Core 0.7.0-beta1 API)

java.lang.Object
- net.kuujo.vertigo.io.connection.impl.DefaultOutputConnection

All Implemented Interfaces:

Closeable<OutputConnection>, Connection<OutputConnection>, OutputConnection, Openable<OutputConnection>, Output<OutputConnection>
```
public class DefaultOutputConnection
extends Object
implements OutputConnection
```
Default output connection implementation.

Author:

Jordan Halterman

Constructor Summary

Constructors
Constructor and Description
`DefaultOutputConnection(org.vertx.java.core.Vertx vertx, OutputConnectionContext context)`
`DefaultOutputConnection(org.vertx.java.core.Vertx vertx, String address)`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`address()` Returns the connection address.
`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.
`int`	`getSendQueueMaxSize()` Returns the send queue max size.
`OutputConnection`	`group(String name, org.vertx.java.core.Handler<OutputGroup> handler)` Creates a named output group.
`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
  - DefaultOutputConnection
```
public DefaultOutputConnection(org.vertx.java.core.Vertx vertx,
                       String address)
```
  - DefaultOutputConnection
```
public DefaultOutputConnection(org.vertx.java.core.Vertx vertx,
                       OutputConnectionContext context)
```
- Method Detail
  - address
```
public String address()
```
    Description copied from interface: Connection
    
    Returns the connection address.
    
    Specified by:
    
    address in interface Connection<OutputConnection>
    
    Returns:
    The connection address.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - group
```
public OutputConnection group(String name,
                     org.vertx.java.core.Handler<OutputGroup> handler)
```
    Description copied from interface: Output
    
    Creates a named output group.
    When creating an output group, the output will synchronize with any inputs to which it is connected prior to calling the group handler. This means that once the group handler has been called, messages sent to the group will be immediately sent to any output connections rather than queueing messages.
    
    Specified by:
    
    group in interface Output<OutputConnection>
    
    Parameters:
    name - The output group name.
    handler - A handler to be called once the output group is created.
    
    Returns:
    The output buffer.
  - close
```
public void close()
```
    Description copied from interface: Closeable
    
    Closes the stream.
    
    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.
  - 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(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(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(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(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(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(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.
  - 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.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(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.

Class DefaultOutputConnection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultOutputConnection

DefaultOutputConnection

Method Detail

address

vertx

open

open

setSendQueueMaxSize

getSendQueueMaxSize

size

sendQueueFull

drainHandler

group

close

close

send

send

send

send

send

send

send

send

send

send

send

send

send

send