Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD DETAIL: FIELD | PROPERTY | CONSTR | METHOD

org.hidetake.gradle.ssh.internal.session
[Groovy] Class ChannelManager

java.lang.Object
  org.hidetake.gradle.ssh.internal.session.ChannelManager

@Slf4j
class ChannelManager

Channel lifecycle manager.

A command context has state of following:

  1. pending: command is running (not closed)
  2. closed: command has been finished (closed and exit status is not -1)
  3. disconnected: Channel#disconnect()#disconnect() has been called (closed and exit status is -1)
Authors:
hidetake.org

Property Summary
java.lang.Object channels

 
Method Summary
void add(Channel channel)

Add a channel to be managed.
void disconnect()

Disconnect all channels.
void validateExitStatus()

Validates exit status of channels.

void waitForPending(groovy.lang.Closure closedCommandHandler = { Channel c -> })

Wait for pending channels.
 
Methods inherited from class java.lang.Object
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Property Detail

channels

final java.lang.Object channels

 
Method Detail

add

void add(Channel channel)
Add a channel to be managed.
Parameters:
channel

disconnect

void disconnect()
Disconnect all channels.

validateExitStatus

void validateExitStatus()
Validates exit status of channels. This method must be called before any channel is disconnected.

waitForPending

void waitForPending(groovy.lang.Closure closedCommandHandler = { Channel c -> })
Wait for pending channels.
Parameters:
closedCommandHandler - callback handler for closed command

 

Groovy Documentation