@ChannelHandler.Sharable public class LineEncoder extends MessageToMessageEncoder<java.lang.CharSequence>
String
and encode it into a ByteBuf
.
A typical setup for a text-based line protocol in a TCP/IP socket would be:
and then you can use aChannelPipeline
pipeline = ...; // Decoders pipeline.addLast("frameDecoder", newLineBasedFrameDecoder
(80)); pipeline.addLast("stringDecoder", newStringDecoder
(CharsetUtil.UTF_8)); // Encoder pipeline.addLast("lineEncoder", newLineEncoder
(LineSeparator.UNIX, CharsetUtil.UTF_8));
String
instead of a ByteBuf
as a message:
void channelRead(ChannelHandlerContext
ctx,String
msg) { ch.write("Did you say '" + msg + "'?"); }
ChannelHandler.Sharable
Modifier and Type | Field and Description |
---|---|
private java.nio.charset.Charset |
charset |
private byte[] |
lineSeparator |
Constructor and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
protected void |
encode(ChannelHandlerContext ctx,
java.lang.CharSequence msg,
java.util.List<java.lang.Object> out)
Encode from one message to an other.
|
acceptOutboundMessage, write
bind, close, connect, deregister, disconnect, flush, read
ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
exceptionCaught, handlerAdded, handlerRemoved
private final java.nio.charset.Charset charset
private final byte[] lineSeparator
public LineEncoder()
public LineEncoder(LineSeparator lineSeparator)
public LineEncoder(java.nio.charset.Charset charset)
public LineEncoder(LineSeparator lineSeparator, java.nio.charset.Charset charset)
protected void encode(ChannelHandlerContext ctx, java.lang.CharSequence msg, java.util.List<java.lang.Object> out) throws java.lang.Exception
MessageToMessageEncoder
encode
in class MessageToMessageEncoder<java.lang.CharSequence>
ctx
- the ChannelHandlerContext
which this MessageToMessageEncoder
belongs tomsg
- the message to encode to an other oneout
- the List
into which the encoded msg should be added
needs to do some kind of aggregationjava.lang.Exception
- is thrown if an error occurs