io.reactivex.netty.protocol.http.sse

Class SseChannelHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.SimpleChannelInboundHandler<java.lang.Object>

io.reactivex.netty.protocol.http.sse.SseChannelHandler

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler

@ChannelHandler.Sharable
public class SseChannelHandler
extends io.netty.channel.SimpleChannelInboundHandler<java.lang.Object>

A handler to insert ServerSentEventDecoder at a proper position in the pipeline according to the protocol.
There are the following cases, this handles:

Http response with chunked encoding

In this case, the ServerSentEventDecoder is inserted after this SseChannelHandler

Http response with no chunking

In this case, the ServerSentEventDecoder is inserted as the first handler in the pipeline. This makes the ByteBuf at the origin to be converted to ServerSentEvent and hence any other handler will not look at this message unless it is really interested.

Caveat

In some cases where any message is buffered before this pipeline change is made by this handler (i.e. adding ServerSentEventDecoder as the first handler), the ServerSentEventDecoder will not be applied to those messages. For this reason we also add ServerSentEventDecoder after this handler. In cases, where the first ServerSentEventDecoder is applied on the incoming data, the next instance of ServerSentEventDecoder will be redundant.

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME
static java.lang.String	SSE_DECODER_HANDLER_NAME
static java.lang.String	SSE_DECODER_POST_INBOUND_HANDLER

Constructor Summary

Constructors

Constructor and Description
SseChannelHandler()

Method Summary

Modifier and Type	Method and Description
protected void	channelRead0(io.netty.channel.ChannelHandlerContext ctx, java.lang.Object msg)

Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

acceptInboundMessage, channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

handlerAdded, handlerRemoved, isSharable

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.ChannelHandler

handlerAdded, handlerRemoved

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

SSE_DECODER_HANDLER_NAME

public static final java.lang.String SSE_DECODER_HANDLER_NAME

See Also:

Constant Field Values

SSE_DECODER_POST_INBOUND_HANDLER

public static final java.lang.String SSE_DECODER_POST_INBOUND_HANDLER

See Also:

Constant Field Values

Constructor Detail

SseChannelHandler

public SseChannelHandler()

Method Detail

channelRead0

protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
                            java.lang.Object msg)
                     throws java.lang.Exception

Specified by:

channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<java.lang.Object>

Throws:

java.lang.Exception