org.apache.sshd.client.channel

Enum ClientChannelEvent

java.lang.Object

java.lang.Enum<ClientChannelEvent>

org.apache.sshd.client.channel.ClientChannelEvent

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ClientChannelEvent>

public enum ClientChannelEvent
extends java.lang.Enum<ClientChannelEvent>

Various events used by ClientChannel.waitFor(java.util.Collection, long)

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSED Channel has been marked as closed
EOF Received EOF signal from remote peer
EXIT_SIGNAL Received exit signal from remote peer
EXIT_STATUS Received exit status from remote peer
OPENED Channel has been successfully opened
STDERR_DATA Received STDERR (a.k.a.
STDOUT_DATA Received STDOUT (a.k.a.
TIMEOUT Timeout while waiting for other events - Note: meaningful only as a member of the returned events

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Set<ClientChannelEvent>	VALUES

Method Summary

Modifier and Type	Method and Description
static ClientChannelEvent	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ClientChannelEvent[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TIMEOUT

public static final ClientChannelEvent TIMEOUT

Timeout while waiting for other events - Note: meaningful only as a member of the returned events

CLOSED

public static final ClientChannelEvent CLOSED

Channel has been marked as closed

STDOUT_DATA

public static final ClientChannelEvent STDOUT_DATA

Received STDOUT (a.k.a. channel) data

STDERR_DATA

public static final ClientChannelEvent STDERR_DATA

Received STDERR (a.k.a. extended) data

EOF

public static final ClientChannelEvent EOF

Received EOF signal from remote peer

EXIT_STATUS

public static final ClientChannelEvent EXIT_STATUS

Received exit status from remote peer

See Also:

ClientChannel.getExitStatus()

EXIT_SIGNAL

public static final ClientChannelEvent EXIT_SIGNAL

Received exit signal from remote peer

See Also:

ClientChannel.getExitSignal()

OPENED

public static final ClientChannelEvent OPENED

Channel has been successfully opened

Field Detail

VALUES

public static final java.util.Set<ClientChannelEvent> VALUES

Method Detail

values

public static ClientChannelEvent[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClientChannelEvent c : ClientChannelEvent.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ClientChannelEvent valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null