aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/org/gnunet/util/MessageTransmitter.java
blob: eea014fe118e94318eb8f66036c0b93137d79c8a (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
/*
 This file is part of GNUnet.
 Copyright (C) 2011, 2012 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., 51 Franklin Street, Fifth Floor,
 Boston, MA 02110-1301, USA.
 */

package org.gnunet.util;


/**
 * Callback object for transmitting messages.
 */
public interface MessageTransmitter {
    /**
     * Called when the client is ready to transmit messages, or on timeout/error.
     *
     * @param sink A message sink that receives messages to be transmitted by the client,
     *             or null on timeout/error.
     */
    public void transmit(Connection.MessageSink sink);


    /**
     * Called when the transmit getRequestIdentifier could not be fullfilled.
     *
     * After transmit has been called, handleError will not be called anymore (until the next transmit getRequestIdentifier)
     */
    void handleError();
}