aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/org/gnunet/requests/RequestIdentifier.java
blob: e080ecf63c9c90b2d43329cdc9a37fb13b14be0e (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
41
42
43
44
45
46
47
/*
 This file is part of GNUnet.
 Copyright (C) 2014 Christian Grothoff (and other contributing authors)

 GNUnet is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published
 by the Free Software Foundation; either version 3, or (at your
 option) any later version.

 GNUnet is distributed in the hope that it will be useful, but
 WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with GNUnet; see the file COPYING.  If not, write to the
 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 Boston, MA 02111-1307, USA.
 */

package org.gnunet.requests;

import org.gnunet.util.Cancelable;
import org.gnunet.util.RelativeTime;

/**
 * Identifies a queued getRequestIdentifier.
 */
public interface RequestIdentifier<T extends Request> extends Cancelable {

    /**
     * Cease being an active getRequestIdentifier.  Effectively removes the
     * getRequestIdentifier from its queue.
     * In contrast to 'cancel', this does not invoke the the cancel
     * action of the underlying request.
     */
    void retire();

    void setTimeout(RelativeTime timeout, TimeoutHandler timeoutHandler);

    T getRequest();

    /**
     * Actively cancel the request.
     */
    void cancel();
}