Top Description Fields Constructors Methods
io.netty.handler.codec.string

public Class StringDecoder

extends MessageToMessageDecoder<ByteBuf>
Class Inheritance
Annotations
@Sharable
Imports
io.netty.buffer.ByteBuf, io.netty.channel.ChannelHandler.Sharable, .ChannelHandlerContext, .ChannelPipeline, io.netty.handler.codec.ByteToMessageDecoder, .DelimiterBasedFrameDecoder, .LineBasedFrameDecoder, .MessageToMessageDecoder, io.netty.util.internal.ObjectUtil, java.nio.charset.Charset, java.util.List
Decodes a received ByteBuf into a String. Please note that this decoder must be used with a proper ByteToMessageDecoder such as DelimiterBasedFrameDecoder or LineBasedFrameDecoder if you are using a stream-based transport such as TCP/IP. 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 channelRead(ChannelHandlerContext ctx, String msg) {
    ch.write("Did you say '" + msg + "'?\n");
}

Field Summary

Modifier and TypeField and Description
private final Charset
charset

Constructor Summary

AccessConstructor and Description
public
StringDecoder()

Creates a new instance with the current system character set.

public
StringDecoder(Charset charset)

Creates a new instance with the specified character set.

Method Summary

Modifier and TypeMethod and Description
protected void
decode(ChannelHandlerContext
the ChannelHandlerContext which this MessageToMessageDecoder belongs to
ctx, ByteBuf
the message to decode to an other one
msg, List<Object>
the List to which decoded messages should be added
out)

Implements abstract io.netty.handler.codec.MessageToMessageDecoder.decode.

Decode from one message to an other.
Inherited from io.netty.handler.codec.MessageToMessageDecoder:
acceptInboundMessagechannelRead

Field Detail

charsetback to summary
private final Charset charset

Constructor Detail

StringDecoderback to summary
public StringDecoder()

Creates a new instance with the current system character set.

StringDecoderback to summary
public StringDecoder(Charset charset)

Creates a new instance with the specified character set.

Method Detail

decodeback to summary
protected void decode(ChannelHandlerContext ctx, ByteBuf msg, List<Object> out) throws Exception

Implements abstract io.netty.handler.codec.MessageToMessageDecoder.decode.

Doc from io.netty.handler.codec.MessageToMessageDecoder.decode.

Decode from one message to an other. This method will be called for each written message that can be handled by this decoder.

Parameters
ctx:ChannelHandlerContext

the ChannelHandlerContext which this MessageToMessageDecoder belongs to

msg:ByteBuf

the message to decode to an other one

out:List<Object>

the List to which decoded messages should be added

Annotations
@Override
Exceptions
Exception:
is thrown if an error occurs