Package akka.http.javadsl.server.directives

Class TimeoutDirectives

java.lang.Object

akka.http.javadsl.server.directives.BasicDirectives

akka.http.javadsl.server.directives.CacheConditionDirectives

akka.http.javadsl.server.directives.CodingDirectives

akka.http.javadsl.server.directives.CookieDirectives

akka.http.javadsl.server.directives.DebuggingDirectives

akka.http.javadsl.server.directives.ExecutionDirectives

akka.http.javadsl.server.directives.FileAndResourceDirectives

akka.http.javadsl.server.directives.FileUploadDirectives

akka.http.javadsl.server.directives.FormFieldDirectives

akka.http.javadsl.server.directives.FutureDirectives

akka.http.javadsl.server.directives.HeaderDirectives

akka.http.javadsl.server.directives.AttributeDirectives

akka.http.javadsl.server.directives.HostDirectives

akka.http.javadsl.server.directives.MarshallingDirectives

akka.http.javadsl.server.directives.MethodDirectives

akka.http.javadsl.server.directives.MiscDirectives

akka.http.javadsl.server.directives.ParameterDirectives

akka.http.javadsl.server.directives.PathDirectives

akka.http.javadsl.server.directives.RangeDirectives

akka.http.javadsl.server.directives.RespondWithDirectives

akka.http.javadsl.server.directives.RouteDirectives

akka.http.javadsl.server.directives.SchemeDirectives

akka.http.javadsl.server.directives.SecurityDirectives

akka.http.javadsl.server.directives.WebSocketDirectives

akka.http.javadsl.server.directives.TimeoutDirectives

Direct Known Subclasses:

FramedEntityStreamingDirectives

public abstract class TimeoutDirectives
extends WebSocketDirectives

Nested Class Summary

Nested classes/interfaces inherited from class akka.http.javadsl.server.directives.SecurityDirectives

SecurityDirectives.ProvidedCredentials, SecurityDirectives.ProvidedCredentials$

Constructor Summary

Constructors

Constructor	Description
TimeoutDirectives()

Method Summary

Modifier and Type	Method	Description
RouteAdapter	extractRequestTimeout(java.util.function.Function<scala.concurrent.duration.Duration,Route> inner)
RouteAdapter	withoutRequestTimeout(java.util.function.Supplier<Route> inner)
RouteAdapter	withRequestTimeout(scala.concurrent.duration.Duration timeout, java.util.function.Function<HttpRequest,HttpResponse> timeoutHandler, java.util.function.Supplier<Route> inner)	Tries to set a new request timeout and handler (if provided) at the same time.
RouteAdapter	withRequestTimeout(scala.concurrent.duration.Duration timeout, java.util.function.Supplier<Route> inner)	Tries to set a new request timeout and handler (if provided) at the same time.
RouteAdapter	withRequestTimeoutResponse(java.util.function.Function<HttpRequest,HttpResponse> timeoutHandler, java.util.function.Supplier<Route> inner)	Tries to set a new request timeout handler, which produces the timeout response for a given request.

Methods inherited from class akka.http.javadsl.server.directives.WebSocketDirectives

extractOfferedWsProtocols, extractUpgradeToWebSocket, extractWebSocketUpgrade, handleWebSocketMessages, handleWebSocketMessagesForOptionalProtocol, handleWebSocketMessagesForProtocol

Methods inherited from class akka.http.javadsl.server.directives.SecurityDirectives

authenticateBasic, authenticateBasicAsync, authenticateBasicAsyncOptional, authenticateBasicOptional, authenticateBasicPF, authenticateBasicPFAsync, authenticateOAuth2, authenticateOAuth2Async, authenticateOAuth2AsyncOptional, authenticateOAuth2Optional, authenticateOrRejectWithChallenge, authenticateOrRejectWithChallenge, authorize, authorizeAsync, authorizeAsyncWithRequestContext, authorizeWithRequestContext, extractCredentials

Methods inherited from class akka.http.javadsl.server.directives.SchemeDirectives

extractScheme, scheme

Methods inherited from class akka.http.javadsl.server.directives.RouteDirectives

complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, complete, completeOK, completeOKWithFuture, completeOKWithFuture, completeOKWithFuture, completeOKWithFutureString, completeOKWithFutureString, completeWithFuture, completeWithFuture, completeWithFuture, completeWithFutureResponse, completeWithFutureStatus, completeWithFutureStatus, concat, concat, failWith, handle, handleSync, redirect, reject, reject, reject, route, route

Methods inherited from class akka.http.javadsl.server.directives.RespondWithDirectives

respondWithDefaultHeader, respondWithDefaultHeaders, respondWithHeader, respondWithHeaders

Methods inherited from class akka.http.javadsl.server.directives.RangeDirectives

withRangeSupport

Methods inherited from class akka.http.javadsl.server.directives.PathDirectives

ignoreTrailingSlash, path, path, path, path, path, path, pathEnd, pathEndOrSingleSlash, pathPrefix, pathPrefix, pathPrefix, pathPrefix, pathPrefix, pathPrefix, pathPrefixTest, pathPrefixTest, pathPrefixTest, pathPrefixTest, pathSingleSlash, pathSuffix, pathSuffix, pathSuffix, pathSuffix, pathSuffixTest, pathSuffixTest, pathSuffixTest, pathSuffixTest, rawPathPrefix, rawPathPrefix, rawPathPrefix, rawPathPrefix, rawPathPrefixTest, rawPathPrefixTest, rawPathPrefixTest, rawPathPrefixTest, redirectToNoTrailingSlashIfPresent, redirectToTrailingSlashIfMissing

Methods inherited from class akka.http.javadsl.server.directives.ParameterDirectives

parameter, parameter, parameterList, parameterList, parameterList, parameterMap, parameterMultiMap, parameterOptional, parameterOptional, parameterOrDefault, parameterRequiredValue

Methods inherited from class akka.http.javadsl.server.directives.MiscDirectives

extractClientIP, rejectEmptyResponse, requestEntityEmpty, requestEntityPresent, selectPreferredLanguage, validate, withoutSizeLimit, withSizeLimit

Methods inherited from class akka.http.javadsl.server.directives.MethodDirectives

delete, extractMethod, get, head, method, options, overrideMethodWithParameter, patch, post, put

Methods inherited from class akka.http.javadsl.server.directives.MarshallingDirectives

completeWith, entity, handleWith, request

Methods inherited from class akka.http.javadsl.server.directives.HostDirectives

extractHost, host, host, host, host

Methods inherited from class akka.http.javadsl.server.directives.AttributeDirectives

attribute, optionalAttribute

Methods inherited from class akka.http.javadsl.server.directives.HeaderDirectives

checkSameOrigin, headerValue, headerValueByName, headerValueByType, headerValuePF, optionalHeaderValue, optionalHeaderValueByName, optionalHeaderValueByType, optionalHeaderValuePF

Methods inherited from class akka.http.javadsl.server.directives.FutureDirectives

completeOrRecoverWith, onComplete, onComplete, onCompleteWithBreaker, onSuccess, onSuccess

Methods inherited from class akka.http.javadsl.server.directives.FormFieldDirectives

formField, formField, formFieldList, formFieldList, formFieldList, formFieldMap, formFieldMultiMap, formFieldOptional, formFieldOptional

Methods inherited from class akka.http.javadsl.server.directives.FileUploadDirectives

fileUpload, fileUploadAll, storeUploadedFile, storeUploadedFiles

Methods inherited from class akka.http.javadsl.server.directives.FileAndResourceDirectives

defaultContentTypeResolver, defaultDirectoryRenderer, getFromBrowseableDirectories, getFromBrowseableDirectories, getFromBrowseableDirectories, getFromBrowseableDirectories, getFromBrowseableDirectories, getFromBrowseableDirectory, getFromBrowseableDirectory, getFromBrowseableDirectory, getFromBrowseableDirectory, getFromDirectory, getFromDirectory, getFromFile, getFromFile, getFromFile, getFromFile, getFromFile, getFromResource, getFromResource, getFromResource, getFromResource, getFromResourceDirectory, getFromResourceDirectory, getFromResourceDirectory, getFromResourceDirectory, listDirectoryContents, listDirectoryContents, listDirectoryContents, listDirectoryContents

Methods inherited from class akka.http.javadsl.server.directives.ExecutionDirectives

handleExceptions, handleRejections

Methods inherited from class akka.http.javadsl.server.directives.DebuggingDirectives

logRequest, logRequest, logRequest, logRequestResult, logRequestResultOptional, logResult, logResult, logResult

Methods inherited from class akka.http.javadsl.server.directives.CookieDirectives

cookie, deleteCookie, deleteCookie, deleteCookie, deleteCookie, deleteCookie, optionalCookie, setCookie, setCookie

Methods inherited from class akka.http.javadsl.server.directives.CodingDirectives

decodeRequest, decodeRequestWith, decodeRequestWith, encodeResponse, encodeResponseWith, requestEncodedWith, responseEncodingAccepted, withPrecompressedMediaTypeSupport

Methods inherited from class akka.http.javadsl.server.directives.CacheConditionDirectives

conditional, conditional, conditional, conditional

Methods inherited from class akka.http.javadsl.server.directives.BasicDirectives

cancelRejection, cancelRejections, cancelRejections, extract, extractActorSystem, extractDataBytes, extractEntity, extractExecutionContext, extractLog, extractMatchedPath, extractMaterializer, extractParserSettings, extractRequest, extractRequestContext, extractRequestEntity, extractSettings, extractStrictEntity, extractStrictEntity, extractUnmatchedPath, extractUri, mapInnerRoute, mapRejections, mapRequest, mapRequestContext, mapResponse, mapResponseEntity, mapResponseHeaders, mapRouteResult, mapRouteResultFuture, mapRouteResultPF, mapRouteResultWith, mapRouteResultWithPF, mapSettings, mapUnmatchedPath, pass, provide, recoverRejections, recoverRejectionsWith, toStrictEntity, toStrictEntity, withExecutionContext, withLog, withMaterializer, withSettings

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeoutDirectives

public TimeoutDirectives()

Method Detail

extractRequestTimeout

public RouteAdapter extractRequestTimeout(java.util.function.Function<scala.concurrent.duration.Duration,Route> inner)

withRequestTimeout

public RouteAdapter withRequestTimeout(scala.concurrent.duration.Duration timeout,
                                       java.util.function.Supplier<Route> inner)

Tries to set a new request timeout and handler (if provided) at the same time.

Due to the inherent raciness it is not guaranteed that the update will be applied before the previously set timeout has expired!

Parameters:

timeout - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

withRequestTimeout

public RouteAdapter withRequestTimeout(scala.concurrent.duration.Duration timeout,
                                       java.util.function.Function<HttpRequest,HttpResponse> timeoutHandler,
                                       java.util.function.Supplier<Route> inner)

Tries to set a new request timeout and handler (if provided) at the same time.

Due to the inherent raciness it is not guaranteed that the update will be applied before the previously set timeout has expired!

Parameters:

timeout - (undocumented)

timeoutHandler - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

withRequestTimeoutResponse

public RouteAdapter withRequestTimeoutResponse(java.util.function.Function<HttpRequest,HttpResponse> timeoutHandler,
                                               java.util.function.Supplier<Route> inner)

Tries to set a new request timeout handler, which produces the timeout response for a given request. Note that the handler must produce the response synchronously and shouldn't block!

Due to the inherent raciness it is not guaranteed that the update will be applied before the previously set timeout has expired!

Parameters:

timeoutHandler - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

withoutRequestTimeout

public RouteAdapter withoutRequestTimeout(java.util.function.Supplier<Route> inner)