1 package net.pterodactylus.fcp.quelaton;
3 import java.io.IOException;
4 import java.util.Queue;
5 import java.util.concurrent.ConcurrentLinkedQueue;
6 import java.util.concurrent.ExecutorService;
7 import java.util.function.Consumer;
9 import net.pterodactylus.fcp.AllData;
10 import net.pterodactylus.fcp.CloseConnectionDuplicateClientName;
11 import net.pterodactylus.fcp.ConfigData;
12 import net.pterodactylus.fcp.DataFound;
13 import net.pterodactylus.fcp.EndListPeerNotes;
14 import net.pterodactylus.fcp.EndListPeers;
15 import net.pterodactylus.fcp.EndListPersistentRequests;
16 import net.pterodactylus.fcp.FCPPluginReply;
17 import net.pterodactylus.fcp.FcpConnection;
18 import net.pterodactylus.fcp.FcpListener;
19 import net.pterodactylus.fcp.FcpMessage;
20 import net.pterodactylus.fcp.FinishedCompression;
21 import net.pterodactylus.fcp.GetFailed;
22 import net.pterodactylus.fcp.IdentifierCollision;
23 import net.pterodactylus.fcp.NodeData;
24 import net.pterodactylus.fcp.NodeHello;
25 import net.pterodactylus.fcp.Peer;
26 import net.pterodactylus.fcp.PeerNote;
27 import net.pterodactylus.fcp.PeerRemoved;
28 import net.pterodactylus.fcp.PersistentGet;
29 import net.pterodactylus.fcp.PersistentPut;
30 import net.pterodactylus.fcp.PersistentPutDir;
31 import net.pterodactylus.fcp.PersistentRequestModified;
32 import net.pterodactylus.fcp.PersistentRequestRemoved;
33 import net.pterodactylus.fcp.PluginInfo;
34 import net.pterodactylus.fcp.ProtocolError;
35 import net.pterodactylus.fcp.PutFailed;
36 import net.pterodactylus.fcp.PutFetchable;
37 import net.pterodactylus.fcp.PutSuccessful;
38 import net.pterodactylus.fcp.ReceivedBookmarkFeed;
39 import net.pterodactylus.fcp.SSKKeypair;
40 import net.pterodactylus.fcp.SentFeed;
41 import net.pterodactylus.fcp.SimpleProgress;
42 import net.pterodactylus.fcp.StartedCompression;
43 import net.pterodactylus.fcp.SubscribedUSKUpdate;
44 import net.pterodactylus.fcp.TestDDAComplete;
45 import net.pterodactylus.fcp.TestDDAReply;
46 import net.pterodactylus.fcp.URIGenerated;
47 import net.pterodactylus.fcp.UnknownNodeIdentifier;
48 import net.pterodactylus.fcp.UnknownPeerNoteType;
50 import com.google.common.util.concurrent.ListenableFuture;
51 import com.google.common.util.concurrent.ListeningExecutorService;
52 import com.google.common.util.concurrent.MoreExecutors;
55 * An FCP reply sequence enables you to conveniently wait for a specific set of FCP replies.
57 * @author <a href="bombe@freenetproject.org">David ‘Bombe’ Roden</a>
59 public abstract class FcpReplySequence<R> implements AutoCloseable, FcpListener {
61 private final Object syncObject = new Object();
62 private final ListeningExecutorService executorService;
63 private final FcpConnection fcpConnection;
64 private final Queue<FcpMessage> messages = new ConcurrentLinkedQueue<>();
66 public FcpReplySequence(ExecutorService executorService, FcpConnection fcpConnection) {
67 this.executorService = MoreExecutors.listeningDecorator(executorService);
68 this.fcpConnection = fcpConnection;
71 protected abstract boolean isFinished();
73 public ListenableFuture<R> send(FcpMessage fcpMessage) throws IOException {
74 fcpConnection.addFcpListener(this);
75 messages.add(fcpMessage);
76 return executorService.submit(() -> {
77 synchronized (syncObject) {
78 while (!isFinished() || !messages.isEmpty()) {
79 while (messages.peek() != null) {
80 FcpMessage message = messages.poll();
81 fcpConnection.sendMessage(message);
93 protected void sendMessage(FcpMessage fcpMessage) {
94 messages.add(fcpMessage);
98 private void notifySyncObject() {
99 synchronized (syncObject) {
100 syncObject.notifyAll();
104 protected R getResult() {
109 public void close() {
110 fcpConnection.removeFcpListener(this);
113 private <M> void consume(Consumer<M> consumer, M message) {
114 consumer.accept(message);
118 private void consumeUnknown(FcpMessage fcpMessage) {
119 consumeUnknownMessage(fcpMessage);
123 private void consumeClose(Throwable throwable) {
124 consumeConnectionClosed(throwable);
129 public final void receivedNodeHello(FcpConnection fcpConnection, NodeHello nodeHello) {
130 consume(this::consumeNodeHello, nodeHello);
133 protected void consumeNodeHello(NodeHello nodeHello) { }
136 public final void receivedCloseConnectionDuplicateClientName(FcpConnection fcpConnection,
137 CloseConnectionDuplicateClientName closeConnectionDuplicateClientName) {
138 consume(this::consumeCloseConnectionDuplicateClientName, closeConnectionDuplicateClientName);
141 protected void consumeCloseConnectionDuplicateClientName(CloseConnectionDuplicateClientName closeConnectionDuplicateClientName) { }
144 public final void receivedSSKKeypair(FcpConnection fcpConnection, SSKKeypair sskKeypair) {
145 consume(this::consumeSSKKeypair, sskKeypair);
148 protected void consumeSSKKeypair(SSKKeypair sskKeypair) { }
151 public final void receivedPeer(FcpConnection fcpConnection, Peer peer) {
152 consume(this::consumePeer, peer);
155 protected void consumePeer(Peer peer) { }
158 public final void receivedEndListPeers(FcpConnection fcpConnection, EndListPeers endListPeers) {
159 consume(this::consumeEndListPeers, endListPeers);
162 protected void consumeEndListPeers(EndListPeers endListPeers) { }
165 public final void receivedPeerNote(FcpConnection fcpConnection, PeerNote peerNote) {
166 consume(this::consumePeerNote, peerNote);
169 protected void consumePeerNote(PeerNote peerNote) { }
172 public final void receivedEndListPeerNotes(FcpConnection fcpConnection, EndListPeerNotes endListPeerNotes) {
173 consume(this::consumeEndListPeerNotes, endListPeerNotes);
176 protected void consumeEndListPeerNotes(EndListPeerNotes endListPeerNotes) { }
179 public final void receivedPeerRemoved(FcpConnection fcpConnection, PeerRemoved peerRemoved) {
180 consume(this::consumePeerRemoved, peerRemoved);
183 protected void consumePeerRemoved(PeerRemoved peerRemoved) { }
186 public final void receivedNodeData(FcpConnection fcpConnection, NodeData nodeData) {
187 consume(this::consumeNodeData, nodeData);
190 protected void consumeNodeData(NodeData nodeData) { }
193 public final void receivedTestDDAReply(FcpConnection fcpConnection, TestDDAReply testDDAReply) {
194 consume(this::consumeTestDDAReply, testDDAReply);
197 protected void consumeTestDDAReply(TestDDAReply testDDAReply) { }
200 public final void receivedTestDDAComplete(FcpConnection fcpConnection, TestDDAComplete testDDAComplete) {
201 consume(this::consumeTestDDAComplete, testDDAComplete);
204 protected void consumeTestDDAComplete(TestDDAComplete testDDAComplete) { }
207 public final void receivedPersistentGet(FcpConnection fcpConnection, PersistentGet persistentGet) {
208 consume(this::consumePersistentGet, persistentGet);
211 protected void consumePersistentGet(PersistentGet persistentGet) { }
214 public final void receivedPersistentPut(FcpConnection fcpConnection, PersistentPut persistentPut) {
215 consume(this::consumePersistentPut, persistentPut);
218 protected void consumePersistentPut(PersistentPut persistentPut) { }
221 public final void receivedEndListPersistentRequests(FcpConnection fcpConnection,
222 EndListPersistentRequests endListPersistentRequests) {
223 consume(this::consumeEndListPersistentRequests, endListPersistentRequests);
226 protected void consumeEndListPersistentRequests(EndListPersistentRequests endListPersistentRequests) { }
229 public final void receivedURIGenerated(FcpConnection fcpConnection, URIGenerated uriGenerated) {
230 consume(this::consumeURIGenerated, uriGenerated);
233 protected void consumeURIGenerated(URIGenerated uriGenerated) { }
236 public final void receivedDataFound(FcpConnection fcpConnection, DataFound dataFound) {
237 consume(this::consumeDataFound, dataFound);
240 protected void consumeDataFound(DataFound dataFound) { }
243 public final void receivedAllData(FcpConnection fcpConnection, AllData allData) {
244 consume(this::consumeAllData, allData);
247 protected void consumeAllData(AllData allData) { }
250 public final void receivedSimpleProgress(FcpConnection fcpConnection, SimpleProgress simpleProgress) {
251 consume(this::consumeSimpleProgress, simpleProgress);
254 protected void consumeSimpleProgress(SimpleProgress simpleProgress) { }
257 public final void receivedStartedCompression(FcpConnection fcpConnection, StartedCompression startedCompression) {
258 consume(this::consumeStartedCompression, startedCompression);
261 protected void consumeStartedCompression(StartedCompression startedCompression) { }
264 public final void receivedFinishedCompression(FcpConnection fcpConnection, FinishedCompression finishedCompression) {
265 consume(this::consumeFinishedCompression, finishedCompression);
268 protected void consumeFinishedCompression(FinishedCompression finishedCompression) { }
271 public final void receivedUnknownPeerNoteType(FcpConnection fcpConnection, UnknownPeerNoteType unknownPeerNoteType) {
272 consume(this::consumeUnknownPeerNoteType, unknownPeerNoteType);
275 protected void consumeUnknownPeerNoteType(UnknownPeerNoteType unknownPeerNoteType) { }
278 public final void receivedUnknownNodeIdentifier(FcpConnection fcpConnection,
279 UnknownNodeIdentifier unknownNodeIdentifier) {
280 consume(this::consumeUnknownNodeIdentifier, unknownNodeIdentifier);
283 protected void consumeUnknownNodeIdentifier(UnknownNodeIdentifier unknownNodeIdentifier) { }
286 public final void receivedConfigData(FcpConnection fcpConnection, ConfigData configData) {
287 consume(this::consumeConfigData, configData);
290 protected void consumeConfigData(ConfigData configData) { }
293 public final void receivedGetFailed(FcpConnection fcpConnection, GetFailed getFailed) {
294 consume(this::consumeGetFailed, getFailed);
297 protected void consumeGetFailed(GetFailed getFailed) { }
300 public final void receivedPutFailed(FcpConnection fcpConnection, PutFailed putFailed) {
301 consume(this::consumePutFailed, putFailed);
304 protected void consumePutFailed(PutFailed putFailed) { }
307 public final void receivedIdentifierCollision(FcpConnection fcpConnection, IdentifierCollision identifierCollision) {
308 consume(this::consumeIdentifierCollision, identifierCollision);
311 protected void consumeIdentifierCollision(IdentifierCollision identifierCollision) { }
314 public final void receivedPersistentPutDir(FcpConnection fcpConnection, PersistentPutDir persistentPutDir) {
315 consume(this::consumePersistentPutDir, persistentPutDir);
318 protected void consumePersistentPutDir(PersistentPutDir persistentPutDir) { }
321 public final void receivedPersistentRequestRemoved(FcpConnection fcpConnection,
322 PersistentRequestRemoved persistentRequestRemoved) {
323 consume(this::consumePersistentRequestRemoved, persistentRequestRemoved);
326 protected void consumePersistentRequestRemoved(PersistentRequestRemoved persistentRequestRemoved) { }
329 public final void receivedSubscribedUSKUpdate(FcpConnection fcpConnection, SubscribedUSKUpdate subscribedUSKUpdate) {
330 consume(this::consumeSubscribedUSKUpdate, subscribedUSKUpdate);
333 protected void consumeSubscribedUSKUpdate(SubscribedUSKUpdate subscribedUSKUpdate) { }
336 public final void receivedPluginInfo(FcpConnection fcpConnection, PluginInfo pluginInfo) {
337 consume(this::consumePluginInfo, pluginInfo);
340 protected void consumePluginInfo(PluginInfo pluginInfo) { }
343 public final void receivedFCPPluginReply(FcpConnection fcpConnection, FCPPluginReply fcpPluginReply) {
344 consume(this::consumeFCPPluginReply, fcpPluginReply);
347 protected void consumeFCPPluginReply(FCPPluginReply fcpPluginReply) { }
350 public final void receivedPersistentRequestModified(FcpConnection fcpConnection,
351 PersistentRequestModified persistentRequestModified) {
352 consume(this::consumePersistentRequestModified, persistentRequestModified);
355 protected void consumePersistentRequestModified(PersistentRequestModified persistentRequestModified) { }
358 public final void receivedPutSuccessful(FcpConnection fcpConnection, PutSuccessful putSuccessful) {
359 consume(this::consumePutSuccessful, putSuccessful);
362 protected void consumePutSuccessful(PutSuccessful putSuccessful) { }
365 public final void receivedPutFetchable(FcpConnection fcpConnection, PutFetchable putFetchable) {
366 consume(this::consumePutFetchable, putFetchable);
369 protected void consumePutFetchable(PutFetchable putFetchable) { }
372 public final void receivedSentFeed(FcpConnection source, SentFeed sentFeed) {
373 consume(this::consumeSentFeed, sentFeed);
376 protected void consumeSentFeed(SentFeed sentFeed) { }
379 public final void receivedBookmarkFeed(FcpConnection fcpConnection, ReceivedBookmarkFeed receivedBookmarkFeed) {
380 consume(this::consumeReceivedBookmarkFeed, receivedBookmarkFeed);
383 protected void consumeReceivedBookmarkFeed(ReceivedBookmarkFeed receivedBookmarkFeed) { }
386 public final void receivedProtocolError(FcpConnection fcpConnection, ProtocolError protocolError) {
387 consume(this::consumeProtocolError, protocolError);
390 protected void consumeProtocolError(ProtocolError protocolError) { }
393 public final void receivedMessage(FcpConnection fcpConnection, FcpMessage fcpMessage) {
394 consumeUnknown(fcpMessage);
397 protected void consumeUnknownMessage(FcpMessage fcpMessage) { }
400 public final void connectionClosed(FcpConnection fcpConnection, Throwable throwable) {
401 consumeClose(throwable);
404 protected void consumeConnectionClosed(Throwable throwable) { }