All Classes and Interfaces
Class
Description
Model for the `Accept` header.
Model for the `Accept-Charset` header.
Model for the `Accept-Encoding` header.
Model for the `Accept-Language` header.
Model for the `Accept-Ranges` header.
Model for the `Access-Control-Allow-Credentials` header.
Model for the `Access-Control-Allow-Headers` header.
Model for the `Access-Control-Allow-Methods` header.
Model for the `Access-Control-Allow-Origin` header.
Model for the `Access-Control-Expose-Headers` header.
Model for the `Access-Control-Max-Age` header.
Model for the `Access-Control-Request-Headers` header.
Model for the `Access-Control-Request-Method` header.
Model for the `Age` header.
Model for the `Allow` header.
ApplyConverter allows generic conversion of functions of type
(T1, T2,Rejection created by the various
pekko.http.javadsl.server.directives.SecurityDirectives.Rejection created by the various
pekko.http.scaladsl.server.directives.SecurityDirectives.Signals the cause of the failed authentication.
Signals the cause of the failed authentication.
Signals the cause of the rejecting was that the user could not be authenticated, because the
WWW-Authenticate
header was not supplied.Signals the cause of the rejecting was that the user could not be authenticated, because the
WWW-Authenticate
header was not supplied.Signals the cause of the rejecting was that the user could not be authenticated, because the supplied credentials
are invalid.
Signals the cause of the rejecting was that the user could not be authenticated, because the supplied credentials
are invalid.
Represents a hostname, port and user info.
Model for the `Authorization` header.
Rejection created by the 'authorize' directive.
Rejection created by the 'authorize' directive.
Rejection created by the 'authorize' directive.
Represents a WebSocket binary message.
Represents a WebSocket binary message.
A strict
BinaryMessage that contains the complete data as a pekko.util.ByteString.Allows the definition of binary poly-functions (e.g. for folding over tuples).
Marker-interface for entity types that can be used in a body part
INTERNAL API
INTERNAL API
INTERNAL API
Straight-forward Boyer-Moore string search implementation.
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
Used to specify the last
length bytes of an entity.INTERNAL API
INTERNAL API
ParserInput reading directly off a ByteString.
INTERNAL API
INTERNAL API
INTERNAL API
API MAY CHANGE
Model for the `Cache-Control` header.
https://tools.ietf.org/html/rfc8246
For a fuller description of the use case, see
http://tools.ietf.org/html/rfc7234#section-5.2.1.1 and
http://tools.ietf.org/html/rfc7234#section-5.2.2.8
For a fuller description of the use case, see
http://tools.ietf.org/html/rfc7234#section-5.2.2.7
For a fuller description of the use case, see
http://tools.ietf.org/html/rfc7234#section-5.2.2.9
INTERNAL API
INTERNAL API
Public API but not intended for subclassing
Public API but not intended for subclassing
INTERNAL API
INTERNAL API
Rejection created by the
onCompleteWithBreaker directive.Rejection created by the
onCompleteWithBreaker directive.A magnet that wraps a ClassTag
Public API but not intended for subclassing
Public API but not intended for subclassing
INTERNAL API
INTERNAL API
(Still unstable) SPI for implementors of custom client transports.
Abstraction to allow the creation of alternative transports to run HTTP on.
(Still unstable) entry point to create or access predefined client transports.
(Still unstable) entry point to create or access predefined client transports.
A coder is an implementation of the predefined encoders/decoders defined for HTTP.
Marker trait for A combined Encoder and Decoder
Stage similar to Sink.seq that provides a side-channel to get at the collection at any point.
State of the callback infrastructure
INTERNAL API
Deprecated.
Compressor is internal API and will be moved or removed in the future.
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
Model for the `Connection` header.
Public API but not intended for subclassing
Public API but not intended for subclassing
INTERNAL API
INTERNAL API
INTERNAL API
Constructor for instances of type
R which can be created from a tuple of type T.Document https://tools.ietf.org/html/rfc6266 updates document https://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html .
Model for the `Content-Disposition` header.
Model for the `Content-Encoding` header.
Model for the `Content-Length` header.
Model for the `ContentLocation` header.
Model for the `Content-Range` header.
Models a satisfiable HTTP content-range.
An
other-range-resp.An unsatisfiable content-range.
Represents an Http content-type.
Model for the `Content-Type` header.
A
ContentType represents a specific MediaType / HttpCharset combination.Represents a content-type which we know not to contain text (will never have a charset)
Represents a content-type which we know not to contain text (will never have have a charset)
Represents a content-type which we know to contain text, and has a specified charset.
Represents a content-type which we know to contain text, and has a specified charset.
Represents a content-type which we know to contain text, and the charset is known at runtime.
Represents a content-type which we know to contain text, and the charset is known at runtime.
Represents a content-type which we know to contain text, where the charset always has the same predefined value.
Represents a content-type which we know to contain text, where the charset always has the same predefined value.
Represents a content-type which we know to contain text, and would be better off having a charset,
but the client hasn't provided that.
Represents a content-type which we know to contain text, and would be better off having a charset,
but the client or server hasn't provided that.
A data structure that combines an acceptable media range and an acceptable charset range into one
structure to be used with unmarshalling.
Implement this interface to provide a custom mapping from a file name to a
[[org.apache.pekko.http.javadsl.model.ContentType]].
Contains the set of predefined content-types for convenience.
Model for the `Cookie` header.
The Coroner can be used to print a diagnostic report of the JVM state,
including stack traces and deadlocks.
Used to cancel the Coroner after calling
watch.The Coroner can be used to print a diagnostic report of the JVM state,
including stack traces and deadlocks.
INTERNAL API – used for consistency specs
Provides directives that implement the CORS mechanism, enabling cross origin requests.
Rejection created by the CORS directives.
Rejection created by the CORS directives.
Signals the cause of the failed CORS request.
Signals the cause of the failed CORS request.
Signals the CORS request was rejected because its headers were invalid.
Signals the CORS request was rejected because its headers were invalid.
Signals the CORS request was rejected because its method was invalid.
Signals the CORS request was rejected because its method was invalid.
Signals the CORS request was rejected because its origin was invalid.
Signals the CORS request was rejected because its origin was invalid.
Signals the CORS request was malformed.
Signals the CORS request was malformed.
Public API but not intended for subclassing
Settings used by the CORS directives.
INTERNAL API
Represents authentication credentials supplied with a request.
INTERNAL API
The model of an HTTP header.
Superclass for user-defined custom headers defined by implementing
name and value.To be extended by user-provided custom rejections, such that they may be consumed in either Java or Scala DSLs.
An abstraction to transform data bytes of HttpMessages or HttpEntities
Model for the `Date` header.
INTERNAL API
INTERNAL API
Immutable, fast and efficient Date + Time implementation without any dependencies.
Immutable, fast and efficient Date + Time implementation without any dependencies.
An adaption of TestEventListener that never prints debug logs itself.
INTERNAL API
INTERNAL API
Deprecated.
Actual implementation of Deflate is internal API, use Coders.Deflate instead.
Deprecated.
Actual implementation of Deflate is internal API, use Coders.Deflate instead.
Internal API
Internal API
Internal API
Internal API
A directive that provides a tuple of values of type
L to create an inner route.Adds helper functions to
Directive0"Standard" transformers for
Directive1.Collects all default directives into one class for simple importing of static functions.
Collects all default directives into one trait for simple importing.
Collects all default directives into one class for simple importing of static functions.
Collects all default directives into one object for simple importing.
An example App that runs a quick test against the websocket server at wss://echo.websocket.org
An example App that runs a quick test against the websocket server at wss://echo.websocket.org
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
Entity streaming support trait allowing rendering and receiving incoming
Entity streaming support trait allowing rendering and receiving incoming
Entity streaming support, independent of used Json parsing library etc.
Entity streaming support, independent of used Json parsing library etc.
This exception is thrown when the size of the HTTP Entity exceeds the configured limit.
Two-level model of error information.
Model for the `ETag` header.
Using
eventStreamMarshaller lets a source of ServerSentEvents be marshalled to a HttpResponse.Mixing in this trait lets a source of
ServerSentEvents be marshalled to a HttpEntity and hence as a
HttpResponse.Using
eventStreamMarshaller lets a source of ServerSentEvents be marshalled to a HttpResponse.Importing
EventStreamMarshalling.toEventStream lets a source of ServerSentEvents be marshalled to a
HttpEntity and hence as a HttpResponse.Flow that converts raw byte string input into
ServerSentEvents.Flow that converts raw byte string input into
ServerSentEvents.Using
fromEventsStream lets a HttpEntity with a text/event-stream media type be unmarshalled to a source of
ServerSentEvents.Mixing in this trait lets a
HttpEntity with a text/event-stream media type be unmarshalled to a source of
ServerSentEvents.Using
fromEventsStream lets a HttpEntity with a text/event-stream media type be unmarshalled to a source of
ServerSentEvents.Importing
EventStreamUnmarshalling.fromEventsStream lets an HttpEntity with a text/event-stream media type be
unmarshalled to a source of ServerSentEvents.These are HTTPS example configurations that take key material from the resources/key folder.
These are HTTPS example configurations that take key material from the resources/key folder.
Handles exceptions by turning them into routes.
Marker for exceptions that provide an ErrorInfo
Rejection created when a websocket request was expected but none was found.
Rejection created when a websocket request was expected but none was found.
Rejection created when a websocket request was expected but none was found.
Model for the `Expires` header.
INTERNAL API
Provides alternative implementations of the basic transformation operations defined on
Future,
which try to avoid scheduling to an ExecutionContext if possible, i.e. if the given future
value is already present.Directives that load files and resources.
Additional metadata about the file being uploaded/that was uploaded using the
FileUploadDirectivesAdditional metadata about the file being uploaded/that was uploaded using the
FileUploadDirectivesSimple model for `application/x-www-form-urlencoded` form data.
Simple model for
application/x-www-form-urlencoded form data.Frame data that was received after the start of the frame..
EXPERIMENTAL API
Allows the
MarshallingDirectives.entity directive to extract a pekko.stream.scaladsl.Source of elements.INTERNAL API
The low-level WebSocket framing model.
Representation of the wire-level HEADERS frame.
Convenience (logical) representation of a parsed HEADERS frame with zero, one or
many CONTINUATIONS Frames into a single, decompressed object.
Dummy event for all unknown frames
INTERNAL API
Streaming parser for the WebSocket framing protocol as defined in RFC6455
Streaming parser for the WebSocket framing protocol as defined in RFC6455
Renders FrameEvents to ByteString.
The frame handler validates frames, multiplexes data to the user handler or to the bypass and
UTF-8 decodes text frames.
The frame handler validates frames, multiplexes data to the user handler or to the bypass and
UTF-8 decodes text frames.
Model of the frame header
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
Implements the transport connection close handling at the end of the pipeline.
INTERNAL API
INTERNAL API
Starts a frame.
INTERNAL API
INTERNAL API
INTERNAL API: See detailed docs termination process on
Http.ServerBinding.Deprecated.
Actual implementation of Gzip is internal, use Coders.Gzip instead.
Deprecated.
Actual implementation of Gzip is internal API, use Coders.Gzip instead.
Internal API
Internal API
Internal API
INTERNAL API
INTERNAL API
A HandlerProvider can provide an asynchronous request handler given an ClassicActorSystemProvider.
Server-side implementation of the WebSocket handshake
Server-side implementation of the WebSocket handshake
Helper that creates strings that all share the same hashCode == 0.
Helper that creates strings that all share the same hashCode == 0.
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API.
INTERNAL API.
INTERNAL API.
Represents a host in a URI or a Host header.
Tests the host connection pool infrastructure.
Represents a connection pool to a specific target host and pool configuration.
INTERNAL API
Type used to carry meaningful information when server termination has completed successfully.
Represents one accepted incoming HTTP connection.
Represents a prospective outgoing HTTP connection.
Represents a prospective HTTP server binding.
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
Base class for HTTP2 exceptions.
INTERNAL API
INTERNAL API
INTERNAL API
Placeholder for any kind of internal settings that might be interesting for HTTP/2 (like custom strategies)
Placeholder for any kind of internal settings that might be interesting for HTTP/2 (like custom strategies)
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
CANCEL (0x8): Used by the endpoint to indicate that the stream is no
longer needed.
COMPRESSION_ERROR (0x9): The endpoint is unable to maintain the
header compression context for the connection.
CONNECT_ERROR (0xa): The connection established in response to a
CONNECT request (Section 8.3) was reset or abnormally closed.
ENHANCE_YOUR_CALM (0xb): The endpoint detected that its peer is
exhibiting a behavior that might be generating excessive load.
FLOW_CONTROL_ERROR (0x3): The endpoint detected that its peer
violated the flow-control protocol.
FRAME_SIZE_ERROR (0x6): The endpoint received a frame with an
invalid size.
HTTP_1_1_REQUIRED (0xd): The endpoint requires that HTTP/1.1 be used
instead of HTTP/2.
INADEQUATE_SECURITY (0xc): The underlying transport has properties
that do not meet minimum security requirements (see Section 9.2).
INTERNAL_ERROR (0x2): The endpoint encountered an unexpected
internal error.
NO_ERROR (0x0): The associated condition is not a result of an
error.
PROTOCOL_ERROR (0x1): The endpoint detected an unspecific protocol
error.
REFUSED_STREAM (0x7): The endpoint refused the stream prior to
performing any application processing (see Section 8.1.4 for
details).
SETTINGS_TIMEOUT (0x4): The endpoint sent a SETTINGS frame but did
not receive a response in a timely manner.
STREAM_CLOSED (0x5): The endpoint received a frame after a stream
was half-closed.
SETTINGS_ENABLE_PUSH (0x2): This setting can be used to disable
server push (Section 8.2).
SETTINGS_HEADER_TABLE_SIZE (0x1): Allows the sender to inform the
remote endpoint of the maximum size of the header compression
table used to decode header blocks, in octets.
SETTINGS_INITIAL_WINDOW_SIZE (0x4): Indicates the sender's initial
window size (in octets) for stream-level flow control.
SETTINGS_MAX_CONCURRENT_STREAMS (0x3): Indicates the maximum number
of concurrent streams that the sender will allow.
SETTINGS_MAX_FRAME_SIZE (0x5): Indicates the size of the largest
frame payload that the sender is willing to receive, in octets.
SETTINGS_MAX_HEADER_LIST_SIZE (0x6): This advisory setting informs a
peer of the maximum size of header list that the sender is
prepared to accept, in octets.
INTERNAL API
INTERNAL API
Internal API
Internal API
INTERNAL API
Special state that allows collecting some incoming data before dispatching it either as strict or streamed entity
We have closed the outgoing stream, but the incoming stream is still going.
They have closed the incoming stream, but the outgoing stream is still going.
States roughly correspond to states as given in https://http2.github.io/http2-spec/#StreamStates.
Represents one direction of an Http2 substream.
Deprecated.
HttpApp this doesn't reflect the latest APIs, since Akka HTTP 10.2.0
Deprecated.
HttpApp this doesn't reflect the latest APIs.
INTERNAL API
Internally used attributes set in the HTTP pipeline.
INTERNAL API
Internally used TLS session info in the HTTP pipeline.
INTERNAL API
Internally used attributes set in the HTTP pipeline.
Note: the token of challenge is stored in the params Map as a parameter whose name is empty String("") for binary
compatibility, but it will be parsed and rendered correctly.
Represents a charset in Http.
Represents an Http charset range.
A charset range as encountered in
Accept-Charset.Contains constructors to create a HttpCharsetRange.
Contains a set of predefined charsets.
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
for a full definition of the http cookie header fields, see
http://tools.ietf.org/html/rfc6265
Represents a cookie pair as used in the `Cookie` header as specified in
http://tools.ietf.org/search/rfc6265#section-4.2.1
for a full definition of the http cookie header fields, see
http://tools.ietf.org/html/rfc6265
This class is sealed abstract to prevent generation of default apply method in companion
Constructors for HttpEntity instances
Represents the entity of an Http message.
Models the entity (aka "body" or "content") of an HTTP message.
An intermediate entity chunk guaranteed to carry non-empty data.
Represents an entity transferred using `Transfer-Encoding: chunked`.
The model for the entity of a chunked HTTP message (with
Transfer-Encoding: chunked).A part of a stream of incoming data for `Transfer-Encoding: chunked` messages.
An element of the HttpEntity data stream.
Represents an entity without a predetermined content-length.
The model for the entity of an HTTP response that is terminated by the server closing the connection.
The default entity type which has a predetermined length and a stream of data bytes.
The model for the entity of a "regular" unchunked HTTP message with a known non-zero length.
Represents the currently being-drained HTTP Entity which triggers completion of the contained
Future once the entity has been drained for the given HttpMessage completely.
Represents the currently being-drained HTTP Entity which triggers completion of the contained
Future once the entity has been drained for the given HttpMessage completely.
Adds Scala DSL idiomatic methods to
HttpEntity, e.g. versions of methods with an implicit Materializer.Represents an entity without a predetermined content-length to use in a BodyParts.
The model for the entity of a BodyPart with an indefinite length.
The final chunk of a chunk stream.
The entity type which consists of a predefined fixed ByteString of data.
The model for the entity of a "regular" unchunked HTTP message with known, fixed data.
Supertype of CloseDelimited and IndefiniteLength.
Pekko extension for HTTP which serves as the main entry point into pekko-http.
The base type representing Http headers.
The model of an HTTP header.
The parsing run failed due to a fatal parsing error.
The parsing run produced a result.
INTERNAL API
INTERNAL API
INTERNAL API
The base type for an Http message (request or response).
Common base class of HttpRequest and HttpResponse.
Represents the currently being-drained HTTP Entity which triggers completion of the contained
Future once the entity has been drained for the given HttpMessage completely.
Represents the currently being-drained HTTP Entity which triggers completion of the contained
Future once the entity has been drained for the given HttpMessage completely.
Adds Scala DSL idiomatic methods to
HttpMessage, e.g. versions of methods with an implicit Materializer.INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
Represents an HTTP request method.
The method of an HTTP request.
Contains static constants for predefined method types.
Integration test for external HTTP libraries that are built on top of
Pekko HTTP core.
HttpOrigin matcher.
Represents an Http protocol (currently only HTTP/1.0 or HTTP/1.1).
The protocol of an HTTP message
Contains constants of the supported Http protocols.
Represents an Http request.
The immutable model HTTP request model.
INTERNAL API
INTERNAL API
Represents an Http response.
The immutable HTTP response model.
INTERNAL API
param: requestMethod the request's HTTP method
param: oneHundredContinueTrigger if the request contains an
Expect: 100-continue header this option contains
a promise whose completion either triggers the sending of the (suspended)
request entity or the closing of the connection (for error completion)INTERNAL API
Context with all information needed to set up a HTTPS connection
INTERNAL API
Two state stage, either transforms an incoming RequestOutput into a HttpRequest with strict entity and then pushes
that (the "idle" inHandler) or creates a HttpRequest with a streamed entity and switch to a state which will push
incoming chunks into the streaming entity until end of request is reached (the StreamedEntityCreator case in create
entity).
INTERNAL API
Tests similar to HttpServerSpec that need ExplicitlyTriggeredScheduler
INTERNAL API
INTERNAL API
Public API but not intended for subclassing
Public API but not intended for subclassing
INTERNAL API
Type used to carry meaningful information when server termination has completed successfully.
Model for the `If-Match` header.
Model for the `If-Modified-Since` header.
Model for the `If-None-Match` header.
Model for the `If-Unmodified-Since` header.
Represents one accepted incoming HTTP connection.
INTERNAL API
INTERNAL API
Internal API
Rejection created by
pekko.http.scaladsl.server.directives.HeaderDirectives.checkSameOrigin.Rejection created by
pekko.http.scaladsl.server.directives.HeaderDirectives.checkSameOrigin.Rejection created by parameter filters.
Rejection created by parameter filters.
INTERNAL API
INTERNAL API
A JSON marshaller/unmarshaller using the Jackson library.
A JSON marshaller/unmarshaller using the Jackson library.
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
Internal Pekko HTTP API
Internal Pekko HTTP API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
A RouteTest that uses JUnit assertions.
The Last-Event-ID header is sent by a client to the server to signal the ID of the last
sever-sent event received.
Model for the `Last-Modified` header.
INTERNAL API
INTERNAL API
Public API but not intended for subclassing
Public API but not intended for subclassing
INTERNAL API
INTERNAL API
INTERNAL API
Model for the `Link` header.
For a more detailed breakdown of the anchor link parameter, see
http://tools.ietf.org/html/rfc5988#section-5.2
For a more detailed breakdown of the dereferenced language hint link parameter
http://tools.ietf.org/html/rfc5988#section-5.4
For a more detailed breakdown of how to use the dereferenced language hint link parameter, see
http://tools.ietf.org/html/rfc5988#section-5.4
This can be either a bare word, an absolute URI, or a quoted, space-separated string of zero-or-more of either
This can be either a bare word, an absolute URI, or a quoted, space-separated string of zero-or-more of either.
For a more detailed breakdown of how to use the dereferenced language hint link parameter, see
http://tools.ietf.org/html/rfc5988#section-5.4
For a more detailed breakdown of how to use the dereferenced language hint link parameter, see
http://tools.ietf.org/html/rfc5988#section-5.4
For a more detailed breakdown of how to use the dereferenced language hint link parameter, see
http://tools.ietf.org/html/rfc5988#section-5.4
Model for the `Location` header.
INTERNAL API
INTERNAL API
Internal API
Rejection created by form field filters.
Rejection created by form field filters.
Rejection created by header directives.
Rejection created by header directives.
Rejection created by parameter filters.
Rejection created by parameter filters.
Rejection created by unmarshallers.
Rejection created by unmarshallers.
Describes one possible option for marshalling a given value.
A Marshalling to an unknown MediaType and charset.
A Marshalling to a specific
pekko.http.scaladsl.model.ContentType.A Marshalling to a specific
pekko.http.scaladsl.model.MediaType with a flexible charset.Implements WebSocket Frame masking.
Implements WebSocket Frame masking.
INTERNAL API: Collects signals from per-connection terminators and manages the termination process kickoff
INTERNAL API
Represents an Http media-range.
Contains a set of predefined media-ranges and static methods to create custom ones.
A MediaType describes the type of the content of an HTTP message entity.
Represents an Http media-type.
Contains the set of predefined media-types.
Represents a WebSocket message.
The ADT for WebSocket messages.
INTERNAL API
Renders messages to full frames.
Renders messages to full frames.
Rejection created by method filters.
Rejection created by method filters.
Rejection created by attribute directives.
Rejection created by attribute directives.
Rejection created by the
cookie directive.Rejection created by the
cookie directive.Rejection created by form field filters.
Rejection created by form field filters.
Rejection created by header directives.
Rejection created by header directives.
Rejection created by parameter filters.
Rejection created by parameter filters.
INTERNAL API
Support class for building user-defined custom headers defined by implementing `name` and
`value`.
Support class for building user-defined custom headers defined by implementing
name and value.To be extended by companion object of a custom header extending
ModeledCustomHeader.Companion class for the
ModeledCustomHeader class.The model of multipart content for media-types `multipart/\*` (general multipart content),
`multipart/form-data` and `multipart/byteranges`.
The model of multipart content for media-types
multipart/\* (general multipart content),
multipart/form-data and multipart/byteranges.The general model for a single part of a multipart message.
A
Multipart.BodyPart whose entity has already been loaded in its entirety and is therefore
full and readily available as a HttpEntity.Strict.Model for `multipart/byteranges` content as defined by
https://tools.ietf.org/html/rfc7233#section-5.4.1 and
https://tools.ietf.org/html/rfc7233#appendix-A
Model for
multipart/byteranges content as defined by
https://tools.ietf.org/html/rfc7233#section-5.4.1 and https://tools.ietf.org/html/rfc7233#appendix-ABody part of the
Multipart.ByteRanges model.Strict
ByteRanges.BodyPart.Strict
ByteRanges.Model for `multipart/form-data` content as defined in http://tools.ietf.org/html/rfc2388.
Model for
multipart/form-data content as defined in http://tools.ietf.org/html/rfc2388.Body part of the
Multipart.FormData model.INTERNAL API
Strict
FormData.BodyPart.INTERNAL API
Strict
FormData.Basic model for multipart content as defined by http://tools.ietf.org/html/rfc2046.
Basic model for general multipart content as defined by http://tools.ietf.org/html/rfc2046.
Body part of the
Multipart.General model.Strict
General.BodyPart.Strict
General multipart content.A type of multipart content for which all parts have already been loaded into memory
and are therefore allow random access.
Constructors for Multipart instances
Provides
pekko.http.scaladsl.model.Multipart marshallers.Internal API
Internal API
Deprecated.
Actual implementation of NoCoding is internal API, use Coders.NoCoding instead.
Deprecated.
Actual implementation of NoCoding is internal API, use Coders.NoCoding instead.
Internal API
Internal API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
Model for the `Origin` header.
INTERNAL API
This is essentially a three state state machine, it is either 'idle' - waiting for a response to come in
or has seen the start of a response and is waiting for either chunks followed by MessageEnd if chunked
or just MessageEnd in the case of a strict response.
A merge that follows this logic:
1.
INTERNAL API
Builder for setting up a flow that will create one single connection per materialization to the specified host.
Builder for setting up a flow that will create one single connection per materialization to the specified host.
INTERNAL API
INTERNAL API
A wrapper for an SSE line which exceeds the configured limit.
Strategy for handling oversized SSE messages that exceed the configured max-line-size.
INTERNAL API
An entity creator that creates the entity from the a source of parts.
An entity creator that uses the given entity directly and ignores the passed-in source.
INTERNAL API
Public API but not intended for subclassing
Public API but not intended for subclassing
INTERNAL API
INTERNAL API
Contains helpful methods to partially apply Functions for Java
Contains helpful methods to partially apply Functions for Java
Only path prefixes are matched by these methods, since any kind of chaining path extractions
in Java would just look cumbersome without operator overloads; hence, no PathMatcher for Java.
INTERNAL API
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatcher.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance
if matched, otherwise PathMatchers.Unmatched.
A PathMatcher that matches a single slash character ('/').
A PeerClosedConnectionException will be reported to the WebSocket handler if the peer has closed the connection.
A PeerClosedConnectionException will be reported to the WebSocket handler if the peer has closed the connection.
Exception that will be reported on the request entity stream when the peer closed the stream.
INTERNAL API
INTERNAL API
Internal API
Internal API
Represents a pool by its target endpoint and settings and its designated usage (shared or unique).
The pool interface is a push style interface to a pool of connections against a single host.
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
Contains WebSocket protocol constants
Close status codes as defined at http://tools.ietf.org/html/rfc6455#section-7.4.1
Contains WebSocket protocol constants
INTERNAL API
INTERNAL API
INTERNAL API
Model for the `Proxy-Authenticate` header.
Model for the `Proxy-Authorization` header.
INTERNAL API
INTERNAL API
A factory that creates SecureRandom instances
INTERNAL API
Model for the `Range` header.
A header in its 'raw' name/value form, not parsed into a modelled header class.
Model for the `Raw-Request-URI` header.
Model for the `Referer` header.
A rejection encapsulates a specific reason why a Route was not able to handle a request.
A rejection encapsulates a specific reason why a Route was not able to handle a request.
A Throwable wrapping a Rejection.
A Throwable wrapping a Rejection.
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
This class is not meant to be extended by user code.
INTERNAL API
Marker-interface for entity types that can be used in a request
An
HttpEntity that can be used for requests.Rejection created by unmarshallers.
Rejection created by unmarshallers.
Rejection created by unmarshallers.
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
A marker trait for attribute values that should be (automatically) carried over from request to response.
A marker trait for attribute values that should be (automatically) carried over from request to response.
Marker-interface for entity types that can be used in a response
An
HttpEntity that can be used for responses.An association for completing a future when the response arrives.
An association for completing a future when the response arrives.
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
Model for the `Retry-After` header.
Defines different values admitted to define a {@link <code>Retry-After</code>} header.
In the Java DSL, a Route can only consist of combinations of the built-in directives.
INTERNAL API
The result of handling a request.
A base class to create route tests for testing libraries.
A receptacle for the response or rejections created by a route.
INTERNAL API
INTERNAL API
Public API but not intended for subclassing
Public API but not intended for subclassing
INTERNAL API
INTERNAL API
INTERNAL API
The Cookie SameSite attribute as defined by RFC6265bis and Incrementally Better
Cookies.
The Cookie SameSite attribute as defined by RFC6265bis
and Incrementally Better Cookies.
Rejection created by scheme filters.
Rejection created by scheme filters.
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
Provides directives for securing an inner route using the standard Http authentication headers {@link <code>WWW-Authenticate</code>}
and
Authorization.Represents HTTP Basic or OAuth2 authentication credentials supplied with a request.
Model for the `Sec-WebSocket-Protocol` header.
Marker trait for headers which contain portentially secret / sensitive information.
Model for the `Server` header.
Represents a prospective HTTP server binding.
Builder API to create server bindings.
Builder API to create server bindings.
Internal API
Representation of a server-sent event.
INTERNAL API
Public API but not intended for subclassing
Public API but not intended for subclassing
Public API but not intended for subclassing
Public API but not intended for subclassing
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API: Used to start the termination process of a Pekko HTTP server.
Model for the `Set-Cookie` header.
INTERNAL API
INTERNAL API
An adaption of TestEventListener that does not print out any logs.
INTERNAL API.
A simple value holder class implementing RequestResponseAssociation.
INTERNAL API
INTERNAL API
Internal API
Internal API
INTERNAL API
INTERNAL API
INTERNAL API
Entity streaming support, implemented using spray-json.
Entity streaming support, implemented using spray-json.
A trait providing automatic to and from JSON marshalling/unmarshalling using an in-scope *spray-json* protocol.
INTERNAL API
A Route that can be implicitly converted into a Directive (fitting any signature).
Represents an Http status-code and message.
The result status code of an HTTP response.
Contains the set of predefined status-codes along with static methods to access and create custom
status-codes.
Deprecated.
StreamDecoder is internal API and will be moved or removed in the future.
INTERNAL API
A prioritizer that ignores priority information and just sends to the first stream
INTERNAL API
INTERNAL API
Similar to Source.maybe but doesn't rely on materialization.
INTERNAL API
Read-only abstraction on top of
application/x-www-form-urlencoded and multipart form data,
allowing joint unmarshalling access to either kind, **if** you supply both, a pekko.http.scaladsl.unmarshalling.FromStringUnmarshaller
as well as a pekko.http.scaladsl.unmarshalling.FromEntityUnmarshaller for the target type T.Simple model for strict file content in a multipart form data part.
Model for the `Strict-Transport-Security` header.
Not for user extension
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
Model for the `Transfer-Encoding` header.
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
A wrapped route that has a
run method to run a request through the underlying route to create
a TestResponse.A wrapper for route results.
Represents a WebSocket text message.
Represents a WebSocket text message.
A strict
TextMessage that contains the complete data as a String.Model for the synthetic `Timeout-Access` header.
Enables programmatic access to the server-side request timeout logic.
Enables programmatic access to the server-side request timeout logic.
INTERNAL API
Model for the synthetic
Tls-Session-Info header which carries the SSLSession of the connection
the message carrying this header was received with.Model for the synthetic `Tls-Session-Info` header which carries the SSLSession of the connection
the message carrying this header was received with.
Rejection created by range directives.
Rejection created by range directives.
Something that can later be marshalled into a response
INTERNAL API
The `Trailer` header is used before a message body to indicate which fields will be present in
the trailers when using chunked transfer encoding.
Trailing headers for HTTP/2 responses
Model for the `Transfer-Encoding` header.
A special Rejection that serves as a container for a transformation function on rejections.
A special Rejection that serves as a container for a transformation function on rejections.
Phantom type providing implicit evidence that a given type is a Tuple or Unit.
Provides a way to convert a value into an Tuple.
Rejection created by marshallers.
Rejection created by marshallers.
Rejection created by encoding filters.
Rejection created by encoding filters.
Marker-interface for entity types that can be used in any context
An unmarshaller transforms values of type A into type B.
Order of parameters (`right` first, `left` second) is intentional, since that's the order we evaluate them in.
Signals that unmarshalling failed because the entity was unexpectedly empty.
Signals that unmarshalling failed because the entity content-type did not match one of the supported ranges.
Rejection created by range directives.
Rejection created by range directives.
Rejection created by unmarshallers.
Rejection created by unmarshallers.
Rejection created by decoding filters.
Rejection created by decoding filters.
Rejection created when a websocket request was not handled because none of the given subprotocols
was supported.
Rejection created when a websocket request was not handled because none of the given subprotocols
was supported.
Internal API
Currently internal API to handle FrameEvents directly.
Represents an Uri.
An immutable model of an internet URI as defined by https://tools.ietf.org/html/rfc3986.
param: port A port number that may be
0 to signal the default port of for scheme.INTERNAL API.
INTERNAL API.
INTERNAL API
Model for the `User-Agent` header.
A Utf8 -> Utf16 (= Java char) decoder.
A Utf8 -> Utf16 (= Java char) decoder.
A utf16 (= Java char) to utf8 encoder.
A utf16 (= Java char) to utf8 encoder.
Contains internal helper methods.
Rejection created by the
validation directive as well as for IllegalArgumentExceptions
thrown by domain model constructors (e.g. via require).Rejection created by the
validation directive as well as for IllegalArgumentExceptions
thrown by domain model constructors (e.g. via require).INTERNAL API
Mixin for tests that should be watched by the Coroner.
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
A websocket extension as defined in http://tools.ietf.org/html/rfc6455#section-4.3
Represents a WebSocket request.
Represents a WebSocket request.
Public API but not intended for subclassing
INTERNAL API
INTERNAL API
An attribute that WebSocket requests will contain.
An attribute that will be added to an WebSocket upgrade HttpRequest that
enables a request handler to upgrade this connection to a WebSocket connection and
registers a WebSocket handler.
Represents an upgrade response for a WebSocket upgrade request.
Represents the response to a websocket upgrade request.
Mixin this trait to a test to make log lines appear only when the test failed.
Helper trait for objects that allow creating new instances with a modified qValue.
A WSProbe is a probe that implements a
Flow[Message, Message, Unit] for testing
websocket code.A WSProbe is a probe that implements a
Flow[Message, Message, Unit] for testing
websocket code.Model for the `WWW-Authenticate` header.
Model for the `X-Forwarded-For` header.
Model for the `X-Forwarded-Host` header.
Model for the `X-Forwarded-Proto` header.
Model for the `X-Real-Ip` header.