1 package org.metricshub.ipmi.core.transport;
2
3 /*-
4 * ╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲
5 * IPMI Java Client
6 * ჻჻჻჻჻჻
7 * Copyright 2023 Verax Systems, MetricsHub
8 * ჻჻჻჻჻჻
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation, either version 3 of the
12 * License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Lesser Public License for more details.
18 *
19 * You should have received a copy of the GNU General Lesser Public
20 * License along with this program. If not, see
21 * <http://www.gnu.org/licenses/lgpl-3.0.html>.
22 * ╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱
23 */
24
25 import java.io.IOException;
26
27 /**
28 * Low level connection handler.
29 *
30 */
31 public interface Messenger {
32 /**
33 * Sends {@link UdpMessage}.
34 *
35 * @param message
36 * - {@link UdpMessage} to send.
37 * @throws IOException
38 * when sending of the message fails
39 */
40 void send(UdpMessage message) throws IOException;
41
42 /**
43 * Registers listener in the {@link Messenger} so it will be notified via
44 * {@link UdpListener#notifyMessage(UdpMessage)} when new message arrives.
45 *
46 * @param listener
47 * - {@link UdpListener} to register.
48 */
49 void register(UdpListener listener);
50
51 /**
52 * Unregisters listener from {@link Messenger} so it no longer will be
53 * notified.
54 *
55 * @param listener
56 * - {@link UdpListener} to unregister
57 */
58 void unregister(UdpListener listener);
59
60 /**
61 * Closes the connection.
62 */
63 void closeConnection();
64 }