Package org.apache.pekko.http.impl.engine.parsing

Interface HttpMessageParser<Output extends ParserOutput>

All Known Implementing Classes:

HttpResponseParser

public interface HttpMessageParser<Output extends ParserOutput>

INTERNAL API

Common logic for http request and response message parsing

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	HttpMessageParser.StateResult
static final class	HttpMessageParser.Trampoline
static class	HttpMessageParser.Trampoline$

Method Summary

Modifier and Type	Method	Description
<A extends ParserOutput> ParserOutput.StreamedEntityCreator<A,RequestEntity>	chunkedEntity(scala.Option<Content$minusType> cth)
scala.Function0<scala.Option<ParserOutput.ErrorOutput>>	completionHandling()
scala.Function0<scala.Option<ParserOutput.ErrorOutput>>	completionIsMessageStartError()	Completion handling for a message start that was truncated by the connection closing, reporting what the parser had already read of that message.
ContentType	contentType(scala.Option<Content$minusType> cth)
HttpProtocol	currentProtocol()	The protocol of the message that is currently being parsed
<A extends ParserOutput> ParserOutput.StreamedEntityCreator<A,UniversalEntity>	defaultEntity(scala.Option<Content$minusType> cth, long contentLength)
HttpMessageParser.StateResult	done()	Use {@link continue} or terminate() to suspend or terminate processing.
Output	doPull()
void	emit(Output output)
ParserOutput.StrictEntityCreator<Output,UniversalEntity>	emptyEntity(scala.Option<Content$minusType> cth)
HttpMessageParser.StateResult	failEntityStream(String summary)
HttpMessageParser.StateResult	failEntityStream(String summary, String detail)
HttpMessageParser.StateResult	failEntityStream(ErrorInfo info)
HttpMessageParser.StateResult	failMessageStart(String summary)
HttpMessageParser.StateResult	failMessageStart(String summary, String detail)
HttpMessageParser.StateResult	failMessageStart(StatusCode status)
HttpMessageParser.StateResult	failMessageStart(StatusCode status, String summary, String detail)
HttpMessageParser.StateResult	failMessageStart(StatusCode status, ErrorInfo info)
HttpHeaderParser	headerParser()
IllegalRequestContext	illegalRequestContext()	What is known about the message that is currently being parsed, at the point where parsing failed.
scala.collection.mutable.ListBuffer<HttpHeader>	initialHeaderBuffer()
boolean	isResponseParser()
scala.runtime.Nothing$	onBadProtocol(org.apache.pekko.util.ByteString input)	invoked if the specified protocol is unknown
Output	parseBytes(org.apache.pekko.util.ByteString input)
HttpMessageParser.StateResult	parseChunk(org.apache.pekko.util.ByteString input, int offset, boolean isLastMessage, long totalBytesRead, int chunkCount)
HttpMessageParser.StateResult	parseEntity(scala.collection.immutable.List<HttpHeader> headers, HttpProtocol protocol, org.apache.pekko.util.ByteString input, int bodyStart, scala.Option<Content$minusLength> clh, scala.Option<Content$minusType> cth, boolean isChunked, boolean expect100continue, boolean hostHeaderPresent, boolean closeAfterResponseCompletion, SSLSession sslSession)
HttpMessageParser.StateResult	parseFixedLengthBody(long remainingBodyBytes, boolean isLastMessage, org.apache.pekko.util.ByteString input, int bodyStart)
HttpMessageParser.StateResult	parseHeaderLines(org.apache.pekko.util.ByteString input, int lineStart, scala.collection.mutable.ListBuffer<HttpHeader> headers, int headerCount, scala.Option<Connection> ch, scala.Option<Content$minusLength> clh, scala.Option<Content$minusType> cth, boolean isChunked, boolean e100c, boolean hh)
HttpMessageParser.StateResult	parseHeaderLinesAux(scala.collection.mutable.ListBuffer<HttpHeader> headers, int headerCount, scala.Option<Connection> ch, scala.Option<Content$minusLength> clh, scala.Option<Content$minusType> cth, boolean isChunked, boolean e100c, boolean hh, org.apache.pekko.util.ByteString input, int lineStart)
HttpMessageParser.StateResult	parseMessage(org.apache.pekko.util.ByteString input, int offset)
int	parseProtocol(org.apache.pekko.util.ByteString input, int cursor)
Output	parseSessionBytes(org.apache.pekko.stream.TLSProtocol.SessionBytes input)
void	setCompletionHandling(scala.Function0<scala.Option<ParserOutput.ErrorOutput>> completionHandling)
ParserSettings	settings()
boolean	shouldComplete()
HttpMessageParser.StateResult	startNewMessage(org.apache.pekko.util.ByteString input, int offset)
ParserOutput.StrictEntityCreator<Output,UniversalEntity>	strictEntity(scala.Option<Content$minusType> cth, org.apache.pekko.util.ByteString input, int bodyStart, int contentLength)
HttpMessageParser.StateResult	terminate()
boolean	terminated()

Method Details

completionHandling

scala.Function0<scala.Option<ParserOutput.ErrorOutput>> completionHandling()

terminated

boolean terminated()

settings

ParserSettings settings()

headerParser

HttpHeaderParser headerParser()

isResponseParser

boolean isResponseParser()

onBadProtocol

scala.runtime.Nothing$ onBadProtocol(org.apache.pekko.util.ByteString input)

invoked if the specified protocol is unknown

illegalRequestContext

IllegalRequestContext illegalRequestContext()

What is known about the message that is currently being parsed, at the point where parsing failed. Only the request parser has anything to report here.

Returns:

(undocumented)

currentProtocol

HttpProtocol currentProtocol()

The protocol of the message that is currently being parsed

completionIsMessageStartError

scala.Function0<scala.Option<ParserOutput.ErrorOutput>> completionIsMessageStartError()

Completion handling for a message start that was truncated by the connection closing, reporting what the parser had already read of that message.

Returns:

(undocumented)

parseMessage

HttpMessageParser.StateResult parseMessage(org.apache.pekko.util.ByteString input,
 int offset)

parseEntity

HttpMessageParser.StateResult parseEntity(scala.collection.immutable.List<HttpHeader> headers,
 HttpProtocol protocol,
 org.apache.pekko.util.ByteString input,
 int bodyStart,
 scala.Option<Content$minusLength> clh,
 scala.Option<Content$minusType> cth,
 boolean isChunked,
 boolean expect100continue,
 boolean hostHeaderPresent,
 boolean closeAfterResponseCompletion,
 SSLSession sslSession)

initialHeaderBuffer

scala.collection.mutable.ListBuffer<HttpHeader> initialHeaderBuffer()

parseSessionBytes

Output parseSessionBytes(org.apache.pekko.stream.TLSProtocol.SessionBytes input)

parseBytes

Output parseBytes(org.apache.pekko.util.ByteString input)

doPull

Output doPull()

shouldComplete

boolean shouldComplete()

startNewMessage

HttpMessageParser.StateResult startNewMessage(org.apache.pekko.util.ByteString input,
 int offset)

parseProtocol

int parseProtocol(org.apache.pekko.util.ByteString input,
 int cursor)

parseHeaderLines

HttpMessageParser.StateResult parseHeaderLines(org.apache.pekko.util.ByteString input,
 int lineStart,
 scala.collection.mutable.ListBuffer<HttpHeader> headers,
 int headerCount,
 scala.Option<Connection> ch,
 scala.Option<Content$minusLength> clh,
 scala.Option<Content$minusType> cth,
 boolean isChunked,
 boolean e100c,
 boolean hh)

parseHeaderLinesAux

HttpMessageParser.StateResult parseHeaderLinesAux(scala.collection.mutable.ListBuffer<HttpHeader> headers,
 int headerCount,
 scala.Option<Connection> ch,
 scala.Option<Content$minusLength> clh,
 scala.Option<Content$minusType> cth,
 boolean isChunked,
 boolean e100c,
 boolean hh,
 org.apache.pekko.util.ByteString input,
 int lineStart)

parseFixedLengthBody

HttpMessageParser.StateResult parseFixedLengthBody(long remainingBodyBytes,
 boolean isLastMessage,
 org.apache.pekko.util.ByteString input,
 int bodyStart)

parseChunk

HttpMessageParser.StateResult parseChunk(org.apache.pekko.util.ByteString input,
 int offset,
 boolean isLastMessage,
 long totalBytesRead,
 int chunkCount)

emit

void emit(Output output)

failMessageStart

HttpMessageParser.StateResult failMessageStart(String summary)

failMessageStart

HttpMessageParser.StateResult failMessageStart(String summary,
 String detail)

failMessageStart

HttpMessageParser.StateResult failMessageStart(StatusCode status)

failMessageStart

HttpMessageParser.StateResult failMessageStart(StatusCode status,
 String summary,
 String detail)

failMessageStart

HttpMessageParser.StateResult failMessageStart(StatusCode status,
 ErrorInfo info)

failEntityStream

HttpMessageParser.StateResult failEntityStream(String summary)

failEntityStream

HttpMessageParser.StateResult failEntityStream(String summary,
 String detail)

failEntityStream

HttpMessageParser.StateResult failEntityStream(ErrorInfo info)

terminate

HttpMessageParser.StateResult terminate()

done

HttpMessageParser.StateResult done()

Use {@link continue} or terminate() to suspend or terminate processing. Do not call this directly.

Returns:

(undocumented)

contentType

ContentType contentType(scala.Option<Content$minusType> cth)

emptyEntity

ParserOutput.StrictEntityCreator<Output,UniversalEntity> emptyEntity(scala.Option<Content$minusType> cth)

strictEntity

ParserOutput.StrictEntityCreator<Output,UniversalEntity> strictEntity(scala.Option<Content$minusType> cth,
 org.apache.pekko.util.ByteString input,
 int bodyStart,
 int contentLength)

defaultEntity

<A extends ParserOutput>
ParserOutput.StreamedEntityCreator<A,UniversalEntity> defaultEntity(scala.Option<Content$minusType> cth,
 long contentLength)

chunkedEntity

<A extends ParserOutput>
ParserOutput.StreamedEntityCreator<A,RequestEntity> chunkedEntity(scala.Option<Content$minusType> cth)

setCompletionHandling

void setCompletionHandling(scala.Function0<scala.Option<ParserOutput.ErrorOutput>> completionHandling)