273
|
1 /*
|
|
2 * Copyright (c) 2006-2011 Christian Plattner. All rights reserved.
|
|
3 * Please refer to the LICENSE.txt for licensing details.
|
|
4 */
|
|
5 package ch.ethz.ssh2;
|
|
6
|
|
7 /**
|
|
8 * Contains constants that can be used to specify what conditions to wait for on
|
|
9 * a SSH-2 channel (e.g., represented by a {@link Session}).
|
|
10 *
|
|
11 * @see Session#waitForCondition(int, long)
|
|
12 *
|
|
13 * @author Christian Plattner
|
|
14 * @version 2.50, 03/15/10
|
|
15 */
|
|
16
|
307
|
17 public abstract interface ChannelCondition {
|
|
18 /**
|
|
19 * A timeout has occurred, none of your requested conditions is fulfilled.
|
|
20 * However, other conditions may be true - therefore, NEVER use the "=="
|
|
21 * operator to test for this (or any other) condition. Always use
|
|
22 * something like <code>((cond & ChannelCondition.CLOSED) != 0)</code>.
|
|
23 */
|
|
24 public static final int TIMEOUT = 1;
|
273
|
25
|
307
|
26 /**
|
|
27 * The underlying SSH-2 channel, however not necessarily the whole connection,
|
|
28 * has been closed. This implies <code>EOF</code>. Note that there may still
|
|
29 * be unread stdout or stderr data in the local window, i.e, <code>STDOUT_DATA</code>
|
|
30 * or/and <code>STDERR_DATA</code> may be set at the same time.
|
|
31 */
|
|
32 public static final int CLOSED = 2;
|
273
|
33
|
307
|
34 /**
|
|
35 * There is stdout data available that is ready to be consumed.
|
|
36 */
|
|
37 public static final int STDOUT_DATA = 4;
|
273
|
38
|
307
|
39 /**
|
|
40 * There is stderr data available that is ready to be consumed.
|
|
41 */
|
|
42 public static final int STDERR_DATA = 8;
|
273
|
43
|
307
|
44 /**
|
|
45 * EOF on has been reached, no more _new_ stdout or stderr data will arrive
|
|
46 * from the remote server. However, there may be unread stdout or stderr
|
|
47 * data, i.e, <code>STDOUT_DATA</code> or/and <code>STDERR_DATA</code>
|
|
48 * may be set at the same time.
|
|
49 */
|
|
50 public static final int EOF = 16;
|
273
|
51
|
307
|
52 /**
|
|
53 * The exit status of the remote process is available.
|
|
54 * Some servers never send the exist status, or occasionally "forget" to do so.
|
|
55 */
|
|
56 public static final int EXIT_STATUS = 32;
|
273
|
57
|
307
|
58 /**
|
|
59 * The exit signal of the remote process is available.
|
|
60 */
|
|
61 public static final int EXIT_SIGNAL = 64;
|
273
|
62
|
|
63 }
|