blob: 491757d9c960b0826fc0e0f77c9f10722285b524 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.jdisc;
import com.yahoo.jdisc.handler.RequestHandler;
import java.util.concurrent.TimeUnit;
/**
* <p>This interface provides a callback for when the {@link Request#setTimeout(long, TimeUnit)} is invoked. If no such
* handler is registered at the time where the target {@link RequestHandler} is called, the default timeout manager will
* be injected.</p>
*
* @author Simon Thoresen Hult
*/
public interface TimeoutManager {
/**
* Schedule timeout management for a request.
* This is called by a request whenever {@link Request#setTimeout(long, TimeUnit)} is invoked;
* this may be called multiple times for the same {@link Request}.
*
* @param request the request whose timeout to schedule
*/
public void scheduleTimeout(Request request);
/**
* Unschedule timeout management for a previously scheduled request.
* This is called whenever a request is cancelled, and the purpose is to free up
* resources taken by the implementation of this associated with the request.
* <p>
* This is only called once for a request, and only after at least one scheduleTimeout call.
* <p>
* The default implementation of this does nothing.
*
* @param request the previously scheduled timeout
*/
default public void unscheduleTimeout(Request request) {
}
}
|
