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
49 lines
2.5 KiB
ReStructuredText
49 lines
2.5 KiB
ReStructuredText
.. _-withRequestTimeout-:
|
||
|
||
withRequestTimeout
|
||
==================
|
||
|
||
Signature
|
||
---------
|
||
|
||
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/TimeoutDirectives.scala
|
||
:snippet: withRequestTimeout
|
||
|
||
Description
|
||
-----------
|
||
|
||
This directive enables "late" (during request processing) control over the :ref:`request-timeout-scala` feature in Akka HTTP.
|
||
|
||
The timeout can be either loosened or made more tight using this directive, however one should be aware that it is
|
||
inherently racy (which may especially show with very tight timeouts) since a timeout may already have been triggered
|
||
when this directive executes.
|
||
|
||
In case of pipelined HTTP requests (multiple requests being accepted on the same connection before sending the first response)
|
||
a the request timeout failure of the ``n-th`` request *will shut down the connection* causing the already enqueued requests
|
||
to be dropped. This is by-design, as the request timeout feature serves as a "safety net" in case of programming errors
|
||
(e.g. a Future that never completes thus potentially blocking the entire connection forever) or malicious attacks on the server.
|
||
|
||
Optionally, a timeout handler may be provided in which is called when a time-out is triggered and must produce an
|
||
``HttpResponse`` that will be sent back to the client instead of the "too late" response (in case it'd ever arrive).
|
||
See also :ref:`-withRequestTimeoutResponse-` if only looking to customise the timeout response without changing the timeout itself.
|
||
|
||
.. warning::
|
||
Please note that setting the timeout from within a directive is inherently racy (as the "point in time from which
|
||
we're measuring the timeout" is already in the past (the moment we started handling the request), so if the existing
|
||
timeout already was triggered before your directive had the chance to change it, an timeout may still be logged.
|
||
|
||
It is recommended to use a larger statically configured timeout (think of it as a "safety net" against programming errors
|
||
or malicious attackers) and if needed tighten it using the directives – not the other way around.
|
||
|
||
For more information about various timeouts in Akka HTTP see :ref:`http-timeouts-scala`.
|
||
|
||
Example
|
||
-------
|
||
|
||
.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/TimeoutDirectivesExamplesSpec.scala
|
||
:snippet: withRequestTimeout-plain
|
||
|
||
With setting the handler at the same time:
|
||
|
||
.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/TimeoutDirectivesExamplesSpec.scala
|
||
:snippet: withRequestTimeout-with-handler
|