io.reactivex.netty.channel

Class MarkAwarePipeline

java.lang.Object

io.reactivex.netty.channel.MarkAwarePipeline

All Implemented Interfaces:

io.netty.channel.ChannelInboundInvoker, io.netty.channel.ChannelOutboundInvoker, io.netty.channel.ChannelPipeline, java.lang.Iterable<java.util.Map.Entry<java.lang.String,io.netty.channel.ChannelHandler>>

public final class MarkAwarePipeline
extends java.lang.Object
implements io.netty.channel.ChannelPipeline

An implementation of ChannelPipeline that allows a mark-reset scheme for ChannelHandlers. This allows temporary modifications to the underlying ChannelPipeline instance for usecases like pooled connections, server response upgrades, etc. This only supports a single mark at a time, although mark-reset-mark cycles can be repeated any number of times.

Usage:

To start recording resetable changes, call mark() and to reset back to the state before mark() was called, call reset()

Thread safety

All operations of ChannelPipeline are delegated to the passed ChannelPipeline instance while creation. mark() and reset() uses the same mutex as ChannelPipeline for synchronization across different method calls.

Constructor Summary

Constructors

Constructor and Description
MarkAwarePipeline(io.netty.channel.ChannelPipeline delegate)

Method Summary

Modifier and Type	Method and Description
io.netty.channel.ChannelPipeline	addAfter(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String baseName, java.lang.String name, io.netty.channel.ChannelHandler handler)
io.netty.channel.ChannelPipeline	addAfter(java.lang.String baseName, java.lang.String name, io.netty.channel.ChannelHandler handler)
io.netty.channel.ChannelPipeline	addBefore(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String baseName, java.lang.String name, io.netty.channel.ChannelHandler handler)
io.netty.channel.ChannelPipeline	addBefore(java.lang.String baseName, java.lang.String name, io.netty.channel.ChannelHandler handler)
io.netty.channel.ChannelPipeline	addFirst(io.netty.channel.ChannelHandler... handlers)
io.netty.channel.ChannelPipeline	addFirst(io.netty.util.concurrent.EventExecutorGroup group, io.netty.channel.ChannelHandler... handlers)
io.netty.channel.ChannelPipeline	addFirst(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String name, io.netty.channel.ChannelHandler handler)
io.netty.channel.ChannelPipeline	addFirst(java.lang.String name, io.netty.channel.ChannelHandler handler)
io.netty.channel.ChannelPipeline	addLast(io.netty.channel.ChannelHandler... handlers)
io.netty.channel.ChannelPipeline	addLast(io.netty.util.concurrent.EventExecutorGroup group, io.netty.channel.ChannelHandler... handlers)
io.netty.channel.ChannelPipeline	addLast(io.netty.util.concurrent.EventExecutorGroup group, java.lang.String name, io.netty.channel.ChannelHandler handler)
io.netty.channel.ChannelPipeline	addLast(java.lang.String name, io.netty.channel.ChannelHandler handler)
io.netty.channel.ChannelFuture	bind(java.net.SocketAddress localAddress)
io.netty.channel.ChannelFuture	bind(java.net.SocketAddress localAddress, io.netty.channel.ChannelPromise promise)
io.netty.channel.Channel	channel()
io.netty.channel.ChannelFuture	close()
io.netty.channel.ChannelFuture	close(io.netty.channel.ChannelPromise promise)
io.netty.channel.ChannelFuture	connect(java.net.SocketAddress remoteAddress)
io.netty.channel.ChannelFuture	connect(java.net.SocketAddress remoteAddress, io.netty.channel.ChannelPromise promise)
io.netty.channel.ChannelFuture	connect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)
io.netty.channel.ChannelFuture	connect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, io.netty.channel.ChannelPromise promise)
io.netty.channel.ChannelHandlerContext	context(io.netty.channel.ChannelHandler handler)
io.netty.channel.ChannelHandlerContext	context(java.lang.Class<? extends io.netty.channel.ChannelHandler> handlerType)
io.netty.channel.ChannelHandlerContext	context(java.lang.String name)
io.netty.channel.ChannelFuture	deregister()
io.netty.channel.ChannelFuture	deregister(io.netty.channel.ChannelPromise promise)
io.netty.channel.ChannelFuture	disconnect()
io.netty.channel.ChannelFuture	disconnect(io.netty.channel.ChannelPromise promise)
io.netty.channel.ChannelPipeline	fireChannelActive()
io.netty.channel.ChannelPipeline	fireChannelInactive()
io.netty.channel.ChannelPipeline	fireChannelRead(java.lang.Object msg)
io.netty.channel.ChannelPipeline	fireChannelReadComplete()
io.netty.channel.ChannelPipeline	fireChannelRegistered()
io.netty.channel.ChannelPipeline	fireChannelUnregistered()
io.netty.channel.ChannelPipeline	fireChannelWritabilityChanged()
io.netty.channel.ChannelPipeline	fireExceptionCaught(java.lang.Throwable cause)
io.netty.channel.ChannelPipeline	fireUserEventTriggered(java.lang.Object event)
io.netty.channel.ChannelHandler	first()
io.netty.channel.ChannelHandlerContext	firstContext()
io.netty.channel.ChannelPipeline	flush()
<T extends io.netty.channel.ChannelHandler> T	get(java.lang.Class<T> handlerType)
io.netty.channel.ChannelHandler	get(java.lang.String name)
boolean	isMarked()
java.util.Iterator<java.util.Map.Entry<java.lang.String,io.netty.channel.ChannelHandler>>	iterator()
io.netty.channel.ChannelHandler	last()
io.netty.channel.ChannelHandlerContext	lastContext()
MarkAwarePipeline	mark() Marks this pipeline and record further changes which can be reverted by calling reset()
MarkAwarePipeline	markIfNotYetMarked() Marks this pipeline and record further changes which can be reverted by calling reset()
java.util.List<java.lang.String>	names()
io.netty.channel.ChannelFuture	newFailedFuture(java.lang.Throwable cause)
io.netty.channel.ChannelProgressivePromise	newProgressivePromise()
io.netty.channel.ChannelPromise	newPromise()
io.netty.channel.ChannelFuture	newSucceededFuture()
io.netty.channel.ChannelOutboundInvoker	read()
io.netty.channel.ChannelPipeline	remove(io.netty.channel.ChannelHandler handler)
<T extends io.netty.channel.ChannelHandler> T	remove(java.lang.Class<T> handlerType)
io.netty.channel.ChannelHandler	remove(java.lang.String name)
io.netty.channel.ChannelHandler	removeFirst()
io.netty.channel.ChannelHandler	removeLast()
io.netty.channel.ChannelPipeline	replace(io.netty.channel.ChannelHandler oldHandler, java.lang.String newName, io.netty.channel.ChannelHandler newHandler)
<T extends io.netty.channel.ChannelHandler> T	replace(java.lang.Class<T> oldHandlerType, java.lang.String newName, io.netty.channel.ChannelHandler newHandler)
io.netty.channel.ChannelHandler	replace(java.lang.String oldName, java.lang.String newName, io.netty.channel.ChannelHandler newHandler)
MarkAwarePipeline	reset() If mark() was called before, resets the pipeline to the state it was before calling mark().
java.util.Map<java.lang.String,io.netty.channel.ChannelHandler>	toMap()
io.netty.channel.ChannelPromise	voidPromise()
io.netty.channel.ChannelFuture	write(java.lang.Object msg)
io.netty.channel.ChannelFuture	write(java.lang.Object msg, io.netty.channel.ChannelPromise promise)
io.netty.channel.ChannelFuture	writeAndFlush(java.lang.Object msg)
io.netty.channel.ChannelFuture	writeAndFlush(java.lang.Object msg, io.netty.channel.ChannelPromise promise)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MarkAwarePipeline

public MarkAwarePipeline(io.netty.channel.ChannelPipeline delegate)

Method Detail

mark

public MarkAwarePipeline mark()

Marks this pipeline and record further changes which can be reverted by calling reset()

Throws:

java.lang.IllegalStateException - If this method is called more than once without calling reset() in between.

markIfNotYetMarked

public MarkAwarePipeline markIfNotYetMarked()

Marks this pipeline and record further changes which can be reverted by calling reset()

Throws:

java.lang.IllegalStateException - If this method is called more than once without calling reset() in between.

reset

public MarkAwarePipeline reset()

If mark() was called before, resets the pipeline to the state it was before calling mark(). Otherwise, ignores the reset.

isMarked

public boolean isMarked()

addFirst

public io.netty.channel.ChannelPipeline addFirst(java.lang.String name,
                                                 io.netty.channel.ChannelHandler handler)

Specified by:

addFirst in interface io.netty.channel.ChannelPipeline

addFirst

public io.netty.channel.ChannelPipeline addFirst(io.netty.util.concurrent.EventExecutorGroup group,
                                                 java.lang.String name,
                                                 io.netty.channel.ChannelHandler handler)

Specified by:

addFirst in interface io.netty.channel.ChannelPipeline

addLast

public io.netty.channel.ChannelPipeline addLast(java.lang.String name,
                                                io.netty.channel.ChannelHandler handler)

Specified by:

addLast in interface io.netty.channel.ChannelPipeline

addLast

public io.netty.channel.ChannelPipeline addLast(io.netty.util.concurrent.EventExecutorGroup group,
                                                java.lang.String name,
                                                io.netty.channel.ChannelHandler handler)

Specified by:

addLast in interface io.netty.channel.ChannelPipeline

addBefore

public io.netty.channel.ChannelPipeline addBefore(java.lang.String baseName,
                                                  java.lang.String name,
                                                  io.netty.channel.ChannelHandler handler)

Specified by:

addBefore in interface io.netty.channel.ChannelPipeline

addBefore

public io.netty.channel.ChannelPipeline addBefore(io.netty.util.concurrent.EventExecutorGroup group,
                                                  java.lang.String baseName,
                                                  java.lang.String name,
                                                  io.netty.channel.ChannelHandler handler)

Specified by:

addBefore in interface io.netty.channel.ChannelPipeline

addAfter

public io.netty.channel.ChannelPipeline addAfter(java.lang.String baseName,
                                                 java.lang.String name,
                                                 io.netty.channel.ChannelHandler handler)

Specified by:

addAfter in interface io.netty.channel.ChannelPipeline

addAfter

public io.netty.channel.ChannelPipeline addAfter(io.netty.util.concurrent.EventExecutorGroup group,
                                                 java.lang.String baseName,
                                                 java.lang.String name,
                                                 io.netty.channel.ChannelHandler handler)

Specified by:

addAfter in interface io.netty.channel.ChannelPipeline

addFirst

public io.netty.channel.ChannelPipeline addFirst(io.netty.channel.ChannelHandler... handlers)

Specified by:

addFirst in interface io.netty.channel.ChannelPipeline

addFirst

public io.netty.channel.ChannelPipeline addFirst(io.netty.util.concurrent.EventExecutorGroup group,
                                                 io.netty.channel.ChannelHandler... handlers)

Specified by:

addFirst in interface io.netty.channel.ChannelPipeline

addLast

public io.netty.channel.ChannelPipeline addLast(io.netty.channel.ChannelHandler... handlers)

Specified by:

addLast in interface io.netty.channel.ChannelPipeline

addLast

public io.netty.channel.ChannelPipeline addLast(io.netty.util.concurrent.EventExecutorGroup group,
                                                io.netty.channel.ChannelHandler... handlers)

Specified by:

addLast in interface io.netty.channel.ChannelPipeline

remove

public io.netty.channel.ChannelPipeline remove(io.netty.channel.ChannelHandler handler)

Specified by:

remove in interface io.netty.channel.ChannelPipeline

remove

public io.netty.channel.ChannelHandler remove(java.lang.String name)

Specified by:

remove in interface io.netty.channel.ChannelPipeline

remove

public <T extends io.netty.channel.ChannelHandler> T remove(java.lang.Class<T> handlerType)

Specified by:

remove in interface io.netty.channel.ChannelPipeline

removeFirst

public io.netty.channel.ChannelHandler removeFirst()

Specified by:

removeFirst in interface io.netty.channel.ChannelPipeline

removeLast

public io.netty.channel.ChannelHandler removeLast()

Specified by:

removeLast in interface io.netty.channel.ChannelPipeline

replace

public io.netty.channel.ChannelPipeline replace(io.netty.channel.ChannelHandler oldHandler,
                                                java.lang.String newName,
                                                io.netty.channel.ChannelHandler newHandler)

Specified by:

replace in interface io.netty.channel.ChannelPipeline

replace

public io.netty.channel.ChannelHandler replace(java.lang.String oldName,
                                               java.lang.String newName,
                                               io.netty.channel.ChannelHandler newHandler)

Specified by:

replace in interface io.netty.channel.ChannelPipeline

replace

public <T extends io.netty.channel.ChannelHandler> T replace(java.lang.Class<T> oldHandlerType,
                                                             java.lang.String newName,
                                                             io.netty.channel.ChannelHandler newHandler)

Specified by:

replace in interface io.netty.channel.ChannelPipeline

first

public io.netty.channel.ChannelHandler first()

Specified by:

first in interface io.netty.channel.ChannelPipeline

firstContext

public io.netty.channel.ChannelHandlerContext firstContext()

Specified by:

firstContext in interface io.netty.channel.ChannelPipeline

last

public io.netty.channel.ChannelHandler last()

Specified by:

last in interface io.netty.channel.ChannelPipeline

lastContext

public io.netty.channel.ChannelHandlerContext lastContext()

Specified by:

lastContext in interface io.netty.channel.ChannelPipeline

get

public io.netty.channel.ChannelHandler get(java.lang.String name)

Specified by:

get in interface io.netty.channel.ChannelPipeline

get

public <T extends io.netty.channel.ChannelHandler> T get(java.lang.Class<T> handlerType)

Specified by:

get in interface io.netty.channel.ChannelPipeline

context

public io.netty.channel.ChannelHandlerContext context(io.netty.channel.ChannelHandler handler)

Specified by:

context in interface io.netty.channel.ChannelPipeline

context

public io.netty.channel.ChannelHandlerContext context(java.lang.String name)

Specified by:

context in interface io.netty.channel.ChannelPipeline

context

public io.netty.channel.ChannelHandlerContext context(java.lang.Class<? extends io.netty.channel.ChannelHandler> handlerType)

Specified by:

context in interface io.netty.channel.ChannelPipeline

channel

public io.netty.channel.Channel channel()

Specified by:

channel in interface io.netty.channel.ChannelPipeline

names

public java.util.List<java.lang.String> names()

Specified by:

names in interface io.netty.channel.ChannelPipeline

toMap

public java.util.Map<java.lang.String,io.netty.channel.ChannelHandler> toMap()

Specified by:

toMap in interface io.netty.channel.ChannelPipeline

fireChannelRegistered

public io.netty.channel.ChannelPipeline fireChannelRegistered()

Specified by:

fireChannelRegistered in interface io.netty.channel.ChannelInboundInvoker

Specified by:

fireChannelRegistered in interface io.netty.channel.ChannelPipeline

fireChannelUnregistered

public io.netty.channel.ChannelPipeline fireChannelUnregistered()

Specified by:

fireChannelUnregistered in interface io.netty.channel.ChannelInboundInvoker

Specified by:

fireChannelUnregistered in interface io.netty.channel.ChannelPipeline

fireChannelActive

public io.netty.channel.ChannelPipeline fireChannelActive()

Specified by:

fireChannelActive in interface io.netty.channel.ChannelInboundInvoker

Specified by:

fireChannelActive in interface io.netty.channel.ChannelPipeline

fireChannelInactive

public io.netty.channel.ChannelPipeline fireChannelInactive()

Specified by:

fireChannelInactive in interface io.netty.channel.ChannelInboundInvoker

Specified by:

fireChannelInactive in interface io.netty.channel.ChannelPipeline

fireExceptionCaught

public io.netty.channel.ChannelPipeline fireExceptionCaught(java.lang.Throwable cause)

Specified by:

fireExceptionCaught in interface io.netty.channel.ChannelInboundInvoker

Specified by:

fireExceptionCaught in interface io.netty.channel.ChannelPipeline

fireUserEventTriggered

public io.netty.channel.ChannelPipeline fireUserEventTriggered(java.lang.Object event)

Specified by:

fireUserEventTriggered in interface io.netty.channel.ChannelInboundInvoker

Specified by:

fireUserEventTriggered in interface io.netty.channel.ChannelPipeline

fireChannelRead

public io.netty.channel.ChannelPipeline fireChannelRead(java.lang.Object msg)

Specified by:

fireChannelRead in interface io.netty.channel.ChannelInboundInvoker

Specified by:

fireChannelRead in interface io.netty.channel.ChannelPipeline

fireChannelReadComplete

public io.netty.channel.ChannelPipeline fireChannelReadComplete()

Specified by:

fireChannelReadComplete in interface io.netty.channel.ChannelInboundInvoker

Specified by:

fireChannelReadComplete in interface io.netty.channel.ChannelPipeline

fireChannelWritabilityChanged

public io.netty.channel.ChannelPipeline fireChannelWritabilityChanged()

Specified by:

fireChannelWritabilityChanged in interface io.netty.channel.ChannelInboundInvoker

Specified by:

fireChannelWritabilityChanged in interface io.netty.channel.ChannelPipeline

bind

public io.netty.channel.ChannelFuture bind(java.net.SocketAddress localAddress)

Specified by:

bind in interface io.netty.channel.ChannelOutboundInvoker

connect

public io.netty.channel.ChannelFuture connect(java.net.SocketAddress remoteAddress)

Specified by:

connect in interface io.netty.channel.ChannelOutboundInvoker

connect

public io.netty.channel.ChannelFuture connect(java.net.SocketAddress remoteAddress,
                                              java.net.SocketAddress localAddress)

Specified by:

connect in interface io.netty.channel.ChannelOutboundInvoker

disconnect

public io.netty.channel.ChannelFuture disconnect()

Specified by:

disconnect in interface io.netty.channel.ChannelOutboundInvoker

close

public io.netty.channel.ChannelFuture close()

Specified by:

close in interface io.netty.channel.ChannelOutboundInvoker

deregister

public io.netty.channel.ChannelFuture deregister()

Specified by:

deregister in interface io.netty.channel.ChannelOutboundInvoker

bind

public io.netty.channel.ChannelFuture bind(java.net.SocketAddress localAddress,
                                           io.netty.channel.ChannelPromise promise)

Specified by:

bind in interface io.netty.channel.ChannelOutboundInvoker

connect

public io.netty.channel.ChannelFuture connect(java.net.SocketAddress remoteAddress,
                                              io.netty.channel.ChannelPromise promise)

Specified by:

connect in interface io.netty.channel.ChannelOutboundInvoker

connect

public io.netty.channel.ChannelFuture connect(java.net.SocketAddress remoteAddress,
                                              java.net.SocketAddress localAddress,
                                              io.netty.channel.ChannelPromise promise)

Specified by:

connect in interface io.netty.channel.ChannelOutboundInvoker

disconnect

public io.netty.channel.ChannelFuture disconnect(io.netty.channel.ChannelPromise promise)

Specified by:

disconnect in interface io.netty.channel.ChannelOutboundInvoker

close

public io.netty.channel.ChannelFuture close(io.netty.channel.ChannelPromise promise)

Specified by:

close in interface io.netty.channel.ChannelOutboundInvoker

deregister

public io.netty.channel.ChannelFuture deregister(io.netty.channel.ChannelPromise promise)

Specified by:

deregister in interface io.netty.channel.ChannelOutboundInvoker

read

public io.netty.channel.ChannelOutboundInvoker read()

Specified by:

read in interface io.netty.channel.ChannelOutboundInvoker

write

public io.netty.channel.ChannelFuture write(java.lang.Object msg)

Specified by:

write in interface io.netty.channel.ChannelOutboundInvoker

write

public io.netty.channel.ChannelFuture write(java.lang.Object msg,
                                            io.netty.channel.ChannelPromise promise)

Specified by:

write in interface io.netty.channel.ChannelOutboundInvoker

flush

public io.netty.channel.ChannelPipeline flush()

Specified by:

flush in interface io.netty.channel.ChannelOutboundInvoker

Specified by:

flush in interface io.netty.channel.ChannelPipeline

writeAndFlush

public io.netty.channel.ChannelFuture writeAndFlush(java.lang.Object msg,
                                                    io.netty.channel.ChannelPromise promise)

Specified by:

writeAndFlush in interface io.netty.channel.ChannelOutboundInvoker

writeAndFlush

public io.netty.channel.ChannelFuture writeAndFlush(java.lang.Object msg)

Specified by:

writeAndFlush in interface io.netty.channel.ChannelOutboundInvoker

newPromise

public io.netty.channel.ChannelPromise newPromise()

Specified by:

newPromise in interface io.netty.channel.ChannelOutboundInvoker

newProgressivePromise

public io.netty.channel.ChannelProgressivePromise newProgressivePromise()

Specified by:

newProgressivePromise in interface io.netty.channel.ChannelOutboundInvoker

newSucceededFuture

public io.netty.channel.ChannelFuture newSucceededFuture()

Specified by:

newSucceededFuture in interface io.netty.channel.ChannelOutboundInvoker

newFailedFuture

public io.netty.channel.ChannelFuture newFailedFuture(java.lang.Throwable cause)

Specified by:

newFailedFuture in interface io.netty.channel.ChannelOutboundInvoker

voidPromise

public io.netty.channel.ChannelPromise voidPromise()

Specified by:

voidPromise in interface io.netty.channel.ChannelOutboundInvoker

iterator

public java.util.Iterator<java.util.Map.Entry<java.lang.String,io.netty.channel.ChannelHandler>> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.util.Map.Entry<java.lang.String,io.netty.channel.ChannelHandler>>