DefaultOutputStream (Vertigo Core 0.7.0-beta2 API)

java.lang.Object
- net.kuujo.vertigo.io.stream.impl.DefaultOutputStream

All Implemented Interfaces:

Closeable<OutputStream>, Openable<OutputStream>, Output<OutputStream>, OutputBatchSupport<OutputStream>, OutputGroupSupport<OutputStream>, OutputStream
```
public class DefaultOutputStream
extends Object
implements OutputStream
```
Default output stream implementation.

Author:

Jordan Halterman

Constructor Summary

Constructors
Constructor and Description

DefaultOutputStream(org.vertx.java.core.Vertx vertx, OutputStreamContext context)

Constructors
Constructor and Description
`DefaultOutputStream(org.vertx.java.core.Vertx vertx, OutputStreamContext context)`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`address()` Returns the output stream address.
`OutputStream`	`batch(org.vertx.java.core.Handler<OutputBatch> handler)` Creates a new output batch with a random identifier.
`OutputStream`	`batch(String id, 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.
`OutputStream`	`drainHandler(org.vertx.java.core.Handler<Void> handler)` Sets a drain handler on the output.
`int`	`getSendQueueMaxSize()` Returns the send queue max size.
`OutputStream`	`group(String name, org.vertx.java.core.Handler<OutputGroup> handler)` Creates a named output group.
`OutputStream`	`open()` Opens the stream.
`OutputStream`	`open(org.vertx.java.core.Handler<org.vertx.java.core.AsyncResult<Void>> doneHandler)` Opens the stream.
`OutputStream`	`send(Boolean message)` Sends a message on the output.
`OutputStream`	`send(org.vertx.java.core.buffer.Buffer message)` Sends a message on the output.
`OutputStream`	`send(Byte message)` Sends a message on the output.
`OutputStream`	`send(byte[] message)` Sends a message on the output.
`OutputStream`	`send(Character message)` Sends a message on the output.
`OutputStream`	`send(Double message)` Sends a message on the output.
`OutputStream`	`send(Float message)` Sends a message on the output.
`OutputStream`	`send(Integer message)` Sends a message on the output.
`OutputStream`	`send(org.vertx.java.core.json.JsonArray message)` Sends a message on the output.
`OutputStream`	`send(org.vertx.java.core.json.JsonObject message)` Sends a message on the output.
`OutputStream`	`send(Long message)` Sends a message on the output.
`OutputStream`	`send(Object message)` Sends a message on the output.
`OutputStream`	`send(Short message)` Sends a message on the output.
`OutputStream`	`send(String message)` Sends a message on the output.
`boolean`	`sendQueueFull()` Returns a boolean indicating whether the send queue is full.
`OutputStream`	`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
  - DefaultOutputStream
```
public DefaultOutputStream(org.vertx.java.core.Vertx vertx,
                   OutputStreamContext context)
```
- Method Detail
  - 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<OutputStream>
    
    Returns:
    A vertx instance.
  - address
```
public String address()
```
    Description copied from interface: OutputStream
    
    Returns the output stream address.
    
    Specified by:
    
    address in interface OutputStream
    
    Returns:
    The output stream address.
  - open
```
public OutputStream open()
```
    Description copied from interface: Openable
    
    Opens the stream.
    
    Specified by:
    
    open in interface Openable<OutputStream>
    
    Returns:
    The stream.
  - open
```
public OutputStream 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<OutputStream>
    
    Parameters:
    doneHandler - An asynchronous handler to be called once complete.
    
    Returns:
    The stream.
  - setSendQueueMaxSize
```
public OutputStream setSendQueueMaxSize(int maxSize)
```
    Description copied from interface: Output
    
    Sets the send queue max size.
    
    Specified by:
    
    setSendQueueMaxSize in interface Output<OutputStream>
    
    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<OutputStream>
    
    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<OutputStream>
    
    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<OutputStream>
    
    Returns:
    Indicates whether the send queue is full.
  - drainHandler
```
public OutputStream 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<OutputStream>
    
    Parameters:
    handler - A handler to be called when the stream is prepared to accept new messages.
    
    Returns:
    The send stream.
  - batch
```
public OutputStream batch(org.vertx.java.core.Handler<OutputBatch> handler)
```
    Description copied from interface: OutputBatchSupport
    
    Creates a new output batch with a random identifier.
    
    Specified by:
    
    batch in interface OutputBatchSupport<OutputStream>
    
    Parameters:
    handler - A handler to be called once the batch has been created.
    
    Returns:
    The called object.
  - batch
```
public OutputStream batch(String id,
                 org.vertx.java.core.Handler<OutputBatch> handler)
```
    Description copied from interface: OutputBatchSupport
    
    Creates a new output batch.
    
    Specified by:
    
    batch in interface OutputBatchSupport<OutputStream>
    
    Parameters:
    id - The unique output batch identifier.
    handler - A handler to be called once the batch has been created.
    
    Returns:
    The called object.
  - group
```
public OutputStream 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<OutputStream>
    
    Parameters:
    name - The output group name.
    handler - A handler to be called once the group has been setup.
    
    Returns:
    The called object.
  - send
```
public OutputStream send(Object message)
```
    Description copied from interface: Output
    
    Sends a message on the output.
    
    Specified by:
    
    send in interface Output<OutputStream>
    
    Parameters:
    message - The message to send.
    
    Returns:
    The output.
  - send
```
public OutputStream send(String message)
```
    Description copied from interface: Output
    
    Sends a message on the output.
    
    Specified by:
    
    send in interface Output<OutputStream>
    
    Parameters:
    message - The message to send.
    
    Returns:
    The output.
  - send
```
public OutputStream send(Boolean message)
```
    Description copied from interface: Output
    
    Sends a message on the output.
    
    Specified by:
    
    send in interface Output<OutputStream>
    
    Parameters:
    message - The message to send.
    
    Returns:
    The output.
  - send
```
public OutputStream send(Character message)
```
    Description copied from interface: Output
    
    Sends a message on the output.
    
    Specified by:
    
    send in interface Output<OutputStream>
    
    Parameters:
    message - The message to send.
    
    Returns:
    The output.
  - send
```
public OutputStream send(Short message)
```
    Description copied from interface: Output
    
    Sends a message on the output.
    
    Specified by:
    
    send in interface Output<OutputStream>
    
    Parameters:
    message - The message to send.
    
    Returns:
    The output.
  - send
```
public OutputStream send(Integer message)
```
    Description copied from interface: Output
    
    Sends a message on the output.
    
    Specified by:
    
    send in interface Output<OutputStream>
    
    Parameters:
    message - The message to send.
    
    Returns:
    The output.
  - send
```
public OutputStream send(Long message)
```
    Description copied from interface: Output
    
    Sends a message on the output.
    
    Specified by:
    
    send in interface Output<OutputStream>
    
    Parameters:
    message - The message to send.
    
    Returns:
    The output.
  - send
```
public OutputStream send(Double message)
```
    Description copied from interface: Output
    
    Sends a message on the output.
    
    Specified by:
    
    send in interface Output<OutputStream>
    
    Parameters:
    message - The message to send.
    
    Returns:
    The output.
  - send
```
public OutputStream send(Float message)
```
    Description copied from interface: Output
    
    Sends a message on the output.
    
    Specified by:
    
    send in interface Output<OutputStream>
    
    Parameters:
    message - The message to send.
    
    Returns:
    The output.
  - send
```
public OutputStream 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<OutputStream>
    
    Parameters:
    message - The message to send.
    
    Returns:
    The output.
  - send
```
public OutputStream 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<OutputStream>
    
    Parameters:
    message - The message to send.
    
    Returns:
    The output.
  - send
```
public OutputStream 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<OutputStream>
    
    Parameters:
    message - The message to send.
    
    Returns:
    The output.
  - send
```
public OutputStream send(Byte message)
```
    Description copied from interface: Output
    
    Sends a message on the output.
    
    Specified by:
    
    send in interface Output<OutputStream>
    
    Parameters:
    message - The message to send.
    
    Returns:
    The output.
  - send
```
public OutputStream send(byte[] message)
```
    Description copied from interface: Output
    
    Sends a message on the output.
    
    Specified by:
    
    send in interface Output<OutputStream>
    
    Parameters:
    message - The message to send.
    
    Returns:
    The output.
  - close
```
public void close()
```
    Description copied from interface: Closeable
    
    Closes the stream.
    
    Specified by:
    
    close in interface Closeable<OutputStream>
  - 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<OutputStream>
    
    Parameters:
    doneHandler - An asynchronous handler to be called once complete.

Class DefaultOutputStream

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultOutputStream

Method Detail

vertx

address

open

open

setSendQueueMaxSize

getSendQueueMaxSize

size

sendQueueFull

drainHandler

batch

batch

group

send

send

send

send

send

send

send

send

send

send

send

send

send

send

close

close