29029be31d
* !htt #18919 #19519 Align Java HTTP server DSL with Scala This commits replaces the Java HTTP server DSL with a Java-8 centric one which exposes all scala DSL concepts to be usable from Java, including custom directives, (un)marshallers, rejections, headers, and type safety for path and query parameters. * Add RequestContext and RouteResult to Java DSL fix websockets WIP bring java docs up to date. This applies some updates to the root-level documentation * [htp] Fix java documentation to correctly mention timeouts Timeouts are configured the same in Java and Scala. Hence, linking to the scala docs for timeouts from Java. * =htc fix optionalHeaderValueByType in Java * =htt #20200 fix java testkit always using NoLogging instead logger * +htt actually run new javadsl tests, allow overriding config * =htt improve javadsl test infra with more details when fails * =htt fix bug in wrong path matcher exposed * +htp add missing remaining path matcher * =htp Java DSL cookie tests fixed * =htt Java DSL ParameterDirectivesTest fixed Protect the tweets from scalariform Incorrect response expectations in cache condition directives spec fixed * =htt Path directives for Java DSL * +!htt PathMatchers rewritten, made uniform and tests passing * Bugfix in java reject and a little test-boyscouting * Revert "Incorrect response expectations in cache condition directives spec fixed" This reverts commit cd50e89d45db010309f8249b090ea654ebb11c7a. * +htc HttpAPIsTest is compile time only, not for running Also, moved from the client package since not strictly a client test. SecurityDirectives passing Two faulty tests and two actual bugs. Fix for cache condition spec not working * Not sending in Unit instad of the implicit magnet in the test * HeaderMagnet now works as expected * Java API added for - and + on DateTime PetStore example and test fixed * Annotations to make marshalling work without default constructor * Made model class immutable Incorrect tests fixed Some scaladoc boyscouting as bonus * =htt RequestValTest sprinkled out across multiple directive tests Client ip extraction test with incorrect header name fixed. * =htt Incorrect CodingDirectivesTest fixed. * =htt Bugfix for Java Unmarshaller.firstOf and fixes to JavaRouteTest * =htt MarshallerTest fixed * Missing seal signature added to JavaDSL * More consistent (with Scala) test kit setup for Java * missing Javadocs added * Thread.sleep in default exception handler removed * =htt copy directive docs, prepare for finishing it up * +htt SecurityDirectives.authorize variants and test coverage added * +htt Custom headers in Java DSL * =htt WIP on java docs * +htp add missing parameterOrDefault directive Fixed a lot of doc warnings * =htc intense progress on javadsl docs * =htc #20470 Link to issue about docs and fix compile error compile, migration guide don't mima check http-experimental * =htt Java DSL doc warnings fixed. Only `Could not lex literal_block` ones left now * =htc fix mima settings * =doc fix MethodDirectives doc test with custom method * =htc fix coding directives spec after bad merge * =htc fix concat being corresponding to route() in javadsl * =htt Disable consistency check for route/concat as it fails only on ci server * !htt Minor fixes to PathMatchers
76 lines
3.2 KiB
ReStructuredText
76 lines
3.2 KiB
ReStructuredText
.. _http-timeouts-scala:
|
|
|
|
Akka HTTP Timeouts
|
|
==================
|
|
|
|
Akka HTTP comes with a variety of built-in timeout mechanisms to protect your servers from malicious attacks or
|
|
programming mistakes. Some of these are simply configuration options (which may be overriden in code) while others
|
|
are left to the streaming APIs and are easily implementable as patterns in user-code directly.
|
|
|
|
Common timeouts
|
|
---------------
|
|
|
|
Idle timeouts
|
|
^^^^^^^^^^^^^
|
|
|
|
The ``idle-timeout`` is a global setting which sets the maximum inactivity time of a given connection.
|
|
In other words, if a connection is open but no request/response is being written to it for over ``idle-timeout`` time,
|
|
the connection will be automatically closed.
|
|
|
|
The setting works the same way for all connections, be it server-side or client-side, and it's configurable
|
|
independently for each of those using the following keys::
|
|
|
|
akka.http.server.idle-timeout
|
|
akka.http.client.idle-timeout
|
|
akka.http.http-connection-pool.idle-timeout
|
|
akka.http.http-connection-pool.client.idle-timeout
|
|
|
|
.. note::
|
|
For the connection pooled client side the idle period is counted only when the pool has no pending requests waiting.
|
|
|
|
|
|
Server timeouts
|
|
---------------
|
|
|
|
.. _request-timeout-scala:
|
|
|
|
Request timeout
|
|
^^^^^^^^^^^^^^^
|
|
|
|
Request timeouts are a mechanism that limits the maximum time it may take to produce an ``HttpResponse`` from a route.
|
|
If that deadline is not met the server will automatically inject a Service Unavailable HTTP response and close the connection
|
|
to prevent it from leaking and staying around indefinitely (for example if by programming error a Future would never complete,
|
|
never sending the real response otherwise).
|
|
|
|
The default ``HttpResponse`` that is written when a request timeout is exceeded looks like this:
|
|
|
|
.. includecode2:: /../../akka-http-core/src/main/scala/akka/http/impl/engine/server/HttpServerBluePrint.scala
|
|
:snippet: default-request-timeout-httpresponse
|
|
|
|
A default request timeout is applied globally to all routes and can be configured using the
|
|
``akka.http.server.request-timeout`` setting (which defaults to 20 seconds).
|
|
|
|
.. note::
|
|
Please note that if multiple requests (``R1,R2,R3,...``) were sent by a client (see "HTTP pipelining")
|
|
using the same connection and the ``n-th`` request triggers a request timeout the server will reply with an Http Response
|
|
and close the connection, leaving the ``(n+1)-th`` (and subsequent requests on the same connection) unhandled.
|
|
|
|
The request timeout can be configured at run-time for a given route using the any of the :ref:`TimeoutDirectives`.
|
|
|
|
Bind timeout
|
|
^^^^^^^^^^^^
|
|
|
|
The bind timeout is the time period within which the TCP binding process must be completed (using any of the ``Http().bind*`` methods).
|
|
It can be configured using the ``akka.http.server.bind-timeout`` setting.
|
|
|
|
Client timeouts
|
|
---------------
|
|
|
|
Connecting timeout
|
|
^^^^^^^^^^^^^^^^^^
|
|
|
|
The connecting timeout is the time period within which the TCP connecting process must be completed.
|
|
Tweaking it should rarely be required, but it allows erroring out the connection in case a connection
|
|
is unable to be established for a given amount of time.
|
|
|
|
it can be configured using the ``akka.http.client.connecting-timeout`` setting.
|