io.netty.handler.codec.string

类 LineEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.codec.MessageToMessageEncoder<java.lang.CharSequence>

io.netty.handler.codec.string.LineEncoder

所有已实现的接口:

ChannelHandler, ChannelOutboundHandler

@ChannelHandler.Sharable
public class LineEncoder
extends MessageToMessageEncoder<java.lang.CharSequence>

Apply a line separator to the requested String and encode it 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("lineEncoder", new LineEncoder(LineSeparator.UNIX, 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 + "'?");
 }
 

嵌套类概要

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
LineEncoder() Creates a new instance with the current system line separator and UTF-8 charset encoding.
LineEncoder(java.nio.charset.Charset charset) Creates a new instance with the specified character set.
LineEncoder(LineSeparator lineSeparator) Creates a new instance with the specified line separator and UTF-8 charset encoding.
LineEncoder(LineSeparator lineSeparator, java.nio.charset.Charset charset) Creates a new instance with the specified line separator and character set.

方法概要

限定符和类型	方法和说明
protected void	encode(ChannelHandlerContext ctx, java.lang.CharSequence msg, java.util.List<java.lang.Object> out) Encode from one message to an other.

从类继承的方法 io.netty.handler.codec.MessageToMessageEncoder

acceptOutboundMessage, write

从类继承的方法 io.netty.channel.ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, flush, read

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

从类继承的方法 java.lang.Object

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

从接口继承的方法 io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

构造器详细资料

LineEncoder

public LineEncoder()

Creates a new instance with the current system line separator and UTF-8 charset encoding.

LineEncoder

public LineEncoder(LineSeparator lineSeparator)

Creates a new instance with the specified line separator and UTF-8 charset encoding.

LineEncoder

public LineEncoder(java.nio.charset.Charset charset)

Creates a new instance with the specified character set.

LineEncoder

public LineEncoder(LineSeparator lineSeparator,
                   java.nio.charset.Charset charset)

Creates a new instance with the specified line separator and character set.

方法详细资料

encode

protected void encode(ChannelHandlerContext ctx,
                      java.lang.CharSequence msg,
                      java.util.List<java.lang.Object> out)
               throws java.lang.Exception

从类复制的说明: MessageToMessageEncoder

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

指定者:

encode 在类中 MessageToMessageEncoder<java.lang.CharSequence>

参数:

ctx - the ChannelHandlerContext which this MessageToMessageEncoder belongs to

msg - the message to encode to an other one

out - the List into which the encoded msg should be added needs to do some kind of aggregation

抛出:

java.lang.Exception - is thrown if an error occurs