xapi.shell.api

Interface ShellSession

All Superinterfaces:

xapi.util.api.Destroyable

public interface ShellSession
extends xapi.util.api.Destroyable

Method Summary

Modifier and Type	Method and Description
double	birth()
int	block(int i, TimeUnit seconds)
void	destroy() Destroy the process.
Future<Integer>	exitStatus()
boolean	isRunning()
int	join() Wait for the process to die.
ShellCommand	parent()
int	pid()
ShellSession	stdErr(xapi.io.api.LineReader reader)
boolean	stdIn(String string) Send a string to the stdin of the given command.
ShellSession	stdOut(xapi.io.api.LineReader reader)

Method Detail

parent

ShellCommand parent()

Returns:

- The shell command which spawned us.

pid

int pid()

Returns:

pid -> not yet implemented

destroy

void destroy()

Destroy the process.

Specified by:

destroy in interface xapi.util.api.Destroyable

join

int join()

Wait for the process to die.

isRunning

boolean isRunning()

Returns:

true if the process is not yet dead

birth

double birth()

Returns:

milliseconds since epoch this command was launched

exitStatus

Future<Integer> exitStatus()

Returns:

- A future that will block on the process, then return exit status.

stdOut

ShellSession stdOut(xapi.io.api.LineReader reader)

Returns:

- A future that will block on the process, then return stdIn.

stdErr

ShellSession stdErr(xapi.io.api.LineReader reader)

Returns:

- A future that will block on the process, then return stdOut.

stdIn

boolean stdIn(String string)

Send a string to the stdin of the given command. A string like ^C is handy to forward to running shell ;)

Parameters:

string - - Command to pipe to stdIn; buffered if other commands are pending.

Returns:

true if the command was accepted right away, false if it was buffered.

block

int block(int i,
          TimeUnit seconds)