io.undertow.util

Class StringWriteChannelListener

java.lang.Object

io.undertow.util.StringWriteChannelListener

All Implemented Interfaces:

EventListener, ChannelListener<StreamSinkChannel>

public class StringWriteChannelListener
extends Object
implements ChannelListener<StreamSinkChannel>

A simple write listener that can be used to write out the contents of a String. When the string is written out it closes the channel. This should not be added directly to the channel, instead setup(org.xnio.channels.StreamSinkChannel) should be called, which will attempt a write, and only add the listener if required.

Author:

Stuart Douglas

Nested Class Summary

Nested classes/interfaces inherited from interface org.xnio.ChannelListener

ChannelListener.Setter<T extends Channel>, ChannelListener.SimpleSetter<T extends Channel>

Constructor Summary

Constructors

Constructor and Description
StringWriteChannelListener(String string)
StringWriteChannelListener(String string, Charset charset)

Method Summary

Modifier and Type	Method and Description
protected void	handleError(StreamSinkChannel channel, IOException e)
void	handleEvent(StreamSinkChannel channel) Handle the event on this channel.
boolean	hasRemaining()
void	setup(StreamSinkChannel channel)
protected void	writeDone(StreamSinkChannel channel)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringWriteChannelListener

public StringWriteChannelListener(String string)

StringWriteChannelListener

public StringWriteChannelListener(String string,
                                  Charset charset)

Method Detail

setup

public void setup(StreamSinkChannel channel)

handleError

protected void handleError(StreamSinkChannel channel,
                           IOException e)

handleEvent

public void handleEvent(StreamSinkChannel channel)

Description copied from interface: ChannelListener

Handle the event on this channel.

Specified by:

handleEvent in interface ChannelListener<StreamSinkChannel>

Parameters:

channel - the channel event

hasRemaining

public boolean hasRemaining()

writeDone

protected void writeDone(StreamSinkChannel channel)