Package io.deephaven.client.impl

Interface ConsoleSession

All Superinterfaces:

AutoCloseable, Closeable

public interface ConsoleSession
extends Closeable

A console session is part of a Session that allows script execution.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this console session.
CompletableFuture<Void>	closeFuture()	Closes this console session.
default Changes	executeCode(String code)	Execute the given code against the script session.
Changes	executeCode(String code, ExecuteCodeOptions options)	Execute the given code against the script session.
default CompletableFuture<Changes>	executeCodeFuture(String code)	Execute the given code against the script session.
CompletableFuture<Changes>	executeCodeFuture(String code, ExecuteCodeOptions options)	Execute the given code against the script session.
default Changes	executeScript(Path path)	Execute the given path path's code against the script session.
Changes	executeScript(Path path, ExecuteCodeOptions options)	Execute the given path path's code against the script session.
default CompletableFuture<Changes>	executeScriptFuture(Path path)	Execute the given path path's code against the script session.
CompletableFuture<Changes>	executeScriptFuture(Path path, ExecuteCodeOptions options)	Execute the given path path's code against the script session.
Ticket	ticket()	The export ticket for this console session.
String	type()	The console script type.

Method Details

type

String type()

The console script type.

Returns:

the type

ticket

Ticket ticket()

The export ticket for this console session.

Returns:

the ticket

executeCode

default Changes executeCode(String code)
                     throws InterruptedException,
ExecutionException,
TimeoutException

Execute the given code against the script session.

Parameters:

code - the code

Returns:

the changes

Throws:

InterruptedException - if the current thread is interrupted

ExecutionException - if the request has an exception

TimeoutException - if the request times out

executeCode

Changes executeCode(String code,
 ExecuteCodeOptions options)
             throws InterruptedException,
ExecutionException,
TimeoutException

Execute the given code against the script session.

Parameters:

code - the code

options - an ExecuteCodeOptions to control behavior

Returns:

the changes

Throws:

InterruptedException - if the current thread is interrupted

ExecutionException - if the request has an exception

TimeoutException - if the request times out

executeScript

default Changes executeScript(Path path)
                       throws IOException,
InterruptedException,
ExecutionException,
TimeoutException

Execute the given path path's code against the script session.

Parameters:

path - the path to the code

Returns:

the changes

Throws:

InterruptedException - if the current thread is interrupted

ExecutionException - if the request has an exception

TimeoutException - if the request times out

IOException

executeScript

Changes executeScript(Path path,
 ExecuteCodeOptions options)
               throws IOException,
InterruptedException,
ExecutionException,
TimeoutException

Execute the given path path's code against the script session.

Parameters:

path - the path to the code

options - an ExecuteCodeOptions to control behavior

Returns:

the changes

Throws:

InterruptedException - if the current thread is interrupted

ExecutionException - if the request has an exception

TimeoutException - if the request times out

IOException

executeCodeFuture

default CompletableFuture<Changes> executeCodeFuture(String code)

Execute the given code against the script session.

Parameters:

code - the code

Returns:

the changes future

executeCodeFuture

CompletableFuture<Changes> executeCodeFuture(String code,
 ExecuteCodeOptions options)

Execute the given code against the script session.

Parameters:

code - the code

options - an ExecuteCodeOptions to control behavior

Returns:

the changes future

executeScriptFuture

default CompletableFuture<Changes> executeScriptFuture(Path path)
                                                throws IOException

Execute the given path path's code against the script session.

Parameters:

path - the path to the code

Returns:

the changes future

Throws:

IOException

executeScriptFuture

CompletableFuture<Changes> executeScriptFuture(Path path,
 ExecuteCodeOptions options)
                                        throws IOException

Execute the given path path's code against the script session.

Parameters:

path - the path to the code

options - an ExecuteCodeOptions to control behavior

Returns:

the changes future

Throws:

IOException

close

void close()

Closes this console session.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

closeFuture

CompletableFuture<Void> closeFuture()

Closes this console session.

Returns:

the future