Netty5/Codec 5.0.0.Alpha5 · io.netty5.handler.codec.string.StringEncoder

Encodes the requested String into a Buffer. 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 Buffer as a message:

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

Modifier and Type	Field and Description
private final Charset	charset

Constructor Summary

Access	Constructor and Description
public	StringEncoder() Creates a new instance with the current system character set.
public	StringEncoder(Charset charset) Creates a new instance with the specified character set.

Method Summary

Modifier and Type	Method and Description
protected void	encode(ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageEncoder` belongs to. ctx, CharSequence the message to encode to another one. msg, List<Object> the `List` into which produced output messages should be added. out) Overrides io.netty5.handler.codec.MessageToMessageEncoder.encode. Encode from one message to another.
public boolean	isSharable() Overrides default io.netty5.channel.ChannelHandler.isSharable. Returns `true` if this handler is sharable and thus can be added to more than one `ChannelPipeline`.

Inherited from io.netty5.handler.codec.MessageToMessageEncoder:: acceptOutboundMessage encodeAndClose write

Field Detail

charset	back to summary
private final Charset charset

Constructor Detail

StringEncoder	back to summary
public StringEncoder() Creates a new instance with the current system character set.

StringEncoder	back to summary
public StringEncoder(Charset charset) Creates a new instance with the specified character set.

Method Detail

encode back to summary

encode	back to summary
protected void encode(ChannelHandlerContext ctx, CharSequence msg, List<Object> out) throws Exception Overrides io.netty5.handler.codec.MessageToMessageEncoder.encode. Doc from io.netty5.handler.codec.MessageToMessageEncoder.encode. Encode from one message to another. This method will be called for each written message that can be handled by this encoder. The message will be disposed of after this call. Subclasses that wish to sometimes pass messages through, should instead override the `encodeAndClose(ChannelHandlerContext, Object, List)` method. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageEncoder` belongs to. msg:CharSequence the message to encode to another one. out:List<Object> the `List` into which produced output messages should be added. Annotations @Override Exceptions Exception: is thrown if an error occurs.

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

Overrides io.netty5.handler.codec.MessageToMessageEncoder.encode.

Doc from io.netty5.handler.codec.MessageToMessageEncoder.encode.

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

The message will be disposed of after this call.

Subclasses that wish to sometimes pass messages through, should instead override the encodeAndClose(ChannelHandlerContext, Object, List) method.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this MessageToMessageEncoder belongs to.
msg:CharSequence: the message to encode to another one.
out:List<Object>: the List into which produced output messages should be added.

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs.

isSharable back to summary

isSharable	back to summary
public boolean isSharable() Overrides default io.netty5.channel.ChannelHandler.isSharable. Doc from io.netty5.channel.ChannelHandler.isSharable. Returns `true` if this handler is sharable and thus can be added to more than one `ChannelPipeline`. By default, this method returns `false`. If this method returns `false`, you have to create a new handler instance every time you add it to a pipeline because it has unshared state such as member variables. Annotations @Override

public boolean isSharable()

Overrides default io.netty5.channel.ChannelHandler.isSharable.

Doc from io.netty5.channel.ChannelHandler.isSharable.

Returns true if this handler is sharable and thus can be added to more than one ChannelPipeline. By default, this method returns false. If this method returns false, you have to create a new handler instance every time you add it to a pipeline because it has unshared state such as member variables.