io.netty.handler.codec.string

Class StringEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOperationHandlerAdapter

io.netty.channel.ChannelOutboundMessageHandlerAdapter<CharSequence>

io.netty.handler.codec.string.StringEncoder

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelHandlerUtil.SingleOutboundMessageHandler<CharSequence>, io.netty.channel.ChannelOperationHandler, io.netty.channel.ChannelOutboundMessageHandler<CharSequence>

@ChannelHandler.Sharable
public class StringEncoder
extends io.netty.channel.ChannelOutboundMessageHandlerAdapter<CharSequence>

Encodes the requested String into a ByteBuf. A typical setup for a text-based line protocol in a TCP/IP socket would be:

 ChannelPipeline pipeline = ...;

 // Decoders
 pipeline.addLast("frameDecoder", new LineBasedFrameDecoder(80));
 pipeline.addLast("stringDecoder", new StringDecoder(CharsetUtil.UTF_8));

 // Encoder
 pipeline.addLast("stringEncoder", new StringEncoder(CharsetUtil.UTF_8));
 

and then you can use a String instead of a ByteBuf as a message:

 void messageReceived(ChannelHandlerContext ctx, String msg) {
     ch.write("Did you say '" + msg + "'?\n");
 }
 

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields inherited from class io.netty.channel.ChannelOutboundMessageHandlerAdapter

ABORT

Constructor Summary

Constructors

Constructor and Description
StringEncoder(io.netty.buffer.BufType nextBufferType) Creates a new instance with the current system character set.
StringEncoder(io.netty.buffer.BufType nextBufferType, Charset charset) Creates a new instance with the specified character set.

Method Summary

Methods

Modifier and Type	Method and Description
void	flush(io.netty.channel.ChannelHandlerContext ctx, CharSequence msg)

Methods inherited from class io.netty.channel.ChannelOutboundMessageHandlerAdapter

acceptOutboundMessage, beginFlush, endFlush, flush, freeOutboundBuffer, isCloseOnFailedFlush, newOutboundBuffer, setCloseOnFailedFlush

Methods inherited from class io.netty.channel.ChannelOperationHandlerAdapter

bind, close, connect, deregister, disconnect, read, sendFile

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelOperationHandler

bind, close, connect, deregister, disconnect, read, sendFile

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught

Constructor Detail

StringEncoder

public StringEncoder(io.netty.buffer.BufType nextBufferType)

Creates a new instance with the current system character set.

StringEncoder

public StringEncoder(io.netty.buffer.BufType nextBufferType,
             Charset charset)

Creates a new instance with the specified character set.

Method Detail

flush

public void flush(io.netty.channel.ChannelHandlerContext ctx,
         CharSequence msg)
           throws Exception

Throws:

Exception