ch.ethz.ssh2
Interface ChannelCondition

public interface ChannelCondition

Contains constants that can be used to specify what conditions to wait for on a SSH-2 channel (e.g., represented by a Session).

Version:

$Id: ChannelCondition.java,v 1.6 2006/08/11 12:24:00 cplattne Exp $

Author:

Christian Plattner, plattner@inf.ethz.ch

See Also:

Session.waitForCondition(int, long)

Field Summary

static int	CLOSED The underlying SSH-2 channel, however not necessarily the whole connection, has been closed.
static int	EOF EOF on has been reached, no more _new_ stdout or stderr data will arrive from the remote server.
static int	EXIT_SIGNAL The exit signal of the remote process is available.
static int	EXIT_STATUS The exit status of the remote process is available.
static int	STDERR_DATA There is stderr data available that is ready to be consumed.
static int	STDOUT_DATA There is stdout data available that is ready to be consumed.
static int	TIMEOUT A timeout has occurred, none of your requested conditions is fulfilled.

Field Detail

TIMEOUT

public static final int TIMEOUT

A timeout has occurred, none of your requested conditions is fulfilled. However, other conditions may be true - therefore, NEVER use the "==" operator to test for this (or any other) condition. Always use something like ((cond & ChannelCondition.CLOSED) != 0).

See Also:

Constant Field Values

CLOSED

public static final int CLOSED

The underlying SSH-2 channel, however not necessarily the whole connection, has been closed. This implies EOF. Note that there may still be unread stdout or stderr data in the local window, i.e, STDOUT_DATA or/and STDERR_DATA may be set at the same time.

See Also:

Constant Field Values

STDOUT_DATA

public static final int STDOUT_DATA

There is stdout data available that is ready to be consumed.

See Also:

Constant Field Values

STDERR_DATA

public static final int STDERR_DATA

There is stderr data available that is ready to be consumed.

See Also:

Constant Field Values

EOF

public static final int EOF

EOF on has been reached, no more _new_ stdout or stderr data will arrive from the remote server. However, there may be unread stdout or stderr data, i.e, STDOUT_DATA or/and STDERR_DATA may be set at the same time.

See Also:

Constant Field Values

EXIT_STATUS

public static final int EXIT_STATUS

The exit status of the remote process is available. Some servers never send the exist status, or occasionally "forget" to do so.

See Also:

Constant Field Values

EXIT_SIGNAL

public static final int EXIT_SIGNAL

The exit signal of the remote process is available.

See Also:

Constant Field Values