Mercurial > 510Connectbot
annotate src/ch/ethz/ssh2/util/TimeoutService.java @ 360:7eb24880b111
add help files to the web documentation
| author | Carl Byington <carl@five-ten-sg.com> |
|---|---|
| date | Mon, 04 Aug 2014 08:10:12 -0700 |
| parents | 071eccdff8ea |
| children |
| rev | line source |
|---|---|
|
273
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
1 /* |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
2 * Copyright (c) 2006-2011 Christian Plattner. All rights reserved. |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
3 * Please refer to the LICENSE.txt for licensing details. |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
4 */ |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
5 |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
6 package ch.ethz.ssh2.util; |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
7 |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
8 import java.io.PrintWriter; |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
9 import java.io.StringWriter; |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
10 import java.util.Collections; |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
11 import java.util.Comparator; |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
12 import java.util.LinkedList; |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
13 |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
14 import ch.ethz.ssh2.log.Logger; |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
15 |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
16 /** |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
17 * TimeoutService (beta). Here you can register a timeout. |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
18 * <p> |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
19 * Implemented having large scale programs in mind: if you open many concurrent SSH connections |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
20 * that rely on timeouts, then there will be only one timeout thread. Once all timeouts |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
21 * have expired/are cancelled, the thread will (sooner or later) exit. |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
22 * Only after new timeouts arrive a new thread (singleton) will be instantiated. |
| 307 | 23 * |
|
273
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
24 * @author Christian Plattner |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
25 * @version $Id: TimeoutService.java 89 2014-04-07 14:36:24Z dkocher@sudo.ch $ |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
26 */ |
| 307 | 27 public class TimeoutService { |
| 28 private static final Logger log = Logger.getLogger(TimeoutService.class); | |
|
273
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
29 |
| 307 | 30 public static class TimeoutToken { |
| 31 private long runTime; | |
| 32 private Runnable handler; | |
|
273
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
33 |
| 307 | 34 private TimeoutToken(long runTime, Runnable handler) { |
| 35 this.runTime = runTime; | |
| 36 this.handler = handler; | |
| 37 } | |
| 38 } | |
|
273
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
39 |
| 307 | 40 private static class TimeoutThread extends Thread { |
| 41 @Override | |
| 42 public void run() { | |
| 43 synchronized (todolist) { | |
| 44 while (true) { | |
| 45 if (todolist.size() == 0) { | |
| 46 timeoutThread = null; | |
| 47 return; | |
| 48 } | |
|
273
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
49 |
| 307 | 50 long now = System.currentTimeMillis(); |
| 51 TimeoutToken tt = todolist.getFirst(); | |
|
273
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
52 |
| 307 | 53 if (tt.runTime > now) { |
| 54 /* Not ready yet, sleep a little bit */ | |
| 55 try { | |
| 56 todolist.wait(tt.runTime - now); | |
| 57 } | |
| 58 catch (InterruptedException ignored) { | |
| 59 } | |
|
273
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
60 |
| 307 | 61 /* We cannot simply go on, since it could be that the token |
| 62 * was removed (cancelled) or another one has been inserted in | |
| 63 * the meantime. | |
| 64 */ | |
| 65 continue; | |
| 66 } | |
|
273
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
67 |
| 307 | 68 todolist.removeFirst(); |
|
273
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
69 |
| 307 | 70 try { |
| 71 tt.handler.run(); | |
| 72 } | |
| 73 catch (Exception e) { | |
| 74 StringWriter sw = new StringWriter(); | |
| 75 e.printStackTrace(new PrintWriter(sw)); | |
| 76 log.warning("Exeception in Timeout handler:" + e.getMessage() + "(" + sw.toString() + ")"); | |
| 77 } | |
| 78 } | |
| 79 } | |
| 80 } | |
| 81 } | |
|
273
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
82 |
| 307 | 83 /* The list object is also used for locking purposes */ |
| 84 private static final LinkedList<TimeoutToken> todolist = new LinkedList<TimeoutService.TimeoutToken>(); | |
|
273
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
85 |
| 307 | 86 private static Thread timeoutThread = null; |
|
273
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
87 |
| 307 | 88 /** |
| 89 * It is assumed that the passed handler will not execute for a long time. | |
| 90 * | |
| 91 * @param runTime | |
| 92 * @param handler | |
| 93 * @return a TimeoutToken that can be used to cancel the timeout. | |
| 94 */ | |
| 95 public static TimeoutToken addTimeoutHandler(long runTime, Runnable handler) { | |
| 96 TimeoutToken token = new TimeoutToken(runTime, handler); | |
|
273
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
97 |
| 307 | 98 synchronized (todolist) { |
| 99 todolist.add(token); | |
| 100 Collections.sort(todolist, new Comparator<TimeoutToken>() { | |
| 101 public int compare(TimeoutToken o1, TimeoutToken o2) { | |
| 102 if (o1.runTime > o2.runTime) | |
| 103 return 1; | |
| 104 | |
| 105 if (o1.runTime == o2.runTime) | |
| 106 return 0; | |
| 107 | |
| 108 return -1; | |
| 109 } | |
| 110 }); | |
|
273
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
111 |
| 307 | 112 if (timeoutThread != null) |
| 113 timeoutThread.interrupt(); | |
| 114 else { | |
| 115 timeoutThread = new TimeoutThread(); | |
| 116 timeoutThread.setDaemon(true); | |
| 117 timeoutThread.start(); | |
| 118 } | |
| 119 } | |
|
273
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
120 |
| 307 | 121 return token; |
| 122 } | |
|
273
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
123 |
| 307 | 124 public static void cancelTimeoutHandler(TimeoutToken token) { |
| 125 synchronized (todolist) { | |
| 126 todolist.remove(token); | |
|
273
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
127 |
| 307 | 128 if (timeoutThread != null) |
| 129 timeoutThread.interrupt(); | |
| 130 } | |
| 131 } | |
|
273
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
132 |
|
91a31873c42a
start conversion from trilead to ganymed
Carl Byington <carl@five-ten-sg.com>
parents:
diff
changeset
|
133 } |