BlockingWriterSenderImpl (Undertow 2.0.30.Final API)

java.lang.Object
- io.undertow.servlet.core.BlockingWriterSenderImpl

All Implemented Interfaces:

Sender
```
public class BlockingWriterSenderImpl
extends Object
implements Sender
```
A sender that uses a print writer. In general this should never be used. It exists for the edge case where a filter has called getWriter() and then the default servlet is being used to serve a text file.

Author:

Stuart Douglas

Field Summary

Fields
Modifier and Type Field and Description

static int BUFFER_SIZE
TODO: we should be used pooled buffers

Fields
Modifier and Type	Field and Description
`static int`	`BUFFER_SIZE` TODO: we should be used pooled buffers

Constructor Summary

Constructors
Constructor and Description

BlockingWriterSenderImpl(HttpServerExchange exchange, PrintWriter writer, String charset)

Constructors
Constructor and Description
`BlockingWriterSenderImpl(HttpServerExchange exchange, PrintWriter writer, String charset)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes this sender asynchronously
`void`	`close(IoCallback callback)` Closes this sender asynchronously.
`void`	`send(ByteBuffer buffer)` Write the given buffer using async IO, and ends the exchange when done
`void`	`send(ByteBuffer[] buffer)` Write the given buffers using async IO, and ends the exchange when done
`void`	`send(ByteBuffer[] buffer, IoCallback callback)` Write the given buffers using async IO, and calls the given callback on completion or error.
`void`	`send(ByteBuffer buffer, IoCallback callback)` Write the given buffer using async IO, and calls the given callback on completion or error.
`void`	`send(String data)` Write the given String using async IO, and ends the exchange when done
`void`	`send(String data, Charset charset)` Write the given String using async IO, and ends the exchange when done
`void`	`send(String data, Charset charset, IoCallback callback)` Write the given String using async IO, and calls the given callback on completion or error.
`void`	`send(String data, IoCallback callback)` Write the given String using async IO, and calls the given callback on completion or error.
`void`	`transferFrom(FileChannel source, IoCallback callback)` Transfers all content from the specified file

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BUFFER_SIZE
```
public static final int BUFFER_SIZE
```
    TODO: we should be used pooled buffers
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BlockingWriterSenderImpl
```
public BlockingWriterSenderImpl(HttpServerExchange exchange,
                                PrintWriter writer,
                                String charset)
```
- Method Detail
  - send
```
public void send(ByteBuffer buffer,
                 IoCallback callback)
```
    Description copied from interface: Sender
    
    Write the given buffer using async IO, and calls the given callback on completion or error.
    
    Specified by:
    
    send in interface Sender
    
    Parameters:
    
    buffer - The buffer to send.
    
    callback - The callback
  - send
```
public void send(ByteBuffer[] buffer,
                 IoCallback callback)
```
    Description copied from interface: Sender
    
    Write the given buffers using async IO, and calls the given callback on completion or error.
    
    Specified by:
    
    send in interface Sender
    
    Parameters:
    
    buffer - The buffers to send.
    
    callback - The callback
  - send
```
public void send(String data,
                 IoCallback callback)
```
    Description copied from interface: Sender
    
    Write the given String using async IO, and calls the given callback on completion or error.
    The CharSequence is encoded to UTF8
    
    Specified by:
    
    send in interface Sender
    
    Parameters:
    
    data - The data to send
    
    callback - The callback
  - send
```
public void send(ByteBuffer buffer)
```
    Description copied from interface: Sender
    
    Write the given buffer using async IO, and ends the exchange when done
    
    Specified by:
    
    send in interface Sender
    
    Parameters:
    
    buffer - The buffer to send.
  - send
```
public void send(ByteBuffer[] buffer)
```
    Description copied from interface: Sender
    
    Write the given buffers using async IO, and ends the exchange when done
    
    Specified by:
    
    send in interface Sender
    
    Parameters:
    
    buffer - The buffers to send.
  - send
```
public void send(String data,
                 Charset charset,
                 IoCallback callback)
```
    Description copied from interface: Sender
    
    Write the given String using async IO, and calls the given callback on completion or error.
    
    Specified by:
    
    send in interface Sender
    
    Parameters:
    
    data - The buffer to end.
    
    charset - The charset to use
    
    callback - The callback
  - send
```
public void send(String data)
```
    Description copied from interface: Sender
    
    Write the given String using async IO, and ends the exchange when done
    The CharSequence is encoded to UTF8
    
    Specified by:
    
    send in interface Sender
    
    Parameters:
    
    data - The data to send
  - send
```
public void send(String data,
                 Charset charset)
```
    Description copied from interface: Sender
    
    Write the given String using async IO, and ends the exchange when done
    
    Specified by:
    
    send in interface Sender
    
    Parameters:
    
    data - The buffer to end.
    
    charset - The charset to use
  - transferFrom
```
public void transferFrom(FileChannel source,
                         IoCallback callback)
```
    Description copied from interface: Sender
    
    Transfers all content from the specified file
    
    Specified by:
    
    transferFrom in interface Sender
    
    Parameters:
    
    source - the file channel to transfer
    
    callback - The callback
  - close
```
public void close(IoCallback callback)
```
    Description copied from interface: Sender
    
    Closes this sender asynchronously. The given callback is notified on completion
    
    Specified by:
    
    close in interface Sender
    
    Parameters:
    
    callback - The callback that is notified when all data has been flushed and the channel is closed
  - close
```
public void close()
```
    Description copied from interface: Sender
    
    Closes this sender asynchronously
    
    Specified by:
    
    close in interface Sender

Class BlockingWriterSenderImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BUFFER_SIZE

Constructor Detail

BlockingWriterSenderImpl

Method Detail

send

send

send

send

send

send

send

send

transferFrom

close

close