Class RtspObjectDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.http.HttpObjectDecoder

io.netty.handler.codec.rtsp.RtspObjectDecoder

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

@Deprecated
public abstract class RtspObjectDecoder
extends HttpObjectDecoder

Deprecated.

Use RtspDecoder instead.

Decodes ByteBufs into RTSP messages represented in HttpMessages.

Parameters that prevents excessive memory consumption

Name	Meaning
maxInitialLineLength	The maximum length of the initial line (e.g. "SETUP / RTSP/1.0" or "RTSP/1.0 200 OK") If the length of the initial line exceeds this value, a TooLongFrameException will be raised.
maxHeaderSize	The maximum length of all headers. If the sum of the length of each header exceeds this value, a TooLongFrameException will be raised.
maxContentLength	The maximum length of the content. If the content length exceeds this value, a TooLongFrameException will be raised.

Nested Class Summary

Nested classes/interfaces inherited from class ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

Modifier and Type	Class	Description
static interface	ByteToMessageDecoder.Cumulator	Cumulate ByteBufs.

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Modifier and Type	Interface	Description
static @interface	ChannelHandler.Sharable	Indicates that the same instance of the annotated ChannelHandler can be added to one or more ChannelPipelines multiple times without a race condition.

Field Summary

Fields inherited from class HttpObjectDecoder

DEFAULT_ALLOW_DUPLICATE_CONTENT_LENGTHS, DEFAULT_ALLOW_PARTIAL_CHUNKS, DEFAULT_CHUNKED_SUPPORTED, DEFAULT_INITIAL_BUFFER_SIZE, DEFAULT_MAX_CHUNK_SIZE, DEFAULT_MAX_HEADER_SIZE, DEFAULT_MAX_INITIAL_LINE_LENGTH, DEFAULT_STRICT_LINE_PARSING, DEFAULT_VALIDATE_HEADERS, headersFactory, PROP_RFC9112_TRANSFER_ENCODING, RFC9112_TRANSFER_ENCODING, trailersFactory, validateHeaders

Modifier and Type	Field	Description
static final boolean	DEFAULT_ALLOW_DUPLICATE_CONTENT_LENGTHS
static final boolean	DEFAULT_ALLOW_PARTIAL_CHUNKS
static final boolean	DEFAULT_CHUNKED_SUPPORTED
static final int	DEFAULT_INITIAL_BUFFER_SIZE
static final int	DEFAULT_MAX_CHUNK_SIZE
static final int	DEFAULT_MAX_HEADER_SIZE
static final int	DEFAULT_MAX_INITIAL_LINE_LENGTH
static final boolean	DEFAULT_STRICT_LINE_PARSING
static final boolean	DEFAULT_VALIDATE_HEADERS
protected final HttpHeadersFactory	headersFactory
static final String	PROP_RFC9112_TRANSFER_ENCODING
static final boolean	RFC9112_TRANSFER_ENCODING
protected final HttpHeadersFactory	trailersFactory
protected final boolean	validateHeaders	Deprecated.

Fields inherited from class ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Modifier and Type	Field	Description
static final ByteToMessageDecoder.Cumulator	COMPOSITE_CUMULATOR	Cumulate ByteBufs by add them to a CompositeByteBuf and so do no memory copy whenever possible.
static final ByteToMessageDecoder.Cumulator	MERGE_CUMULATOR	Cumulate ByteBufs by merge them into one ByteBuf's, using memory copies.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RtspObjectDecoder()	Deprecated. Creates a new instance with the default maxInitialLineLength (4096), maxHeaderSize (8192), and maxContentLength (8192).
protected	RtspObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxContentLength)	Deprecated. Creates a new instance with the specified parameters.
protected	RtspObjectDecoder(int maxInitialLineLength, int maxHeaderSize, int maxContentLength, boolean validateHeaders)	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected boolean	isContentAlwaysEmpty(HttpMessage msg)	Deprecated.

Methods inherited from class HttpObjectDecoder

clearContentLength, createInvalidMessage, createMessage, decode, decodeLast, handlerRemoved0, handleTransferEncodingChunkedWithContentLength, isDecodingRequest, isSwitchingToNonHttp1Protocol, isValidating, reset, splitFirstWordInitialLine, splitHeaderName, splitSecondWordInitialLine, splitThirdWordInitialLine, userEventTriggered

Modifier and Type	Method	Description
protected final void	clearContentLength()
protected abstract HttpMessage	createInvalidMessage()
protected abstract HttpMessage	createMessage(String[] initialLine)
protected void	decode(ChannelHandlerContext ctx, ByteBuf buffer, List<Object> out)	Decode the from one ByteBuf to an other.
protected void	decodeLast(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)	Is called one last time when the ChannelHandlerContext goes in-active.
protected void	handlerRemoved0(ChannelHandlerContext ctx)	Gets called after the ByteToMessageDecoder was removed from the actual context and it doesn't handle events anymore.
protected void	handleTransferEncodingChunkedWithContentLength(HttpMessage message)	Invoked when a message with both a "Transfer-Encoding: chunked" and a "Content-Length" header field is detected.
protected abstract boolean	isDecodingRequest()
protected boolean	isSwitchingToNonHttp1Protocol(HttpResponse msg)	Returns true if the server switched to a different protocol than HTTP/1.0 or HTTP/1.1, e.g.
protected boolean	isValidating(HttpHeadersFactory headersFactory)
void	reset()	Resets the state of the decoder so that it is ready to decode a new message.
protected String	splitFirstWordInitialLine(byte[] asciiContent, int start, int length)
protected AsciiString	splitHeaderName(byte[] sb, int start, int length)
protected String	splitSecondWordInitialLine(byte[] asciiContent, int start, int length)
protected String	splitThirdWordInitialLine(byte[] asciiContent, int start, int length)
void	userEventTriggered(ChannelHandlerContext ctx, Object evt)	Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.

Methods inherited from class ByteToMessageDecoder

actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, discardSomeReadBytes, handlerRemoved, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode

Modifier and Type	Method	Description
protected int	actualReadableBytes()	Returns the actual number of readable bytes in the internal cumulative buffer of this decoder.
protected void	callDecode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)	Called once data should be decoded from the given ByteBuf.
void	channelInactive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRead(ChannelHandlerContext ctx, Object input)	Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelReadComplete(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected final void	discardSomeReadBytes()
final void	handlerRemoved(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
protected ByteBuf	internalBuffer()	Returns the internal cumulative buffer of this decoder.
boolean	isSingleDecode()	If true then only one message is decoded on each ByteToMessageDecoder.channelRead(ChannelHandlerContext, Object) call.
void	setCumulator(ByteToMessageDecoder.Cumulator cumulator)	Set the ByteToMessageDecoder.Cumulator to use for cumulate the received ByteBufs.
void	setDiscardAfterReads(int discardAfterReads)	Set the number of reads after which ByteBuf.discardSomeReadBytes() are called and so free up memory.
void	setSingleDecode(boolean singleDecode)	If set then only one message is decoded on each ByteToMessageDecoder.channelRead(ChannelHandlerContext, Object) call.

Methods inherited from class ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Modifier and Type	Method	Description
void	channelActive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRegistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelUnregistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelUnregistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelWritabilityChanged(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

Modifier and Type	Method	Description
protected void	ensureNotSharable()	Throws IllegalStateException if ChannelHandlerAdapter.isSharable() returns true
void	handlerAdded(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
boolean	isSharable()	Return true if the implementation is ChannelHandler.Sharable and so can be added to different ChannelPipelines.

Methods inherited from class Object

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

Constructor Details

RtspObjectDecoder

protected RtspObjectDecoder()

Deprecated.

Creates a new instance with the default maxInitialLineLength (4096), maxHeaderSize (8192), and maxContentLength (8192).

RtspObjectDecoder

protected RtspObjectDecoder(int maxInitialLineLength,
 int maxHeaderSize,
 int maxContentLength)

Deprecated.

Creates a new instance with the specified parameters.

RtspObjectDecoder

protected RtspObjectDecoder(int maxInitialLineLength,
 int maxHeaderSize,
 int maxContentLength,
 boolean validateHeaders)

Deprecated.

Method Details

isContentAlwaysEmpty

protected boolean isContentAlwaysEmpty(HttpMessage msg)

Deprecated.

Overrides:

isContentAlwaysEmpty in class HttpObjectDecoder